分组校验

JSR303校验

一、环境准备

这个pom坐标在自定义注解的时候有用

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

二、JSR 303 基本的校验规则

1、空检查

 @Null 验证对象是否为null 
 @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 
 @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. 
 @NotEmpty 检查约束元素是否为NULL或者是EMPTY.

2、Booelan检查

 @AssertTrue 验证 Boolean 对象是否为 true 
 @AssertFalse 验证 Boolean 对象是否为 false

3、长度检查

 @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 
 @Length(min=, max=) Validates that the annotated string is between min and max included.

 

4、日期检查

 @Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 
 @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 
 @Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

5、数值检查

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null

 @Min 验证 Number 和 String 对象是否大等于指定的值 
 @Max 验证 Number 和 String 对象是否小等于指定的值 
 @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 
 @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 
 @Digits 验证 Number 和 String 的构成是否合法 
 @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 
 @Range(min=, max=) 被指定的元素必须在合适的范围内 
 @Range(min=10000,max=50000,message=”range.bean.wage”) 
 @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
 @CreditCardNumber信用卡验证 
 @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
 @ScriptAssert(lang= ,script=, alias=) 
 @URL(protocol=,host=, port=,regexp=, flags=)

三、案例

1、写一个java bean

 @Data
 public class User {
 ​
     @NotNull(message = "更新时必须携带ID",groups = {UpdateGroup.class})
     @Null(message = "插入时不能携带id",groups = {InsertGroup.class})
     private Integer id;
 ​
     @NotEmpty(message = "名字不能为空")
     private String name;
 ​
     @Email(message = "邮箱不能为空")
     private String email;
 ​
 ​
     private String phone;
 }

2、在controller的参数上加上注解@Valid

controller

 @RestController
 @Slf4j
 public class UserController {
 ​
     @PostMapping("/jsr303")
     public R jsr303Test(@Valid @RequestBody User user){
         log.info("参数user:{}",user);
         return R.ok() ;
     }
 ​
 }

3、异常处理类

@Slf4j
 @RestControllerAdvice(basePackages = "com.ybl.test.controller")
 public class MyExceptionControllerAdvice {
 ​
 ​
     /**
      * @ExceptionHandler 是为了告诉RestControllerAdvice能处理哪些异常
      * @param e
      * @return
      */
     @ExceptionHandler(value= MethodArgumentNotValidException.class)
     public R handleVaildException(MethodArgumentNotValidException e){
         log.error("数据校验出现问题{}，异常类型：{}",e.getMessage(),e.getClass());
         //获取数据校验的结果
         BindingResult bindingResult = e.getBindingResult();
 ​
         Map<String,String> errorMap = new HashMap<>();
         /**
          * 获取所有的错误消息
          * key 存错误字段
          * value 存message
          */
         bindingResult.getFieldErrors().forEach((fieldError)->{
             errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
         });
         return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
     }
 ​
     @ExceptionHandler(value = Throwable.class)
     public R handleException(Throwable throwable){
 ​
         log.error("错误：",throwable);
         return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
     }
 }

4、数据返回类

public class R extends HashMap<String, Object> {
     private static final long serialVersionUID = 1L;
 ​
     public R() {
         put("code", 0);
         put("msg", "success");
     }
 ​
     public static R error() {
         return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "未知异常，请联系管理员");
     }
 ​
     public static R error(String msg) {
         return error( HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
     }
 ​
     public static R error(int code, String msg) {
         R r = new R();
         r.put("code", code);
         r.put("msg", msg);
         return r;
     }
 ​
     public static R ok(String msg) {
         R r = new R();
         r.put("msg", msg);
         return r;
     }
 ​
     public static R ok(Map<String, Object> map) {
         R r = new R();
         r.putAll(map);
         return r;
     }
 ​
     public static R ok() {
         return new R();
     }
 ​
     @Override
     public R put(String key, Object value) {
         super.put(key, value);
         return this;
     }
     public  Integer getCode() {
 ​
         return (Integer) this.get("code");
     }
 ​
 }

5、错误信息枚举类

public enum BizCodeEnume {
     UNKNOW_EXCEPTION(10000,"系统未知异常"),
     VAILD_EXCEPTION(10001,"参数格式校验失败");
 ​
     private int code;
     private String msg;
     BizCodeEnume(int code, String msg){
         this.code = code;
         this.msg = msg;
     }
 ​
     public int getCode() {
         return code;
     }
 ​
     public String getMsg() {
         return msg;
     }
 }

6、测试：

正常：

缺少ID：

 

四、分组校验

比如，我们在update和insert的时候校验规则是不同的，insert的时候，id可以不需要，update的时候id就必须带着。

在上面的校验注解中可以填写groups的参数，这个参数就是用来标识那种分组，然后针对不同情况校验。

 

groups是一个数组，可以指定多个分组，而且规定这个分组必须是一个接口，这些接口不需要写接口方法。

1、接口定义

 public interface UpdateGroup {
 }
 public interface InsertGroup {
 }

