如何使用？
参数校验分为简单校验、嵌套校验、分组校验。
简单校验
简单的校验即是没有嵌套属性，直接在需要的元素上标注约束注解即可。如下：
@Data
public class ArticleDTO {
@NotNull(message = "文章id不能为空")
@Min(value = 1,message = "文章ID不能为负数")
private Integer id;
@NotBlank(message = "文章内容不能为空")
private String content;
@NotBlank(message = "作者Id不能为空")
private String authorId;
@Future(message = "提交时间不能为过去时间")
private Date submitTime;
}
以上约束标记完成之后，要想完成校验，需要在controller层的接口标注@Valid注解以及声明一个BindingResult类型的参数来接收校验的结果。
下面简单的演示下添加文章的接口，如下：
/**
* 添加文章
*/
@PostMapping("/add")
public String add(@Valid @RequestBody ArticleDTO articleDTO, BindingResult bindingResult) throws JsonProcessingException {
//如果有错误提示信息
if (bindingResult.hasErrors()) {
Map<String , String> map = new HashMap<>();
bindingResult.getFieldErrors().forEach( (item) -> {
String message = item.getDefaultMessage();
String field = item.getField();
map.put( field , message );
} );
//返回提示信息
return objectMapper.writeValueAsString(map);
}
return "success";
}
分组校验
举个栗子：上传文章不需要传文章ID，但是修改文章需要上传文章ID，并且用的都是同一个DTO接收参数，此时的约束条件该如何写呢？
此时就需要对这个文章ID进行分组校验，上传文章接口是一个分组，不需要执行@NotNull校验，修改文章的接口是一个分组，需要执行@NotNull的校验。
@Data
public class ArticleDTO {
/**
* 文章ID只在修改的时候需要检验，因此指定groups为修改的分组
*/
@NotNull(message = "文章id不能为空",groups = UpdateArticleDTO.class )
@Min(value = 1,message = "文章ID不能为负数",groups = UpdateArticleDTO.class)
private Integer id;
/**
* 文章内容添加和修改都是必须校验的，groups需要指定两个分组
*/
@NotBlank(message = "文章内容不能为空",groups = {AddArticleDTO.class,UpdateArticleDTO.class})
private String content;
@NotBlank(message = "作者Id不能为空",groups = AddArticleDTO.class)
private String authorId;
/**
* 提交时间是添加和修改都需要校验的，因此指定groups两个
*/
@Future(message = "提交时间不能为过去时间",groups = {AddArticleDTO.class,UpdateArticleDTO.class})
private Date submitTime;
//修改文章的分组
public interface UpdateArticleDTO{}
//添加文章的分组
public interface AddArticleDTO{}
}
/**
* 添加文章
* @Validated：这个注解指定校验的分组信息
*/
@PostMapping("/add")
public String add(@Validated(value = ArticleDTO.AddArticleDTO.class) @RequestBody ArticleDTO articleDTO, BindingResult bindingResult) throws JsonProcessingException {
//如果有错误提示信息
if (bindingResult.hasErrors()) {
Map<String , String> map = new HashMap<>();
bindingResult.getFieldErrors().forEach( (item) -> {
String message = item.getDefaultMessage();
String field = item.getField();
map.put( field , message );
} );
//返回提示信息
return objectMapper.writeValueAsString(map);
}
return "success";
}
嵌套校验
嵌套校验简单的解释就是一个实体中包含另外一个实体，并且这两个或者多个实体都需要校验。
举个栗子：文章可以有一个或者多个分类，作者在提交文章的时候必须指定文章分类，而分类是单独一个实体，有分类ID、名称等等。大致的结构如下：
public class ArticleDTO{
...文章的一些属性.....
//分类的信息
private CategoryDTO categoryDTO;
}
此时文章和分类的属性都需要校验，这种就叫做嵌套校验。
如下文章分类实体类校验：
/**
* 文章分类
*/
@Data
public class CategoryDTO {
@NotNull(message = "分类ID不能为空")
@Min(value = 1,message = "分类ID不能为负数")
private Integer id;
@NotBlank(message = "分类名称不能为空")
private String name;
}
文章的实体类中有个嵌套的文章分类CategoryDTO属性，需要使用@Valid标注才能嵌套校验，如下：
@Data
public class ArticleDTO {
@NotBlank(message = "文章内容不能为空")
private String content;
@NotBlank(message = "作者Id不能为空")
private String authorId;
@Future(message = "提交时间不能为过去时间")
private Date submitTime;
/**
* @Valid这个注解指定CategoryDTO中的属性也需要校验
*/
@Valid
@NotNull(message = "分类不能为空")
private CategoryDTO categoryDTO;
}
Controller层的添加文章的接口同上，需要使用@Valid或者@Validated标注入参，同时需要定义一个BindingResult的参数接收校验结果。
JSR-303针对集合的嵌套校验也是可行的，比如List的嵌套校验，同样需要在属性上标注一个@Valid注解才会生效，如下：
@Data
public class ArticleDTO {
/**
* @Valid这个注解标注在集合上，将会针对集合中每个元素进行校验
*/
@Valid
@Size(min = 1,message = "至少一个分类")
@NotNull(message = "分类不能为空")
private List<CategoryDTO> categoryDTOS;
}
如何接收校验结果？
接收校验的结果的方式很多，不过实际开发中最好选择一个优雅的方式，下面介绍常见的两种方式。
BindingResult 接收
这种方式需要在Controller层的每个接口方法参数中指定，Validator会将校验的信息自动封装到其中。这也是上面例子中一直用的方式。如下：
@PostMapping("/add")
public String add(@Valid @RequestBody ArticleDTO articleDTO, BindingResult bindingResult){}
这种方式的弊端很明显，每个接口方法参数都要声明，同时每个方法都要处理校验信息，显然不现实，舍弃。
全局异常捕捉
参数在校验失败的时候会抛出的MethodArgumentNotValidException或者BindException两种异常，可以在全局的异常处理器中捕捉到这两种异常，将提示信息或者自定义信息返回给客户端。
全局异常捕捉之前有单独写过一篇文章，不理解的可以看满屏的try-catch，你不瘆得慌？。
作者这里就不再详细的贴出其他的异常捕获了，仅仅贴一下参数校验的异常捕获（仅仅举个例子，具体的返回信息需要自己封装），如下：
@RestControllerAdvice
public class ExceptionRsHandler {
@Autowired
private ObjectMapper objectMapper;
/**
* 参数校验异常步骤
*/
@ExceptionHandler(value= {MethodArgumentNotValidException.class , BindException.class})
public String onException(Exception e) throws JsonProcessingException {
BindingResult bindingResult = null;
if (e instanceof MethodArgumentNotValidException) {
bindingResult = ((MethodArgumentNotValidException)e).getBindingResult();
} else if (e instanceof BindException) {
bindingResult = ((BindException)e).getBindingResult();
}
Map<String,String> errorMap = new HashMap<>(16);
bindingResult.getFieldErrors().forEach((fieldError)->
errorMap.put(fieldError.getField(),fieldError.getDefaultMessage())
);
return objectMapper.writeValueAsString(errorMap);
}
}
spring-boot-starter-validation做了什么？
这个启动器的自动配置类是ValidationAutoConfiguration，最重要的代码就是注入了一个Validator（校验器）的实现类，代码如下：
@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
@ConditionalOnMissingBean(Validator.class)
public static LocalValidatorFactoryBean defaultValidator() {
LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory();
factoryBean.setMessageInterpolator(interpolatorFactory.getObject());
return factoryBean;
}
这个有什么用呢？Validator这个接口定义了校验的方法，如下：
<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);
<T> Set<ConstraintViolation<T>> validateProperty(T object,
String propertyName,
Class<?>... groups);
<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType,
String propertyName,
Object value,
Class<?>... groups);
......
如何自定义校验？
虽说在日常的开发中内置的约束注解已经够用了，但是仍然有些时候不能满足需求，需要自定义一些校验约束。
举个栗子：有这样一个例子，传入的数字要在列举的值范围中，否则校验失败。
自定义校验注解
首先需要自定义一个校验注解，如下：
@Documented
@Constraint(validatedBy = { EnumValuesConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@NotNull(message = "不能为空")
public @interface EnumValues {
/**
* 提示消息
*/
String message() default "传入的值不在范围内";
/**
* 分组
* @return
*/
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
/**
* 可以传入的值
* @return
*/
int[] values() default { };
}
根据Bean Validation API 规范的要求有如下三个属性是必须的：
除了以上三个必须要的属性，添加了一个values属性用来接收限制的范围。
该校验注解头上标注的如下一行代码：
@Constraint(validatedBy = { EnumValuesConstraintValidator.class})
这个@Constraint注解指定了通过哪个校验器去校验。
自定义校验器
@Constraint注解指定了校验器为EnumValuesConstraintValidator，因此需要自定义一个。
自定义校验器需要实现ConstraintValidator<A extends Annotation, T>这个接口，第一个泛型是校验注解，第二个是参数类型。代码如下：
/**
* 校验器
*/
public class EnumValuesConstraintValidator implements ConstraintValidator<EnumValues,Integer> {
/**
* 存储枚举的值
*/
private Set<Integer> ints=new HashSet<>();
/**
* 初始化方法
* @param enumValues 校验的注解
*/
@Override
public void initialize(EnumValues enumValues) {
for (int value : enumValues.values()) {
ints.add(value);
}
}
/**
*
* @param value 入参传的值
* @param context
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//判断是否包含这个值
return ints.contains(value);
}
}
演示
校验注解和校验器自定义成功之后即可使用，如下：
@Data
public class AuthorDTO {
@EnumValues(values = {1,2},message = "性别只能传入1或者2")
private Integer gender;
}
总结
数据校验作为客户端和服务端的一道屏障，有着重要的作用，通过这篇文章希望能够对JSR-303数据校验有着全面的认识。