Spring Boot 使用 JSR303（@Validated） 实现参数校验

一：简介
1. JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation。

2. 在任何时候，当你要处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。

3. Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。

4. constraint 可以附加到字段，getter 方法，类或者接口上面。

5. 对于一些特定的需求，用户可以很容易的开发定制化的 constraint。

6. Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

二：Bean Validation 规范内嵌的约束注解
限制    说明
@Null    限制只能为null
@NotNull    限制必须不为null
@AssertFalse    限制必须为false
@AssertTrue    限制必须为true
@DecimalMax(value)    限制必须为一个不大于指定值的数字
@DecimalMin(value)    限制必须为一个不小于指定值的数字
@Digits(integer,fraction)    限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future    限制必须是一个将来的日期
@Max(value)    限制必须为一个不大于指定值的数字
@Min(value)    限制必须为一个不小于指定值的数字
@Past    限制必须是一个过去的日期
@Pattern(value)    限制必须符合指定的正则表达式
@Size(max,min)    限制字符长度必须在min到max之间
@Past    验证注解的元素值（日期类型）比当前时间早
@NotEmpty    验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank    验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email    验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式
三：基本应用
1、引入依赖

    org.springframework.boot
    spring-boot-starter-validation

2、给参数对象添加校验注解
private Integer id;
@NotBlank(message = "名称不能为空")
private String name;
private Date data;
@NotNull(message = "年龄不能为空")
private Integer age;
@Pattern(regexp = "[0-9]" ,  message = "参数格式错误")
private String Telephone;
Controller 中需要校验的参数Bean前添加 @Validated开启校验功能，紧跟在校验的Bean后添加一个BindingResult，BindingResult封装了前面Bean的校验结果。

@GetMapping("/into")
public String into(@Validated Emp emp ,BindingResult bindingResult) {
    if(bindingResult.hasErrors()){
        Map map = new HashMap<>();
        bindingResult.getFieldErrors().forEach((item) ->{
            String msg = item.getDefaultMessage();
            String fie = item.getField();
            map.put(fie,msg);
        });
        return map.toString();
    }
    return "200";
}
四：异常的统一处理
参数校验不通过时，会抛出 BingBindException 异常，可以在统一异常处理中，做统一处理，这样就不用在每个需要参数校验的地方都用 BindingResult 获取校验结果了。

/**
 * 自定义验证异常(参数传值)
 */
@ExceptionHandler(BindException.class)
public String validatedBindException(BindException e) {
    String message = e.getAllErrors().get(0).getDefaultMessage();
    return message;
}
​
/**
 * 自定义验证异常(json传值)
 */
@ExceptionHandler(MethodArgumentNotValidException.class)
public String MethodArgumentNotValidException(MethodArgumentNotValidException e) {
    String message = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
    return message;
}
五：分组解决校验
新增和修改对于实体的校验规则是不同的，例如id是自增的时，新增时id要为空，修改则必须不为空；新增和修改，若用的恰好又是同一种实体，那就需要用到分组校验；

校验注解都有一个groups属性，可以将校验注解分组，我们看下@NotNull的源码

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(NotNull.List.class)
@Documented
@Constraint( validatedBy = {} )
public @interface NotNull {
    String message() default "{javax.validation.constraints.NotNull.message}";
    Class[] groups() default {};
    Class[] payload() default {};
    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface List {
        NotNull[] value();
    }
}

从源码可以看出 groups 是一个Class类型的数组，那么就可以创建一个Groups.

public class Groups {
    public interface Add {
    }
    public interface Update {
    }
}
给参数对象的校验注解添加分组

private Integer id;
@NotBlank(message = "名称不能为空" ,groups = Groups.Add.class)
private String name;
private Date data;
@NotNull(message = "年龄不能为空",groups = {Groups.Add.class,Groups.Update.class})
private Integer age;
@Pattern(regexp = "[0-9]" ,  message = "电话格式错误")
private String Telephone;
在Controller 添加分组；多个可用@Validated({Groups.Update.class,Groups.Add.class})

