Springboot中如何优雅的进行字段校验

╰+攻爆jí腚メ 2022-09-02 04:11 202阅读 0赞

# 概述 #

后端要对前端传来得参数做各种校验，如果使用if-else语句会使代码可读性降低，不简洁，此时可以使用一些第三方校验工具类

# Hibernate Validate #

引入依赖

<dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>4.3.1.Final</version>
    </dependency>

常用注解

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Length(min=,max=)</td> 
   <td>检查所属的字段的长度是否在min和max之间，只能用于字符串</td> 
  </tr> 
  <tr> 
   <td>@Range(min=,max=,message=)</td> 
   <td>被注释的元素必须在合适的范围内</td> 
  </tr> 
  <tr> 
   <td>@Max</td> 
   <td>该字段的值只能小于或等于该值</td> 
  </tr> 
  <tr> 
   <td>@Min</td> 
   <td>该字段的值只能大于或等于该值</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>不能为null</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td>不能为空，检查时会将空格忽略</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>不能为空，这里的空是指空字符串</td> 
  </tr> 
  <tr> 
   <td>@Pattern(regex=,flag=)</td> 
   <td>被注释的元素必须符合指定的正则表达式</td> 
  </tr> 
 </tbody> 
</table>

需要在controller中搭配@Validated或@Valid注解一起使用，@Validated或@Valid注解一起使用区别不是很大 ，二选一

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>@Validated</th> 
   <th>@Valid</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>所属的包</td> 
   <td>属于org.springframework.validation.annotation包下的,是spring提供的</td> 
   <td>属于javax.validation包下,是jdk给提供的</td> 
  </tr> 
  <tr> 
   <td>是否支持分组和排序</td> 
   <td>是</td> 
   <td>否</td> 
  </tr> 
 </tbody> 
</table>

虽然@Validated比@Valid更加强大，在@Valid之上提供了分组功能和验证排序功能，不过在实际项目中一直没有用到过 Hibernate-validate框架中的注解是需要加在实体中一起使用的

案例实体

public class DataSetSaveVO {
        //唯一标识符为空
        @NotBlank(message = "user uuid is empty")
        //用户名称只能是字母和数字
        @Pattern(regexp = "^[a-z0-9]+$", message = "user names can only be alphabetic and numeric")
        @Length(max = 48, message = "user uuid length over 48 byte")
        private String userUuid;
    
        //数据集名称只能是字母和数字
        @Pattern(regexp = "^[A-Za-z0-9]+$", message = "data set names can only be letters and Numbers")
        //文件名称过长
        @Length(max = 48, message = "file name too long")
        //文件名称为空
        @NotBlank(message = "file name is empty")
        private String name;
    
        //数据集描述最多为256字节
        @Length(max = 256, message = "data set description length over 256 byte")
        //数据集描述为空
        @NotBlank(message = "data set description is null")
        private String description;
    }

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

controller

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

# commons-lang3 #

<dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <version>3.4</version>
    </dependency>

方法

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>CollectionUtils.isEmpty</td> 
   <td>判断集合是否为空，为null或者size==0，返回true</td> 
  </tr> 
  <tr> 
   <td>CollectionUtils.isNotEmpty</td> 
   <td>判断集合是否为非空</td> 
  </tr> 
  <tr> 
   <td>StringUtils.isEmpty</td> 
   <td>判断字符串是否为空</td> 
  </tr> 
  <tr> 
   <td>StringUtils.isNotEmpty</td> 
   <td>判断字符串是否非空</td> 
  </tr> 
  <tr> 
   <td>StringUtils.isBlank</td> 
   <td>判断字符串是否为空，为null或者size==0或者只存在空白字符(如" ")，则返回true</td> 
  </tr> 
  <tr> 
   <td>StringUtils.isNotBlank</td> 
   <td>判断字符串是否为非空</td> 
  </tr> 
 </tbody> 
</table>

测试代码

//StringUtils.isEmpty
    System.out.println(StringUtils.isEmpty(""));  //true
    System.out.println(StringUtils.isEmpty("  "));  //false
    //StringUtils.isNotEmpty
    System.out.println(StringUtils.isNotEmpty(""));  //false
    
    //StringUtils.isBlank
    System.out.println(StringUtils.isBlank(""));  //true
    System.out.println(StringUtils.isBlank(" "));  //true
    //StringUtils.isNotBlank
    System.out.println(StringUtils.isNotBlank(" "));  //false
    
    List<Integer> emptyList = new ArrayList<>();
    List<Integer> nullList = null;
    List<Integer> notEmptyList = new ArrayList<>();
    notEmptyList.add(1);
    
    //CollectionUtils.isEmpty
    System.out.println(CollectionUtils.isEmpty(emptyList));   //true
    System.out.println(CollectionUtils.isEmpty(nullList));   //true
    System.out.println(CollectionUtils.isEmpty(notEmptyList));   //false
    
    //CollectionUtils.isNotEmpty
    System.out.println(CollectionUtils.isNotEmpty(emptyList));   //false
    System.out.println(CollectionUtils.isNotEmpty(nullList));   //false
    System.out.println(CollectionUtils.isNotEmpty(notEmptyList));   //true

# 自定义注解 #

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

参考：[https://blog.csdn.net/xnn\_fjj/article/details/100603270][https_blog.csdn.net_xnn_fjj_article_details_100603270]

[https_blog.csdn.net_xnn_fjj_article_details_100603270]: https://blog.csdn.net/xnn_fjj/article/details/100603270