spring中使用@Validated，什么是JSR 303数据校验，spring boot中怎么使用数据校验

文章目录

- - 一、JSR 303后台数据校验
  - - 1.1 什么是 JSR303？
    - 1.2 为什么使用 JSR 303？
  - 二、Spring Boot 中使用数据校验
  - - 2.1 基本注解校验
    - - 2.1.1 使用步骤
      - 2.1.2 举例
      - @Valid注解
        全局统一异常处理
    - 2.2 分组校验
    - - 2.2.1 使用步骤
      - 2.2.2 举例
      - @Validated注解
        @Validated和@Valid的区别
    - 2.3 自定义校验注解
    - - 2.3.1 使用步骤
      - 2.3.2 举例
    - 2.4 相关注解
    - - 2.4.1 空检查相关注解
      - 2.4.2 长度检查
      - 2.4.3 布尔值检查
      - 2.4.4 日期检查
      - 2.4.5 数值检查
      - 2.4.6 其他

一、JSR 303后台数据校验

1.1 什么是 JSR303？

JSR 是 Java Specification Requests 的缩写，即 Java 规范提案。存在各种各样的 JSR，简单的理解为 JSR 是一种 Java 标准。JSR 303 是其中数据检验的一个标准（Bean Validation 1.0 (JSR 303)）。

1.2 为什么使用 JSR 303？

处理一段业务逻辑，首先要确保数据输入的正确性，所以需要先对数据进行检查，保证数据在语义上的正确性，再根据数据进行下一步的处理。
前端可以通过 js 程序校验数据是否合法，后端同样也需要进行校验。而后端最简单的实现就是直接在业务方法中对数据进行处理，但是不同的业务方法可能会出现同样的校验操作，这样就出现了数据的冗余。
为了解决这个情况，JSR 303 出现了。JSR 303 使用 Bean Validation，即在 Bean 上添加相应的注解，去实现数据校验。这样在执行业务方法前，都会根据注解对数据进行校验，从而减少自定义的校验逻辑，减少代码冗余。

二、Spring Boot 中使用数据校验

2.1 基本注解校验

之前在 Spring MVC 中介绍了数据校验，也例举了常用的注解。但是使注解生效必须要在 springmvc.xml 中配置，假如没有配置文件（比如在 spring boot）中怎么办？----> 下面详细介绍

spring boot 中需要引入依赖：

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

2.1.1 使用步骤

1、在相关的 Bean 上标注需要处理的注解，并指定需要提示的信息（若不指定，会从默认配置文件中读取默认的信息）。

2、在相关的方法上，使用 @Valid 注解（或者 @Validated 指定组名）标记需要被校验的数据，否则会不生效。

注意：检测到数据异常后，系统会向外抛出异常，如果做了统一异常处理，可以根据 postman 测试的结果，找到控制台打印出的相应的异常，并处理。

3、处理异常。

使用 BindingResult 处理；
也可以使用全局统一异常处理（@RestControllerAdvice 与 @ExceptionHandler）

全局统一异常处理后续会讲

2.1.2 举例

1、在相关的 Bean 上标注注解，并写上指定信息。

@Data
public class Emp {
    @NotNull(message = "id 不能为 null")
    private Integer id;

    @NotNull(message = "name 不能为 null")
    private String name;
}

@Valid注解

2、Controller层中使用 @Valid 注解标记需要检测的数据。

@RestController
public class EmpController {
    
    @PostMapping("/emp")
    public String createEmp(@Valid @RequestBody Emp emp) {
       return "ok";
    }
}

3、测试时，假如不传 id、name，会抛出 MethodArgumentNotValidException 异常。使用 BindingResult 可以处理异常信息，但 通常使用统一异常处理。

① 使用 BindingResult：

