spring mvc 支持jsr-303 Bean验证框架,默认实现是使用的Hibernate validator。在spring mvc中只需要使用@Validated注解在方法参数上即可对参数对象进行校验。校验结果放在BindingResult中,所以每个被校验的参数后面都需要放一个BindingResult。
因为有时候并不是所有的地方需要的验证都是一样的,例如更新的时候需要id notnull,而插入的时候确需要id为null,所以验证的时候在每个验证条件中都增加了groups属性,用于标识需要哪种校验,而在@validated中可以设置vlue属性,用于和验证条件中的groups配合使用,只有@Validated中的value类型和验证注解中的groups属性一致的时候才进行校验。

303提供的常用的校验注解主要有以下几类 

空类型检查
@Null验证对象必须为空

@NotNull验证对象不能为空

@NotBlank 验证对象不能为空字符串

@NotEmpty 验证对象不能为空,集合类型不能为空

长度检查
@Size(min= ,max=) 验证对象长度,支持字符串和集合

@Length 验证字符串长度

数值检查
@Max 验证数字大小是否小于某个数值

@Min 验证数字大小是否大于某个数值

@Digits 验证数字是否符合某个格式例如:整数3为,小数2位

@Range 验证数值是否在某个范围之内

其他检查
@Email 验证是否位邮件格式,若为null则不做校验
@Pattern 验证是否符合正则表达式规则

1.基本使用

  1. @Controller
  2. @RequestMapping("valid")
  3. @Slf4j
  4. public class ValidateController {
  5. private static final String BASE_PATH = "/valid/";
  6. @RequestMapping("index")
  7. public String index(@Validated() Student student,BindingResult result){
  8. if(result.hasErrors()){
  9. StringBuffer sb = new StringBuffer();
  10. List<FieldError> errorList = result.getFieldErrors();
  11. errorList.stream().forEach(error->{
  12. String message = error.getDefaultMessage();
  13. String field = error.getField();
  14. sb.append(field).append(":").append(message).append(",");
  15. });
  16. log.error(sb.toString());
  17. }
  18. return BASE_PATH + "index";
  19. }
  20. }

2.在bean中使用验证注解

  1. @Data
  2. public class Student {
  3. @Length(max = 32,min = 32,groups = {})
  4. private String id;
  5. @NotNull
  6. @Size(max = 50)
  7. private String name;
  8. @Max(100)
  9. @Min(12)
  10. @NotNull
  11. private Integer age;
  12. @Email
  13. @NotNull
  14. private String email;
  15. @AssertFalse
  16. private Boolean isLeader;
  17. @WorkOverTime
  18. private String workOverTime;
  19. }

这样在前台请求该方法的时候就会进行自动校验。而校验结果会保存在BindingResult中。可以通过hasErrors判断校验是否通过,getFieldErrors可以获取所有的错误。

3.自定义参数校验

有的时候自带的参数校验类型并不能满足我们的需求,这时我们可以自定校验注解。
定义自定义注解类:

  1. @Constraint(validatedBy = {ValidatedWorkOverTime.class})
  2. @Documented
  3. @Target(ElementType.FIELD)
  4. @Retention(RetentionPolicy.RUNTIME)
  5. public @interface WorkOverTime {
  6. String message() default "加班时长不能超过{max}小时";
  7. int max() default 5;
  8. Class<?>[] groups() default {};
  9. Class<? extends Payload>[] payload() default {};
  10. }

在这个类中我们使用Constraint注解声明我们需要使用哪个类来进行具体的验证。
注解类中必须包含1.错误信息。即message方法,2.验证规则分组,即gourps方法,3.验证的有效负荷即payload方法。
我们还必须实现一个类来进行具体的验证。即上面Constraint声明的类。

  1. @Slf4j
  2. public class ValidatedWorkOverTime implements ConstraintValidator<WorkOverTime,Object> {
  3. private Integer max;
  4. private WorkOverTime workOverTime;
  5. @Override
  6. public void initialize(WorkOverTime constraintAnnotation) {
  7. this.max = constraintAnnotation.max();
  8. this.workOverTime = constraintAnnotation;
  9. }
  10. @Override
  11. public boolean isValid(Object integer, ConstraintValidatorContext constraintValidatorContext) {
  12. Integer overWorkTime = Integer.MAX_VALUE;
  13. if(integer instanceof Integer){
  14. overWorkTime = (Integer) integer;
  15. }else{
  16. try {
  17. overWorkTime = Integer.parseInt(integer.toString());
  18. }catch (Exception e){
  19. log.error(e.toString(),e);
  20. if(e instanceof NumberFormatException){
  21. }
  22. }
  23. }
  24. return max>overWorkTime;
  25. }
  26. }
  1. JSR提供的校验注解:
  2. @Null 被注释的元素必须为 null
  3. @NotNull 被注释的元素必须不为 null
  4. @AssertTrue 被注释的元素必须为 true
  5. @AssertFalse 被注释的元素必须为 false
  6. @Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
  7. @Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
  8. @DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
  9. @DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
  10. @Size(max=, min=) 被注释的元素的大小必须在指定的范围内
  11. @Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
  12. @Past 被注释的元素必须是一个过去的日期
  13. @Future 被注释的元素必须是一个将来的日期
  14. @Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
  15. Hibernate Validator提供的校验注解:
  16. @NotBlank(message =) 验证字符串非null,且长度必须大于0
  17. @Email 被注释的元素必须是电子邮箱地址
  18. @Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
  19. @NotEmpty 被注释的字符串的必须非空
  20. @Range(min=,max=,message=) 被注释的元素必须在合适的范围内

spring  MVC的参数校验 - 图1