前言

在平时写接口的时候，需要进行参数的校验，如果参数少的话，使用 if else 还可以，但是参数多的时候，要写一大堆 if else 校验，敲的太累也不优雅。

所以今天将介绍使用注解来进行参数校验，既方便，还优雅。

@valid 和@Validated 区别

@Validation对@Valid进行了二次封装

常用注解

• 除了@Null，@ NotNull，@ NotBlank，@NotEmpty 这四个外，其他所有的注解，传 null 时都会被当作有效处理

• 注解常用参数值：message(校验不通过反馈的信息)

校验场景

post 请求校验

对象属性校验

• 在入参对象的字段上添加校验注解，比如@Min
• 在请求对象前面添加注解@Valid

@Data
public class User {
    @Min(value = 10,message = "年龄必须大于10岁")
    private Integer age;
}

@PostMapping("checkBodyParam")
public String checkBodyParam(@RequestBody @Valid User user){
 return "ok";
}

当 age=2 时，校验不通过，提示年龄必须大于 10 岁

嵌套属性校验

• 在嵌套对象上添加注解 valid

• 在请求对象前面添加注解 valid

@Data
public class UserClass {
    private String className;
    @Valid
    private User user;
}

@PostMapping("checkBodyMultilevelParam")
public String checkBodyMultilevelParam(@RequestBody @Valid UserClass userClass){
 return "ok";
}

当 age=2 时，校验不通过，提示年龄必须大于 10 岁

集合参数校验

• 类上添加@Validated

• 在请求对象前面添加注解@valid，用@validate 没有效果

@RestController
@RequestMapping("/paramTest")
@Validated
public class ParamTestController {
 @PostMapping("checkList")
 public String checkList(@RequestBody @Valid List<User> users) {
  return "ok";
 }
}

但是如果要分组校验呢，只能用 validate，但是 validate 又没有效果，怎么办呢。

方法一:

新建对象，将 list 当做属性

缺点：这样修改的话,请求的参数结构就会改变.

方法二:

• 实现 list

• 在 list 属性上添加 valid 注解

这样 ValidList 与 java.util.List 的对外功能完全一致,无需改变集合结构

@Data
public class ValidList<E> implements List<E> {

    @Valid
    private List<E> list = new LinkedList<>();
    @Override
    public int size() {
        return list.size();
    }
    @Override
    public boolean isEmpty() {
        return list.isEmpty();
    }
    @Override
    public boolean contains(Object o) {
        return list.contains(o);
    }
    @Override
    public Iterator<E> iterator() {
        return list.iterator();
    }
    @Override
    public Object[] toArray() {
        return list.toArray();
    }
    @Override
    public <T> T[] toArray(T[] a) {
        return list.toArray(a);
    }
    @Override
    public boolean add(E e) {
        return list.add(e);
    }
    @Override
    public boolean remove(Object o) {
        return list.remove(o);
    }
    @Override
    public boolean containsAll(Collection<?> c) {
        return list.containsAll(c);
    }
    @Override
    public boolean addAll(Collection<? extends E> c) {
        return list.addAll(c);
    }
    @Override
    public boolean addAll(int index, Collection<? extends E> c) {
        return list.addAll(index, c);
    }
    @Override
    public boolean removeAll(Collection<?> c) {
        return list.removeAll(c);
    }
    @Override
    public boolean retainAll(Collection<?> c) {
        return list.retainAll(c);
    }
    @Override
    public void clear() {
        list.clear();
    }
    @Override
    public E get(int index) {
        return list.get(index);
    }
    @Override
    public E set(int index, E element) {
        return list.set(index, element);
    }
    @Override
    public void add(int index, E element) {
        list.add(index, element);
    }
    @Override
    public E remove(int index) {
        return list.remove(index);
    }
    @Override
    public int indexOf(Object o) {
        return list.indexOf(o);
    }
    @Override
    public int lastIndexOf(Object o) {
        return list.lastIndexOf(o);
    }
    @Override
    public ListIterator<E> listIterator() {
        return list.listIterator();
    }
    @Override
    public ListIterator<E> listIterator(int index) {
        return list.listIterator(index);
    }
    @Override
    public List<E> subList(int fromIndex, int toIndex) {
        return list.subList(fromIndex, toIndex);
    }
}

 @PostMapping("checkValidList")
 public String checkValidList(@RequestBody @Valid ValidList<User> users) {
  return "ok";
 }

get 请求参数校验

• 在类上使用@Validated 注解

• 在参数前面添加参数校验的注解

@RestController
@RequestMapping("/paramTest")
@Validated
public class ParamTestController {
 @GetMapping("checkParam")
 public String checkParam(@RequestParam  @Max(value = 99, message = "不能大于99岁") Integer age) {
  return "ok";
 }

  @GetMapping("checkPath/{id}")
 public String checkPath(@PathVariable  @Pattern(regexp = "^[0-9]*$", message = "id参数值必须是正整数") String id)   {
  return "ok";
 }
}