SpringBoot中如何自定义基于JSR303简单的校验注解

1、环境

• SpringBoot 2.2.2.RELEASE
• 依赖validation-api(这里只是引入该功能的依赖)

 	 <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>

2、编写一个自定义的检验注解

• 编写一个@interface的类，我这里用ValidValue作为示例。
• 下面三个是JSR303中规定必须有的

	// 校验不通过时返回的错误信息
    String message() default "The specified value must be submitted";
	// 在需要多个校验规则的时候可以指定是哪个组的校验规则
    Class<?>[] groups() default {};
	//
    Class<? extends Payload>[] payload() default {};

• 设定规则int[] vals() default {};，就是你想要用来校验的规则。这里表示你输入的数字必须满足在该数组中。
• 完整例子如下（如果你不知道类上面的注解用那些，你可以随便点进去一个检验注解复制过去）
• 在这里面的ValidValueConstraintValidator校验器（下面说），是需要和你的校验注解绑定的

/**
 * @Author: llzhyaa 
 * @Date: 2020/4/10 21:05
 * validatedBy = {} 可以指定多个校验器
 */
@Documented
@Constraint(
        validatedBy = {ValidValueConstraintValidator.class}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidValue{
    // 这三个是必须有的
    String message() default "The specified value must be submitted";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    int[] vals() default  {};
}

3、编写一个自定义的检验器

• 需要定义一个校验器
• A extends Annotation 指定注解 (就是你上面自定义注解的名字)
• T 指定类型 ，就是你需要校验的变量的类型

/**
 * @Author: llzhyaa 
 * @Date: 2020/4/10 21:15
 * 校验器
 * ConstraintValidator<A extends Annotation, T>
 *     A extends Annotation 指定注解 (就是你上面自定义注解的名字)
 *     T 指定类型 
 */
public class ValidValueConstraintValidator implements ConstraintValidator<ValidValue,Integer> {

    private Set<Integer> set = new HashSet<>();

    @Override
    public void initialize(ValidValue constraintAnnotation) {
        // 初始化 , 获取到在你注解上的数字，存入一个set中
        int[] vals = constraintAnnotation.vals();
        if(vals  != null){
          for (int val : vals) {
            set.add(val);
       		 }
        }	
    }

    // 判断是否校验成功

    /**
     *
     * @param integer 需要校验的值（就是你传入的值）
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
		// 校验，获取到你输入的数字是否包含在你之前的set中
        return set.contains(integer);
    }
}

• 关联自定义的检验器个自定义的校验注解
• 即是在你的自定义校验注解上面的@Constraint 绑定你的自定义校验器

@Constraint(
      validatedBy = {ValidValueConstraintValidator.class}
)

4、在你的controller 上面添加注解

• @Valid表示传入的值需要校验
• BindingResult result，可以获取其中的错误信息

	@ResponseBody
    @RequestMapping("/test")
    public Map<String,String> test(@Valid String showStatus ,BindingResult result){
       if (result.hasErrors()){
            // 获取错误结果
            Map<String,String> map = new HashMap<>();
            result.getFieldErrors().forEach((item)->{
                // FieldError 获取错误提示
                String message = item.getDefaultMessage();
                String field = item.getField();
                map.put(field,message);
            })
        }
        return map ;
    }

4、测试

• 在你需要校验的变量上面加上你的注解即可
• @ValidValue(vals = {0,1})，表示你输入的数字必须是0或者1，如果是其他数字就会报错

	@ValidValue(vals = {0,1})
	private Integer showStatus;

• 只看报错详情，

 	{
   		 // 这里就是你自定义的默认返回错误
        "showStatus": "The specified value must be submitted",
    }

5、如何自定义返回的错误信息

• jar包提供的注解中，他们的错误信息都放在了jar包里面的ValidationMessages.properties中，可以全局搜索ValidationMessages可以看到。
• 例如

javax.validation.constraints.AssertFalse.message     = must be false
javax.validation.constraints.AssertTrue.message      = must be true
javax.validation.constraints.DecimalMax.message      = must be less than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.DecimalMin.message      = must be greater than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.Digits.message          = numeric value out of bounds (<{integer} digits>.<{fraction} digits> expected)
javax.validation.constraints.Email.message           = must be a well-formed email address
javax.validation.constraints.Future.message          = must be a future date
javax.validation.constraints.FutureOrPresent.message = must be a date in the present or in the future
javax.validation.constraints.Max.message             = must be less than or equal to {value}
javax.validation.constraints.Min.message             = must be greater than or equal to {value}
javax.validation.constraints.Negative.message        = must be less than 0
javax.validation.constraints.NegativeOrZero.message  = must be less than or equal to 0
javax.validation.constraints.NotBlank.message        = must not be blank
javax.validation.constraints.NotEmpty.message        = must not be empty
javax.validation.constraints.NotNull.message         = must not be null

• 所以我们自己编写一个ValidationMessages.properties文件，放在resources目录下
• com.study.common.valid.ValidValue.message是你自定义的注解加上.message

com.study.common.valid.ValidValue.message=输入的数字必须不规范

• 然后你的自定义注解上面的默认返回信息需要修改

 String message() default "{com.study.common.valid.ListValue.message}";