Java如何使用JSR303校验数据与自定义校验注解？

一、自带校验注解实现数据校验

下面是JSR303一些制定的一些注解：

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)

被注释的元素必须符合指定的正则表达式

Hibernate Validator 附加的 constraint

Constraint(约束)

说明

@Email

被注释的元素必须是电子邮箱地址

@Length

被注释的字符串的大小必须在指定的范围内

@NotEmpty

被注释的字符串的必须非空

@Range

被注释的元素必须在合适的范围内

1、web项目导入依赖

<!-- 该依赖默认导入了 hibernate-validator 所以不需要再单独导入 -->
　　<dependency>
　　　　<groupId>org.springframework.boot</groupId>
　　　　<artifactId>spring-boot-starter-web</artifactId>
　　</dependency 

下图可以看到spring-boot-starter-web依赖自动引入了hibernate-validator；
如果感兴趣的话还可以进入hibernate-validator查看引入了什么相关依赖

2、默认注解的使用

在需要校验的字段添加不同校验类型的注解

	/**
     * 品牌id
     */
    @NotNull(message = "必须提交品牌id")
    @TableId
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank(message = "品牌名不可为空")
    private String name;
    /**
     * 品牌logo地址
     */
    @NotBlank(message = "logo必须提交")
    @URL(message = "logo地址格式错误")
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */private Integer showStatus;
    /**
     * 检索首字母 - 正则校验实现
     */
    @NotNull(message = "首字母必须提交")
    @Pattern(message = "首字母必须是一个字母，且a-z或A-Z", regexp = "/^[a-zA-Z]$/")
    private String firstLetter;

下图是自带的所有校验注解，可以进入查看源码的注释查看如何使用

3、设置谁需要进行数据校验！！！

在接口参数需要校验的对象前标注注解**@Valid** - 标明前台提交数据时该对象的字段需要进行数据校验

    /**
     * 修改
     */
    @RequestMapping("/update")
    public R update(@Valid @RequestBody AttrGroupEntity attrGroup){
        attrGroupService.updateById(attrGroup);

        return R.ok();
    }

二、如何使用分组校验？

由于不同功能的接口接收的对象数据可能需要校验的字段不同，并不是每一个接口接收的对象的所有字段都需要校验的，所以则需要使用"分组校验"来区分不同的业务需要校验不同的字段，在这里我使用新增业务和修改业务为例。

根据上图可以看到，默认的注解源码不仅可以设置message（消息）还有一个可以设置group（分组）

1、创建分组接口

/**
 * 新增业务分组校验 - 不需要实现任何业务，只是用来标识身份
 */
public interface AddGroup {
}

/**
 * 修改业务分组校验 - 不需要实现任何业务，只是用来标识身份
 */
public interface UpdateGroup {
}

2、如何使用分组校验？

2.1、修改Bean每个字段上校验注解，设置group值

	/**
	 * 品牌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(message = "logo必须提交", groups = {AddGroup.class})
	@URL(message = "logo地址格式错误", groups = {AddGroup.class, UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotNull(message = "首字母必须提交", groups = {AddGroup.class})
	@Pattern(message = "首字母必须是一个字母，且a-z或A-Z", regexp = "/^[a-zA-Z]$/", groups = {AddGroup.class, UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@Min(value = 0, groups = {AddGroup.class, UpdateGroup.class})
	private Integer sort;

2.2、设置什么业务需要使用什么分组进行校验

	/**
     * 保存 - 使用添加分组校验接口参数对象的字段
     */
    @RequestMapping("/save")
    public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);

        return R.ok();
    }

 	/**
     * 修改 - 使用修改分组校验接口参数对象的字段
     */
    @RequestMapping("/update")
    public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){
		brandService.updateById(brand);

        return R.ok();
    }

此时，不同业务就会校验不同的字段！！！

三、自定义校验注解

1、导入依赖的jar包

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

2、编写自定义校验注解

/**
 * 自定义校验注解
 * @author mashanghaoyun
 * @date 2020/8/3115:01
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {})
public @interface ListValue {

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

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

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

    int[] vals() default { };

}

3、编写自定义校验器

/**
 * 自定义校验器
 * @author mashanghaoyun
 * @date 2020/8/3115:15
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

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

    /**
     * @Description 初始化方法
     * @Author mashanghaoyun
     * @Date 15:17 2020/8/31
     * @Param [constraintAnnotation]
     * @return void
     **/
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        if (vals.length > 0) {
            for (int val : vals) {
                set.add(val);
            }
        }
    }

    /**
     * @Description 判断是否校验成功
     * @Author mashanghaoyun
     * @Date 15:18 2020/8/31
     * @Param [value（当前提交校验的值）, context]
     * @return boolean
     **/
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        if (set.size() > 0) {
            if (set.contains(value)) {
                return true;
            }
        }
        return false;
    }
}

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

4、使用自定义注解