ToB企服应用市场:ToB评测及商务社交产业平台

标题: 使用 SpringBoot 进行优雅的数据验证 [打印本页]
作者: 用户国营    时间: 2023-8-10 15:51
标题: 使用 SpringBoot 进行优雅的数据验证
JSR-303 规范

在程序进行数据处理之前，对数据进行准确性校验是我们必须要考虑的事情。尽早发现数据错误，不仅可以防止错误向核心业务逻辑蔓延，而且这种错误非常明显，容易发现解决。
JSR303 规范（Bean Validation 规范）为 JavaBean 验证定义了相应的元数据模型和 API。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode ， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。
关于 JSR 303 – Bean Validation 规范，可以参考官网
对于 JSR 303 规范，Hibernate Validator 对其进行了参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息，请查看官网。
validation-api 内置的 constraint 清单

Constraint详细信息@AssertFalse被注释的元素必须为 false@AssertTrue同 @AssertFalse@DecimalMax被注释的元素必须是一个数字，其值必须小于等于指定的最大值@DecimalMin同@DecimalMax@Digits带批注的元素必须是一个在可接受范围内的数字@Email顾名思义@Future将来的日期@FutureOrPresent现在或将来@Max被注释的元素必须是一个数字，其值必须小于等于指定的最大值@Min被注释的元素必须是一个数字，其值必须大于等于指定的最小值@Negative带注释的元素必须是一个严格的负数（0 为无效值）@NegativeOrZero带注释的元素必须是一个严格的负数（包含 0）@NotBlank同 StringUtils.isNotBlank@NotEmpty同 StringUtils.isNotEmpty@NotNull不能是 Null@Null元素是 Null@Past被注释的元素必须是一个过去的日期@PastOrPresent过去和现在@Pattern被注释的元素必须符合指定的正则表达式@Positive被注释的元素必须严格的正数（0 为无效值）@PositiveOrZero被注释的元素必须严格的正数（包含 0）@Szie带注释的元素大小必须介于指定边界（包括）之间Hibernate Validator 附加的 constraint#

Constraint详细信息@Email被注释的元素必须是电子邮箱地址@Length被注释的字符串的大小必须在指定的范围内@NotEmpty被注释的字符串的必须非空@Range被注释的元素必须在合适的范围内@CreditCardNumber被注释的元素必须符合信用卡格式Hibernate Validator 不同版本附加的 Constraint 可能不太一样，具体还需要你自己查看你使用版本。 Hibernate 提供的 Constraint 在 org.hibernate.validator.constraints 这个包下面。
一个 constraint 通常由 annotation 和相应的 constraint validator 组成，它们是一对多的关系。也就是说可以有多个 constraint validator 对应一个 annotation。在运行时，Bean Validation 框架本身会根据被注释元素的类型来选择合适的 constraint validator 对数据进行验证。
有些时候，在用户的应用中需要一些更复杂的 constraint。Bean Validation 提供扩展 constraint 的机制。可以通过两种方法去实现，一种是组合现有的 constraint 来生成一个更复杂的 constraint，另外一种是开发一个全新的 constraint。
使用 Spring Boot 进行数据校验

Spring Validation 对 hibernate validation 进行了二次封装，可以让我们更加方便地使用数据校验功能。这边我们通过 Spring Boot 来引用校验功能。
如果你用的 Spring Boot 版本小于 2.3.x，spring-boot-starter-web 会自动引入 hibernate-validator 的依赖。如果 Spring Boot 版本大于 2.3.x，则需要手动引入依赖：
  1. <dependency>
  2.     <groupId>org.hibernate</groupId>
  3.     <artifactId>hibernate-validator</artifactId>
  4.     <version>6.0.1.Final</version>
  5. </dependency>
复制代码
直接参数校验

有时候接口的参数比较少，只有一个活着两个参数，这时候就没必要定义一个 DTO 来接收参数，可以直接接收参数。
  1. @Validated
  2. @RestController
  3. @RequestMapping("/user")
  4. public class UserController {
  6.     private static Logger logger = LoggerFactory.getLogger(UserController.class);
  8.     @GetMapping("/getUser")
  9.     @ResponseBody
  10.     // 注意：如果想在参数中使用 @NotNull 这种注解校验，就必须在类上添加 @Validated；
  11.     public UserDTO getUser(@NotNull(message = "userId不能为空") Integer userId){
  12.         logger.info("userId:[{}]",userId);
  13.         UserDTO res = new UserDTO();
  14.         res.setUserId(userId);
  15.         res.setName("程序员自由之路");
  16.         res.setAge(8);
  17.         return res;
  18.     }
  19. }
复制代码
下面是统一异常处理类
[code]@RestControllerAdvicepublic class GlobalExceptionHandler {    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);    @ExceptionHandler(value = ConstraintViolationException.class)    public Response handle1(ConstraintViolationException ex){            StringBuilder msg = new StringBuilder();        Set



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4