@GetMapping("/into")
public String into(@Validated({Groups.Update.class})  Emp emp ) {
    return "200";
}
六：配置文件配置massage错误信息
在resource 目录下新建提示信息配置文件“ValidationMessages.properties“

注意：名字必须为“ValidationMessages.properties“ 因为SpringBoot自动读取classpath中的ValidationMessages.properties里的错误信息

@NotBlank(message = "{emp.name}" ,groups = Groups.Add.class)
private String name;
emp.name=参数错误
 

七：自定义校验注解
虽然JSR303和springboot-validator 已经提供了很多校验注解，但是当面对复杂参数校验时，还是不能满足我们的要求，这时候我们就需要 自定义校验注解。

例如年龄，用 1代表男 2代表女，我们自定义一个校验注解@ListValue，指定取值只能1和2。

1、创建约束规则
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint( validatedBy = {ListValueConstraintValidator.class} )
public @interface ListValue {
    String message() default "{javax.validation.constraints.ListValue.message}";
​
    Class[] groups() default {};
​
    Class[] payload() default {};
​
    int[] vals() default {};
}
一个标注(annotation) 是通过@interface关键字来定义的. 这个标注中的属性是声明成类似方法的样式的. 根据Bean Validation API 规范的要求：

message属性, 这个属性被用来定义默认得消息模版, 当这个约束条件被验证失败的时候,通过此属性来输出错误信息。

groups 属性, 用于指定这个约束条件属于哪(些)个校验组. 这个的默认值必须是Class类型数组。

payload 属性, Bean Validation API 的使用者可以通过此属性来给约束条件指定严重级别. 这个属性并不被API自身所使用。

除了这三个强制性要求的属性(message, groups 和 payload) 之外, 我们还添加了一个属性用来指定所要求的值. 此属性的名称vals在annotation的定义中比较特殊, 如果只有这个属性被赋值了的话, 那么, 在使用此annotation到时候可以忽略此属性名称.另外, 我们还给这个annotation标注了一些元标注( metaannotatioins)：

@Target({ METHOD, FIELD, ANNOTATION_TYPE }): 表示此注解可以被用在方法, 字段或者annotation声明上。

@Retention(RUNTIME): 表示这个标注信息是在运行期通过反射被读取的.

@Constraint(validatedBy = ListValueConstraintValidator.class): 指明使用哪个校验器(类) 去校验使用了此标注的元素.

@Documented: 表示在对使用了该注解的类进行javadoc操作到时候, 这个标注会被添加到javadoc当中.

2、创建约束校验器
public class ListValueConstraintValidator implements ConstraintValidator {
    private Set set = new HashSet<>();
​
    /**
     * 初始化方法
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }
​
    /**
     * 判断是发否校验成功
     * integer:需要校验的值
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(integer);
    }
}

ListValueConstraintValidator定义了两个泛型参数, 第一个是这个校验器所服务到标注类型(在我们的例子中即ListValue), 第二个这个校验器所支持到被校验元素的类型 (即Integer)。

如果一个约束标注支持多种类型的被校验元素的话, 那么需要为每个所支持的类型定义一个ConstraintValidator,并且注册到约束标注中。

这个验证器的实现就很平常了, initialize() 方法传进来一个所要验证的标注类型的实例, 在本例中, 我们通过此实例来获取其vals属性的值,并将其保存为Set集合中供下一步使用。

isValid()是实现真正的校验逻辑的地方, 判断一个给定的int对于@ListValue这个约束条件来说是否是合法的。

在参数对象中使用@ListValue注解。

@ListValue(message = "cs", vals={1,2})
private Integer gender;
谢谢！！！
————————————————
版权声明：本文为CSDN博主「爱码仕1」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/qq_41712834/article/details/106886410

————————————————
版权声明：本文为CSDN博主「爱码仕1」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/qq_41712834/article/details/106886410