JSR303 - 参数自动校验的使用

今天药忘吃喽~ 2022-12-02 01:23 216阅读 0赞

参考：https://developer.ibm.com/zh/articles/j-lo-jsr303/
    
    1.引入依赖：
    
    Springboot项目依赖
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>
    
    
    spring项目依赖引入：
    
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>6.1.5.Final</version>
    </dependency>
    
    
    
    
    表 1. Bean Validation 中内置的 constraint
    
    Constraint------------详细信息
    @Null  被注释的元素必须为 null
    @NotNull   被注释的元素必须不为 null
    @AssertTrue    被注释的元素必须为 true
    @AssertFalse   被注释的元素必须为 false
    @Min(value)    被注释的元素必须是一个数字，其值必须大于等于指定的最小值
    @Max(value)    被注释的元素必须是一个数字，其值必须小于等于指定的最大值
    @DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
    @DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
    @Size(max, min)    被注释的元素的大小必须在指定的范围内
    @Digits (integer, fraction)    被注释的元素必须是一个数字，其值必须在可接受的范围内
    @Past  被注释的元素必须是一个过去的日期
    @Future    被注释的元素必须是一个将来的日期
    @Pattern(value)    被注释的元素必须符合指定的正则表达式
    
    
    表 2. Hibernate Validator 附加的 constraint
    
    Constraint-----------详细信息
    @Email 被注释的元素必须是电子邮箱地址
    @Length    被注释的字符串的大小必须在指定的范围内
    @NotEmpty  被注释的字符串的必须非空
    @Range 被注释的元素必须在合适的范围内
    
    
    【使用步骤】
    
    1.定义实体类Person，在属性字段上添加相关constraint注解
    public class Person {
    
       @NotNull
       private String username;
    
       @NotNull
       @Length(min=32)
       private String password;
    
       public String getUsername() {
          return username;
       }
       public void setUsername(String username) {
          this.username = username;
       }
       public String getPassword() {
          return password;
       }
       public void setPassword(String password) {
          this.password = password;
       }
       @Override
       public String toString() {
          return "Person [username=" + username + ", password=" + password + "]";
       }
    }
    
    2.在Controller中的方法入参前添加@Valid 注解约束
    
        @RequestMapping("/save")
        @ResponseBody
        public AppResult<String> doSave(@Valid Person person) {
            log.info(person.toString());
            // 保存
            String result = personService.save(person);
            return AppResult.success(result);
        }
    
    【定制化constraint参数验证器】
    
    # 实体类
    public class User {
    
       @NotNull
       private String mobile;
    
       @NotNull
       @Length(min=32)
       private String password;
    
        // get & set
    
    }
    
    1.自定义注解(以手机格式验证其举例，字段：mobile)
    
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @Constraint(validatedBy = { IsMobileValidator.class})
    public @interface IsMobile {
    
        boolean required() default true;
    
        String message() default "手机号码格式错误";
        Class<?>[] groups() default { };
        Class<? extends Payload>[] payload() default { };
    
    }
    
    2.定义验证器：IsMobileValidator
    
    public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
    
        public boolean required = false;
        private static final Pattern mobilePattern = Pattern.compile("1\\d{10}");
    
        @Override
        public void initialize(IsMobile constraintAnnotation) {
            required = constraintAnnotation.required();
        }
    
        @Override
        public boolean isValid(String value, ConstraintValidatorContext context) {
    
            if(required) {
                // 验证手机号码格式
                if(StringUtils.isEmpty(value)) {
                    return false;
                }
    
                Matcher matcher = mobilePattern.matcher(value);
                return matcher.matches();
    
            }else {
                if(StringUtils.isEmpty(value)){
                    return true;
                }
    
                Matcher matcher = mobilePattern.matcher(value);
                return matcher.matches();
            }
    
        }
    }
    
    3.在实体类属性字段上添加自定义验证注解：@IsMobile
    
    public class User {
    
       @NotNull
       @IsMobile
       private String mobile;
    
       @NotNull
       @Length(min=32)
       private String password;
    
        // get & set
    
    }