Spring Boot进行优雅的字段校验,写得太好了!

时间:2022-04-21 21:59:26

Spring Boot进行优雅的字段校验,写得太好了!

前段时间提交代码审核,同事提了一个代码规范缺陷:参数校验应该放在controller层。到底应该如何做参数校验呢?

Controller层 VS Service层

去网上查阅了一些资料,一般推荐与业务无关的放在Controller层中进行校验,而与业务有关的放在Service层中进行校验。

那么如何将参数校验写的优雅美观呢,如果都是if - else,就感觉代码写的很low,还好有*可以使用

常用校验工具类

使用Hibernate Validate

引入依赖

  1. <dependency> 
  2.     <groupId>org.hibernate</groupId> 
  3.     <artifactId>hibernate-validator</artifactId> 
  4.     <version>4.3.1.Final</version>  
  5. </dependency> 

常用注解说明

Spring Boot进行优雅的字段校验,写得太好了!

使用姿势

Spring Boot 基础就不介绍了,推荐下这个实战教程:

https://github.com/javastacks/spring-boot-best-practice

需要搭配在Controller中搭配@Validated或@Valid注解一起使用,@Validated和@Valid注解区别不是很大,一般情况下任选一个即可,区别如下:

Spring Boot进行优雅的字段校验,写得太好了!

虽然@Validated比@Valid更加强大,在@Valid之上提供了分组功能和验证排序功能,不过在实际项目中一直没有用到过

Hibernate-validate框架中的注解是需要加在实体中一起使用的

定义一个实体

  1. public class DataSetSaveVO { 
  2.     //唯一标识符为空 
  3.     @NotBlank(message = "user uuid is empty"
  4.     //用户名称只能是字母和数字 
  5.     @Pattern(regexp = "^[a-z0-9]+$", message = "user names can only be alphabetic and numeric"
  6.     @Length(max = 48, message = "user uuid length over 48 byte"
  7.     private String userUuid; 
  8.  
  9.     //数据集名称只能是字母和数字 
  10.     @Pattern(regexp = "^[A-Za-z0-9]+$", message = "data set names can only be letters and Numbers"
  11.     //文件名称过长 
  12.     @Length(max = 48, message = "file name too long"
  13.     //文件名称为空 
  14.     @NotBlank(message = "file name is empty"
  15.     private String name
  16.  
  17.     //数据集描述最多为256字节 
  18.     @Length(max = 256, message = "data set description length over 256 byte"
  19.     //数据集描述为空 
  20.     @NotBlank(message = "data set description is null"
  21.     private String description; 

说明:message字段为不符合校验规则时抛出的异常信息

Controller层中的方法

  1. @PostMapping 
  2. public ResponseVO createDataSet(@Valid @RequestBody DataSetSaveVO dataSetVO) { 
  3.     return ResponseUtil.success(dataSetService.saveDataSet(dataSetVO)); 

说明:在校验的实体DataSetSaveVO旁边添加@Valid或@Validated注解。

使用commons-lang3

引入依赖

  1. <dependency> 
  2.     <groupId>org.apache.commons</groupId> 
  3.     <artifactId>commons-lang3</artifactId> 
  4.     <version>3.4</version> 
  5. </dependency> 

常用方法说明

Spring Boot进行优雅的字段校验,写得太好了!

测试代码

  1. //StringUtils.isEmpty 
  2. System.out.println(StringUtils.isEmpty(""));  //true 
  3. System.out.println(StringUtils.isEmpty("  "));  //false 
  4. //StringUtils.isNotEmpty 
  5. System.out.println(StringUtils.isNotEmpty(""));  //false 
  6.          
  7. //StringUtils.isBlank 
  8. System.out.println(StringUtils.isBlank(""));  //true 
  9. System.out.println(StringUtils.isBlank(" "));  //true 
  10. //StringUtils.isNotBlank 
  11. System.out.println(StringUtils.isNotBlank(" "));  //false 
  12.  
  13. List<Integer> emptyList = new ArrayList<>(); 
  14. List<Integer> nullList = null
  15. List<Integer> notEmptyList = new ArrayList<>(); 
  16. notEmptyList.add(1); 
  17.  
  18. //CollectionUtils.isEmpty 
  19. System.out.println(CollectionUtils.isEmpty(emptyList));   //true 
  20. System.out.println(CollectionUtils.isEmpty(nullList));   //true 
  21. System.out.println(CollectionUtils.isEmpty(notEmptyList));   //false 
  22.  
  23. //CollectionUtils.isNotEmpty 
  24. System.out.println(CollectionUtils.isNotEmpty(emptyList));   //false 
  25. System.out.println(CollectionUtils.isNotEmpty(nullList));   //false 
  26. System.out.println(CollectionUtils.isNotEmpty(notEmptyList));   //true 

自定义注解

当上面的方面都无法满足校验的需求以后,可以考虑使用自定义注解。

原文地址:https://mp.weixin.qq.com/s/FBfM10XXqItBukeChUPang