Bean Validation 校验实践

左手的ㄟ右手 2023-06-17 03:56 5阅读 0赞

# 前言 #

在应用程序的业务逻辑中，经常会碰到需要校验参数的情况。  
经常要判断一个 Model 的字段是否为 Null 之类，或者判断长度等。  
那么在代码层面上，就会需要编写很多校验，影响代码的阅读以及维护，而且造成代码的冗余。

应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。

在通常的情况下，应用程序是分层的，不同的层由不同的开发人员来完成。很多时候同样的数据验证逻辑会出现在不同的层，这样就会导致代码冗余和一些管理的问题，比如说语义的一致性等。为了避免这样的情况发生，最好是将验证逻辑与相应的域模型进行绑定。

为了更好的关注核心的业务逻辑，减少参数校验侵入方法内部，因此有了 JRS-303 提案。

> JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向[JCP][](Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。

Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。缺省的元数据是 Java Annotations，通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息，请查看 [http://www.hibernate.org/subprojects/validator.html][http_www.hibernate.org_subprojects_validator.html]

> 下载 JSR 303 – Bean Validation 规范 [http://jcp.org/en/jsr/detail?id=303][http_jcp.org_en_jsr_detail_id_303]  
> 目前最新的为 [Bean Validation 2.0][]，是 JSR 380，实现为 [Hibernate Validator][] \- [6.0.1.Final][]

# Bean Validation 2.0 中的 constraint #

<table> 
 <thead> 
  <tr> 
   <th align="center">Constraint</th> 
   <th>详细信息</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">@Null</td> 
   <td>被注释的元素必须为 null</td> 
  </tr> 
  <tr> 
   <td align="center">@NotNull</td> 
   <td>被注释的元素必须不为 null</td> 
  </tr> 
  <tr> 
   <td align="center">@AssertTrue</td> 
   <td>被注释的元素必须为 true</td> 
  </tr> 
  <tr> 
   <td align="center">@AssertFalse</td> 
   <td>被注释的元素必须为 false</td> 
  </tr> 
  <tr> 
   <td align="center">@Min(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td align="center">@Max(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td align="center">@DecimalMin(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td align="center">@DecimalMax(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td align="center">@Negative</td> 
   <td>被注释的元素必须是一个严格的负数，举例，0 被视为无效值，因为不是负数</td> 
  </tr> 
  <tr> 
   <td align="center">@NegativeOrZero</td> 
   <td>被注释的元素必须是一个严格的负数或者 0</td> 
  </tr> 
  <tr> 
   <td align="center">@Positive</td> 
   <td>被注释的元素必须是一个严格的正数，举例，0 被视为无效值，因为不是正数</td> 
  </tr> 
  <tr> 
   <td align="center">@PositiveOrZero</td> 
   <td>被注释的元素必须是一个严格的正数或者 0</td> 
  </tr> 
  <tr> 
   <td align="center">@Size(max, min)</td> 
   <td>被注释的元素的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td align="center">@Digits (integer, fraction)</td> 
   <td>被注释的元素必须是一个带小数的数，integer 为整数位最大值，fraction 为小数位最大值</td> 
  </tr> 
  <tr> 
   <td align="center">@Past</td> 
   <td>被注释的元素必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td align="center">@PastOrPresent</td> 
   <td>被注释的元素必须是一个过去的日期或者现在日期</td> 
  </tr> 
  <tr> 
   <td align="center">@Future</td> 
   <td>被注释的元素必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td align="center">@FutureOrPresent</td> 
   <td>被注释的元素必须是一个将来的日期或者现在日期</td> 
  </tr> 
  <tr> 
   <td align="center">@Pattern(value)</td> 
   <td>被注释的元素必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td align="center">@NotEmpty</td> 
   <td>被注释的元素必须不为 null 或者不为空，可校验字符、集合、Map</td> 
  </tr> 
  <tr> 
   <td align="center">@NotBlank</td> 
   <td>被注释的元素必须不为空字符串</td> 
  </tr> 
  <tr> 
   <td align="center">@Email</td> 
   <td>被注释的元素必须是电子邮箱地址</td> 
  </tr> 
 </tbody> 
</table>

# Hibernate Validator 附加的 constraint #

<table> 
 <thead> 
  <tr> 
   <th align="center">Constraint</th> 
   <th>详细信息</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">@Length</td> 
   <td>被注释的字符串的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td align="center">@Range</td> 
   <td>被注释的元素必须在合适的范围内</td> 
  </tr> 
 </tbody> 
</table>

# Spring boot 中使用方式 #

## 参数校验 ##

@Slf4j
    @Validated // 使用 spring 的 Validated 注解标注此 Controller 是需要执行校验的，
    @RestController
    @RequestMapping("/demo-1")
    public class Demo1Controller { 
    
        /** * 在参数上做校验，基本类型 * @param name 名称 * * @return */
        @GetMapping("/query-1")
        public HttpStatus query1(@NotBlank(message = "不能为空") String name) { 
            log.info("name is {}", name);
            return HttpStatus.OK;
        }
    
    }

运行结果：  
![format_png][]

## POJO 校验 ##

@Slf4j
    @RestController
    @RequestMapping("/demo-2")
    public class Demo2Controller { 
    
        @PostMapping("/save-1")
        public HttpStatus save1(@Validated Person person) { 
            return HttpStatus.OK;
        }
    
    }
    
    @Data
    public class Person { 
    
        @NotBlank(message = "名字不能为空")
        private String name;
    
        private Integer age;
    
        private String sex;
    }

运行结果：  
![format_png 1][]

## 接口层级校验 ##

@Slf4j
    @RestController
    @RequestMapping("/demo-3")
    public class Demo3Controller { 
    
        @Resource
        private DemoService service;
    
        @PostMapping("/save-1")
        public HttpStatus save1(@RequestBody Person person) { 
            log.info("person is {}", person);
            service.save(person);
    
            return HttpStatus.OK;
        }
    
    }
    
    @Data
    public class Person { 
    
        @NotBlank(message = "名字不能为空")
        private String name;
    
        private Integer age;
    
        private String sex;
    }
    
    @Validated
    public interface DemoService { 
    
        void save(@Valid Person person);
    }

运行结果：  
![format_png 2][]

## 分组校验 ##

@Slf4j
    @RestController
    @RequestMapping("/demo-4")
    public class Demo4Controller { 
    
        @PostMapping("/save-1")
        public HttpStatus save1(@Validated(value = { SaveValidation.class, Default.class}) @RequestBody PersonGroup person) { 
            log.info("person is {}", person);
    
            return HttpStatus.OK;
        }
    
        @PostMapping("/update-1")
        public HttpStatus update1(@Validated(value = { UpdateValidation.class, Default.class}) @RequestBody PersonGroup person) { 
            log.info("person is {}", person);
    
            return HttpStatus.OK;
        }
    
    }
    
    @Data
    public class PersonGroup { 
    
        @NotBlank(groups = { SaveValidation.class}, message = "保存时名字不能为空")
        private String saveName;
    
        @NotBlank(groups = { UpdateValidation.class}, message = "更新时名字不能为空")
        private String updateName;
    
        private Integer age;
    
        private String sex;
    }

运行结果：  
![format_png 3][]

> @Validated 隐含默认校验，即默认分组，如果不分场景下校验，可以使用如下方式配置：  
> 分组时：  
> `@Validated(value = {ContainerSaveValidation.class, Default.class})`  
> 属性上：  
> `@NotBlank(groups = {SaveValidation.class}, message = "保存时名字不能为空") private String saveName;`

参考文章：  
https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html  
[Hibernate Validator 官方文档][Hibernate Validator 1]

[JCP]: https://link.jianshu.com?t=http%3A%2F%2Fbaike.baidu.com%2Fview%2F148425.htm
[http_www.hibernate.org_subprojects_validator.html]: http://www.hibernate.org/subprojects/validator.html
[http_jcp.org_en_jsr_detail_id_303]: http://jcp.org/en/jsr/detail?id=303
[Bean Validation 2.0]: https://beanvalidation.org/2.0/
[Hibernate Validator]: http://hibernate.org/validator/
[6.0.1.Final]: http://hibernate.org/validator/releases/
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yNzY0OTU2LWExMWUxYzVmMGJmMjU2NGEucG5n?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yNzY0OTU2LTFlNjIyMDg5ZjRiZDA3ZjUucG5n?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yNzY0OTU2LWI0Nzc2MjRmYTQ0N2JlM2UucG5n?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy8yNzY0OTU2LWFkNTQ2YTVmNzFjZTFiYzEucG5n?x-oss-process=image/format,png
[Hibernate Validator 1]: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#_validating_constraints