分组校验和自定义校验

携手创作，共同成长！这是我参与「掘金日新计划 · 8 月更文挑战」的第14天，点击查看活动详情

分组校验功能

一、给校验注解，标注上groups，指定什么情况下才需要进行校验

如：指定在更新和添加的时候，都需要进行校验，我们对id进行限制

    /**
     * 品牌id
     */
    @NotNull(message = "修改必须指定品牌id",groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id",groups = {AddGroup.class})
    @TableId
    private Long brandId;

这里的UpdateGroup和AddGroup都需要收到创建一下，为了演示可以只创建不写内容

二、使用@Validated注解

@Validated(AddGroup.class)指定新增的时候注解才会生效

其他的注解字段，即使标注校检也不生效

/**
 * 保存
 */
@RequestMapping("/save")
public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand){
    brandService.save(brand);
    return R.ok();
}

三、测试

因为指定了新增不能指定id，但是我们测试的时候加id了所以返回错误信息

测试其他字段

可以看到即使name字段加非空了，我们测试用空值也是可以生效的

说明在分组校验情况下，没有指定指定分组的校验注解，将不会生效，它只会在不分组的情况下生效。

自定义校验功能

一、导入依赖

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

二、编写自定义注解

（1）注解的格式不会写怎么办？

直接复制其他注解的形式

（2）特别说明

• @Target的意思是说，这个注解能标注在哪里，后面通过{}进行指定
• String message() default "{com.caq.common.valid.ListValue.message}";这个意思是指，@ListValue注解的错误提示信息会去配置文件中找这个message的值当作信息
• int[] vals() default {};这里的定义是值@ListValue这个注解可以有变量名为vals的int数组做为参数

（3）@Constraint( validatedBy = {})的说明

validatedBy指定这个注解由哪一个校验器校验，详细信息如图：

（4）配置注解错误返回信息

在resource文件下创建：ValidationMessages.properties

com.zsy.common.valid.ListValue.message=必须提交指定的值

（5）自定义的校验器

详细信息还是注意代码中的注释

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {
    private final Set<Integer> set = new HashSet<>();
​
    /**
     * 初始化方法
     * 参数：自定义注解的详细信息
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {
        //constraintAnnotation.vals()意思是获得你注解里的参数
        int[] values = constraintAnnotation.vals();
        //把获取到的参数放到set集合里
        for (int v al : values) {
            set.add(val);
        }
    }
​
    /**
     * 判断是否校验成功
     * @param value   需要校验的值
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        //这里的Integer value参数是指你注解里提交过来的参数
        //之后判断集合里是否有这个传进来的值，如果有返回true，没的话返回false并返回错误信息
        return set.contains(value);
    }
}

（6）关联自定义校验器

通过validatedBy = {ListValueConstraintValidator.class}去指定即可！

那如果以后@ListValue注解支持的属性类型变为double了，我们只需要在指定新的校验器即可

/**
 * 自定义校验注解 声明可以取那些值
 */
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.caq.common.validation.ListValue.message}";
​
    Class<?>[] groups() default {};
​
    Class<? extends Payload>[] payload() default {};
​
    int[] vals() default {};
}
​

三、测试

我们给状态字段指定分组检验，让它增加的时候才进行校验

    /**
     * 显示状态[0-不显示；1-显示]
     */
    @ListValue(vals = {0, 1}, groups = {AddGroup.class})
    private Integer showStatus;

（1）读取properties文件内容乱码

设置好，清理target，重新编译

再次测试

完善代码

（1）做检验的字段

/**
 * 品牌
 * @author xiaocai
 * @email mildcaq@gmail.com
 * @date 2022-07-27 21:05:30
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;
​
    /**
     * 品牌id
     */
    @NotNull(message = "修改必须指定品牌id", groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id", groups = {AddGroup.class})
    @TableId
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank(message = "品牌名必须提交", groups = {AddGroup.class, UpdateGroup.class})
    private String name;
    /**
     * 品牌logo地址
     */
    @NotBlank(groups = {AddGroup.class})
    @URL(message = "logo必须是一个合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */
// @Pattern()
    @NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
    @ListValue(vals = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
    private Integer showStatus;
    /**
     * 检索首字母
     */
    @NotEmpty(groups = {AddGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
    private String firstLetter;
    /**
     * 排序
     */
    @NotNull(groups = {AddGroup.class})
    @Min(value = 0, message = "排序必须大于等于0", groups = {AddGroup.class, UpdateGroup.class})
    private Integer sort;
}

（2）controller中共三个方法做了数据校验

/**
   * 保存
   */
  @RequestMapping("/save")
  public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand){
      brandService.save(brand);
      return R.ok();
  }
​
  /**
   * 修改
   */
  @RequestMapping("/update")
  public R update(@Validated({UpdateGroup.class})@RequestBody BrandEntity brand){
brandService.updateById(brand);
      return R.ok();
  }
​
  @RequestMapping("/update/status")
  public R updateStatus(@Validated({UpdateStatusGroup.class}) @RequestBody BrandEntity brand){
      brandService.updateById(brand);
      return R.ok();
  }

（三）测试前后端的校验

测试状态修改

测试修改

测试新增

\