@RestController
public class EmpController {
    @PostMapping("/emp")
    public Map createEmp(@Valid @RequestBody Emp emp, BindingResult result) {
        if (result.hasErrors()) {
            Map<String, String> map = new HashMap<>();
            // 获取校验结果，遍历获取捕获到的每个校验结果
            result.getFieldErrors().forEach(item -> {
                // 获取校验的信息
                String message = item.getDefaultMessage(); // 也获取message的值
                String field = item.getField(); //获取属性名
                // 存储得到的校验结果
                map.put(field, message);
            });
            return map;
        }
        return "ok";
    }
}

问题：通过上面的步骤，已经可以捕获异常、处理异常，但是每次都是在业务方法中手动处理逻辑，这样的实现，代码肯定会冗余。可以将其抽出，使用 统一异常处理，每次异常发生时，将其捕获。

全局统一异常处理

② 全局统一异常处理：@RestControllerAdvice、@ExceptionHandler

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map handlerValidException(MethodArgumentNotValidException e) {
        BindingResult result = e.getBindingResult();
        Map<String, String> map = new HashMap<>();
        // 获取校验结果，遍历获取捕获到的每个校验结果
        result.getFieldErrors().forEach(item ->{
            // 存储得到的校验结果
            map.put(item.getField(), item.getDefaultMessage());
        });
        return map;
    }
}

Controller 中不需要再用 BindingResult 去处理数据了。

2.2 分组校验

1、为什么使用分组校验？

上面的过程，如果出现多个方法，都需要校验 Bean，且校验规则不同的时候，怎么办呢？分组校验就可以去解决该问题，每个分组指定不同的校验规则，不同的方法执行不同的分组，就可以得到不同的校验结果。

2、JSR 303 的每个注解都默认具备三个属性：

message 用来定义数据校验失败后的提示消息，默认读取配置文件的内容。idea 全局搜索 ValidationMessages.properties，可以看到默认的信息。
groups 用来定义分组，它是一个 class 数组，可以指定多个分组。
payload()

String message() default "{javax.validation.constraints.NotNull.message}";

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

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

2.2.1 使用步骤

1、定义一个空接口，用于指定分组，内部不需要任何实现。

2、指定注解时，通过 groups 指定分组。用于指定在某个分组条件下，才去执行校验规则。

3、在 Controller 中通过 @Validated 注解指定分组，去指定校验。

注：使用分组校验后，Bean 注解上若不指定分组，则不会执行校验规则。

2.2.2 举例

1、如：创建两个分组接口 AddGroup、UpdateGroup。

AddGroup 用于指定添加数据时的校验规则（比如：id、name 均不为 null）。

UpdateGroup 用于指定修改数据时的校验规则（比如：name 不允许为 null）。

2、给 Bean 添加注解，并指定分组信息。

@Data
public class Emp {
  
    @NotNull(message = "id 不能为 null", groups = {AddGroup.class})
    private Integer id;

    @NotNull(message = "name 不能为 null", groups = {AddGroup.class, UpdateGroup.class})
    private String name;
}

@Validated注解

3、通过 @Validated 注解指定分组，去指定校验

@RestController
public class EmpController {
    @PostMapping("/emp")
    public void createEmp(@Validated({AddGroup.class}) @RequestBody Emp emp) {
       
    }

    @PutMapping("/emp")
    public void UpdateEmp(@Validated({UpdateGroup.class}) @RequestBody Emp emp) {
      
    }
}

@Validated和@Valid的区别

@Validated：
- Spring 框架特有的注解，是标准 JSR-303 的一个变种，提供了一个分组功能。
- 作用在类上、方法上、方法参数上，不能作用于成员属性上。
@Valid：
- 标准 JSR-303 规范的标记型注解。
- 作用在方法、构造函数、方法参数、成员属性上。

2.3 自定义校验注解

上面的注解满足不了业务需求时，可以自定义校验注解、然后自定义校验规则。

2.3.1 使用步骤

1、自定义一个校验注解。可以创建一个 ValidationMessages.properties 用于保存默认的 message 信息。

2、自定义一个校验器（即自定义校验规则）：实现 ConstraintValidator 接口，并重写相关方法。