2、更改校验规则

 @Data
 public class User {
 ​
     @NotNull(message = "更新时必须携带ID",groups = {UpdateGroup.class})
     @Null(message = "插入时不能携带id",groups = {InsertGroup.class})
     private Integer id;
 ​
     @NotEmpty(message = "名字不能为空")
     private String name;
 ​
     @Email(message = "邮箱不能为空")
     private String email;
 ​
 ​
     private String phone;
 }

3、编写controler

这里校验注解使用的是@Validated，它是由Spring提供的，@Valid是由jsr303提供的一种规范，@Validated支持一个添加分组的参数

@Validated:

@Valid:

 

@PostMapping("/insert")
public R jsr303Insert(@Validated(InsertGroup.class) @RequestBody User user){
     log.info("insert=======user:{}",user);
     return R.ok() ;
}
 ​
@PostMapping("/update")
public R jsr303Update(@Validated(UpdateGroup.class) @RequestBody User user){
     log.info("update-------user:{}",user);
     return R.ok() ;
}

4、测试：

测试insert

localhost:8080/insert

不携带id

携带id：

测试update

localhost:8080/update

不携带id：

携带id：

五、自定义校验注解

假如我们需要在上面的类添加一个字段status，用来标识当前用户是否可用，而这个字段只允许使用两个值0和1，0表示不能用，1表示能用，我们在修改这个字段的时候需要校验这个值。我们下面就来讲解怎么自定义校验注解

1、编写一个自定义的校验注解

先来创建这个注解

 public @interface ListValue {
 }

要怎么写呢？我们可以参考jsr303提供的校验注解是怎么写得，以NotNull为例：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
 @Retention(RUNTIME)
 @Repeatable(List.class)
 @Documented
 @Constraint(validatedBy = { })
 public @interface NotNull {
     String message() default "{javax.validation.constraints.NotNull.message}";
 ​
     Class<?>[] groups() default { };
 ​
     Class<? extends Payload>[] payload() default { };
 ​
     /**
      * Defines several {@link NotNull} annotations on the same element.
      *
      * @see javax.validation.constraints.NotNull
      */
     @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
     @Retention(RUNTIME)
     @Documented
     @interface List {
 ​
         NotNull[] value();
     }
 }

可以看到需要有三个属性

message：出现错误，错误信息去哪里取(去ValidationMessages.properties这个配置文件中取错误信息).

groups:定义分组，那些分组能用。

payload：自定义一些负载信息

作为一个注解，他还需要标注一些元信息数据，比如：

@Target用于标识这个注解能写在那些地方(类、方法、构造等)

@Retention用于标识运行时机

@Constraint用于指定那个校验器进行校验

@Repeatable可重复注解

@Documented它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中，是一个标记注解，没有成员。

编写java类：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
 @Retention(RUNTIME)
 @Documented
 @Constraint(validatedBy = { })
 public @interface ListValue {
     
     
     String message() default "{com.ybl.test.valid.ListValue.message}";
 ​
     Class<?>[] groups() default { };
 ​
     Class<? extends Payload>[] payload() default { };
 ​
 ​
     int[] vals() default { };
 }

编写ValidationMessages.properties：

 com.ybl.test.valid.ListValue.message=“必须提交指定的值”

@Constraint中validatedBy可以指定校验器，我们下面就来编写自定义的校验器

2、编写一个自定义的校验器

参考上面，我们先来看一下校验器是怎么做的

 @Documented
 @Target({ ANNOTATION_TYPE })
 @Retention(RUNTIME)
 public @interface Constraint {
     Class<? extends ConstraintValidator<?, ?>>[] validatedBy();
 }

可以看出，他是使用ConstraintValidator来校验的。ConstraintValidator是一个接口：

 public interface ConstraintValidator<A extends Annotation, T> {
 ｝

这个接口有两个泛型，第一个泛型用来指定要校验的注解，第二个泛型指定我们要校验什么类型的数据。

接下来，我们来实现这个接口

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
 ​
     private Set<Integer> set = new HashSet<Integer>();
 ​
     /**
      * 初始化方法，他会将注解的详细信息vals、message拿到
      * @param constraintAnnotation
      */
     @Override
     public void initialize(ListValue constraintAnnotation) {
         int[] vals = constraintAnnotation.vals();
         if(vals != null || vals.length>0){
             for (int val : vals) {
                 set.add( val );
             }
         }
     }
 ​
     /**
      * 判断是否校验成功
      * @param value 需要校验的值，也就是我们前台传过来的值
      * @param context
      * @return
      */
     @Override
     public boolean isValid(Integer value, ConstraintValidatorContext context) {
         
         return set.contains( value );
     }
 }

自定义校验器定义好了，我们就要把校验器和校验注解关联起来。

3、关联自定义的校验器和校验注解

校验器和校验注解关联起来，validateBy是用来指定校验器的，

 @Constraint(validatedBy = { ListValueConstraintValidator.class })

4、测试是否能成功

 @ListValue(vals = {0, 1}, groups = {UpdateGroup.class})
 private Integer status;

编写controller

 @PostMapping("/status")
 public R jsr303Status(@Validated({UpdateGroup.class}) @RequestBody User user){
     log.info("Status-------user:{}",user);
     return R.ok() ;
 }

访问：localhost:8080/status

4.1、测试status为1或者2

4.2、测试其他值

测试结果是我们想要的，自定义校验器编写成功。