自定义校验注解

  1.     日常开发中, 我们经常使用if...esle来校验前台提交过来的参数是否合法, 虽说无可厚非, 但是当校验的数据较多时, 大量的if...else代码块严重影响代码美观. 基于这一现象, java出台了JSR303规范, 用于常见的一些bean的数据校验.

1. 什么是JSR

  1. JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向[JCP](https://link.jianshu.com?t=http%3A%2F%2Fbaike.baidu.com%2Fview%2F148425.htm)(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。

2. 什么是JSR303

  1. JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，JSR 303 用于对 Java Bean 中的字段的值进行验证。 官方参考实现是Hibernate Validator,此实现与 Hibernate ORM 没有任何关系。Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。<br />注:可以使用注解的方式进行验证。

3. 常见注解

空检查

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

Booelan检查

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

长度检查

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

日期检查

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

数值检查

建议使用在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=)

4. 开始使用

引入jar

  1.         <dependency>
  2.             <groupId>javax.validation</groupId>
  3.             <artifactId>validation-api</artifactId>
  4.             <version>2.0.1.Final</version>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>org.hibernate.validator</groupId>
  8.             <artifactId>hibernate-validator</artifactId>
  9.             <version>6.1.7.Final</version>
  10.         </dependency>

4.1 直接使用字段
  1.    @GetMapping("/info")
  2.    public SysResult info(@NotNull(message = "组件id不能为空") Long id){
  3.         SysDesGroupPo coupon = desGroupService.getById(id);
  4.         return SysResult.success(coupon);
  5.     }

4.1 校验对象
  1.     @RequestMapping("/save")
  2.     public R save(@RequestBody @Validated BrandEntity brand) {
  3.         brandService.save(brand);
  4.         return R.ok();
  5.     }
  1. @Data
  2. @TableName("pms_brand")
  3. public class BrandEntity implements Serializable {
  4.     private static final long serialVersionUID = 1L;
  6.     /**
  7.      * 品牌id
  8.      */
  9.     @TableId
  10.     private Long brandId;
  11.     /**
  12.      * 品牌名
  13.      */
  14.     @NotNull(message = "品牌名称不能为空")
  15.     private String name;
  16.     /**
  17.      * 品牌logo地址
  18.      */
  19.     @NotNullmessage = "logo地址不能为空")
  20.     @URL(message = "logo地址不合法")
  21.     private String logo;
  22. }

5.分组校验

  1.     @RequestMapping("/update")
  2.     public R update(@RequestBody @Validated(UpdateGroup.class) BrandEntity brand) {
  3.         brandService.updateById(brand);
  4.         return R.ok();
  5.     }
  1. @Data
  2. @TableName("pms_brand")
  3. public class BrandEntity implements Serializable {
  4.     private static final long serialVersionUID = 1L;
  6.     /**
  7.      * 品牌id
  8.      */
  9.     @TableId
  10.     @NotNull(groups = UpdateGroup.class, message = "品牌id不能为空法")
  11.     private Long brandId;
  12.     /**
  13.      * 品牌名
  14.      */
  15.     @NotNull(groups = {AddGroup.class, UpdateGroup.class}, message = "品牌名称不能为空")
  16.     private String name;
  17.     /**
  18.      * 品牌logo地址
  19.      */
  20.     @NotNull(groups = {AddGroup.class, UpdateGroup.class}, message = "logo地址不能为空")
  21.     @URL(groups = {AddGroup.class, UpdateGroup.class}, message = "logo地址不合法")
  22.     private String logo;
  23. }

5. 自定义注解

5.1 定义注解
  1. /**
  2.  * @author renyh37626
  3.  */
  4. @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
  5. @Retention(RUNTIME)
  6. @Documented
  7. @Constraint(validatedBy = {ListValConstraintValidator.class})
  8. public @interface ListVal {
  9.     String message() default "{com.ryh.common.validate.anno.ListVal.message}";
  11.     int[] value();
  13.     Class<?>[] groups() default {};
  15.     Class<? extends Payload>[] payload() default {};
  16. }

5.2定义校验器
  1. /**
  2.  * @author RYH
  3.  * @description 猎取值校验器
  4.  * @date 2021/6/23
  5.  **/
  6. public class ListValConstraintValidator implements ConstraintValidator<ListVal, Integer> {
  8.     private Set<Integer> set = new HashSet<>();
  10.     @Override
  11.     public void initialize(ListVal constraintAnnotation) {
  12.         int[] value = constraintAnnotation.value();
  13.         for (int i : value) {
  14.             set.add(i);
  15.         }
  16.     }
  18.     @Override
  19.     public boolean isValid(Integer value, ConstraintValidatorContext context) {
  20.         return set.contains(value);
  21.     }
  22. }

5.3创建配置文件ValidationMessages.properties 写入配置
  1. com.ryh.common.validate.anno.ListVal.message = please submit given values

5.4 加上注解
  1. @Data
  2. @TableName("pms_brand")
  3. public class BrandEntity implements Serializable {
  4.     private static final long serialVersionUID = 1L;
  6.     /**
  7.      * 品牌id
  8.      */
  9.     @TableId
  10.     @NotNull(groups = UpdateGroup.class, message = "品牌id不能为空法")
  11.     private Long brandId;
  12.     /**
  13.      * 显示状态[0-不显示；1-显示]
  14.      */
  15.     @ListVal(value = {0, 1}, groups = { UpdateStatusGroup.class, UpdateGroup.class})
  16.     private Integer showStatus;
  17. }
  1. @RequestMapping("/update/status")
  2. public R updateStatus(@RequestBody @Validated(UpdateStatusGroup.class) BrandEntity brand) {
  3.      brandService.updateById(brand);
  4.      return R.ok();
  5. }