SprinBoot使用JSR303的自定义校验

SprinBoot使用JSR303的自定义校验

1、什么是JSR303

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

2、如何在springboot使用JSR303自定义校验

1、导入相关依赖

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    <version>2.3.4.RELEASE</version>
</dependency>

2、编写一个自定义注解

​ 首先创建一个自定义注解ListValue（该例子完成自定义注解实现校验提交的值必须是指定的值）

​ 内容我们可以模仿自带的@NotNull注解，我们点进该注解可以看到

​ 模仿该注解首先将元注解复制过去（不要@Repeatable）

​ 因为我们的注解的作用的校验只能提交指定的值，所以我们需要定义一个数组

​ 那么String message() default "{javax.validation.constraints.NotNull.message}";这个是什么意思呢

​ idea双击shift搜索ValidationMessages.properties发现org\hibernate\validator\hibernate-validator\6.0.18.Final\hibernate-validator-6.0.18.Final.jar下有一个配置文件我们可以找到该内容

​ 现在我们也在自己的工程项目模仿着写一个配置文件，在resources目录下创建ValidationMessages.properties，并编写如下配置

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

​ 注解编写大致内容如下

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
        validatedBy = {}
)
public @interface ListValue {


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

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

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

    int[]  vals() default { };
}

3、编写一个自定义校验器

​ 同样，我们点进**@Constraint该注解，发现它是一个接口，并且是一个ConstraintValidator**数组

​ 所以现在我们创建一个类ListValueConstraintValidator实现ConstraintValidator接口，并实现相关的方法

​ 接口的第一个泛型为注解，第二个泛型表示要校验什么类型的数据

​ initialize方法的constraintAnnotation参数可以获取到注解vals的值，isValid的value是表单传过来的值，我们创建一个set集合判断注解上的值是否包含表单传过来的值就可以进行校验了

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {
    private Set<Integer> set = new HashSet<>();

    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

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

​ 首先完善自定义编写的注解，在validatedBy = {}添加校验器类

@Constraint(
        validatedBy = {ListValueConstraintValidator.class}
)

​ 现在我们在实体属性上添加我们的自定义校验注解（这里使用的分组校验就不一一概述了）

@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;

​

​ 最后再在controller的方法体里添加@Validated就能实现校验了

@RequestMapping("/update/status")
public R updateStatus(@Validated({UpdateStatusGroup.class}) @RequestBody BrandEntity brand){
    brandService.updateById(brand);
    return R.ok();
}

​