initialize ：初始化，可以获取自定义的属性的值。
isValid ：校验，可以获取到实际的值，然后与自定义的属性值进行比较。

3、将校验注解与校验器关联起来。@Constraint(validatedBy = {校验器类.class})

2.3.2 举例

自定义一个校验规则，判断数据长度是否合法。

1、自定义一个校验注解：（比如这里是@TestValid）

@Target({FIELD})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy={JiaoYan.class})
public @interface TestValid {
    // 提示信息
    String message() default "{本自定义注解的全类名.message}";
   	
    class<?>[] groups() default {};
    
    Class<? extends Payload>[] payload() default {};
    
    /**
     * 返回一个长度
     * @return 默认为 5
     */
    int length() default 5; 
}

在这里插入图片描述

配置文件内容为：

自定义注解的全类名.message=值不能为 Null，且长度不超过 5

2、自定义一个校验器（比如这里是 JiaoYan）

/**
 * 实现 ConstraintValidator 接口，
 * 其中 ConstraintValidator 的泛型，一个需要指定自定义的注解，一个需要指定需要获取的值的类型。
 * 比如：
 *  ConstraintValidator<TestValid, String> 中
 *      TestValid   表示自定义注解
 *      String      表示获取的值的类型
 * 即定义规则，判断一个 String 的值的长度是否满足条件
 */
public class JiaoYan implements ConstraintValidator<TestValid, String> {
    /**
     * 用于保存自定义的（默认）长度
     */
    private int length;
    
    /**
     * 初始化方法，获取默认数据
     * @param test 注解对象
     */
    @Override
    public void initialize(TestValid test) {
        length = test.length();
    }
    
    /**
     * 自定义校验规则，如果 String 为 Null 或者 长度大于 5，则校验失败（返回 false）
     * @param value 需要校验的值
     * @param context
     * @return true 表示校验成功，false 表示校验失败
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value == null ? false : length > value.length();
    }
}

3、使用注解

@Data
public class Emp {
   
    @NotNull(message = "id 不能为 null", groups = {AddGroup.class})
    private Integer id;
    
    // 默认
    @TestValid()
    @NotNull(message = "name 不能为 null", groups = {AddGroup.class, UpdateGroup.class})
    private String name;

    // 自定义
    @TestValid(length = 10, message = "值不能为 Null 且长度不超过 10", groups = {AddGroup.class})
    private String email;
}

2.4 相关注解

2.4.1 空检查相关注解

注解	注解详情
`@Null`	被指定的注解元素必须为 Null
`@NotNull`	任意类型，不能为 Null，但可以为空，比如：空数组[]、空字符串""
`@NotBlank`	针对字符串，不能为 Null，且去除前后空格后的字符串长度要大于 0
`@NotEmpty`	针对字符串、集合、数组，针对字符串时，不能为 Null，且长度要大于 0

2.4.2 长度检查

注解	注解详情
`@Size`	针对字符串、集合、数组，判断长度是否在给定范围内
`@Length`	针对字符串，判断长度是否在给定范围内

2.4.3 布尔值检查

注解	注解详情
`@AssertTrue`	针对布尔值，用来判断布尔值是否为 true
`@AssertFalse`	针对布尔值，用来判断布尔值是否为 false

2.4.4 日期检查

注解	注解详情
`@Past`	针对日期，用来判断当前日期是否为过去的日期
`@Future`	针对日期，用来判断当前日期是否为未来的日期

2.4.5 数值检查

注解	注解详情
`@Max(value)`	针对字符串、数值，用来判断是否小于等于某个指定值
`@Min(value)`	针对字符串、数值，用来判断是否大于等于某个指定值

2.4.6 其他

注解	注解详情
`@Pattern`	验证字符串是否满足正则表达式
`@Email`	验证字符串是否满足邮件格式
`@Url`	验证是否满足 url 格式
`@Digits`	验证数字整数和小数位数，如：`@Digits(integer=6, fraction=2)`