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

约定不等于承诺〃 2022-08-28 04:46 192阅读 0赞

**点击关注公众号，Java干货****及时送达**![25b0b46a804b4af5012e25f94c49ca1e.png][]

作者：何甜甜在吗  
来源：juejin.cn/post/6913735652806754311

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

## Controller层 VS Service层 ##

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

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

## 常用校验工具类 ##

### 使用Hibernate Validate ###

**引入依赖**

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

**常用注解说明**

![37b90a80d0cd7b8cb9b88fe2343195af.png][]

**使用姿势**

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

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

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

![b0a52ae143573c7d6b38b869aa81b213.png][]

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

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

[定义一个实体][Link 1]

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字段为不符合校验规则时抛出的异常信息][Link 1]

[Controller层中的方法][Link 1]

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

[说明：在校验的实体DataSetSaveVO旁边添加@Valid或@Validated注解][Link 1]。

### 使用commons-lang3 ###

**引入依赖**

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

**常用方法说明**

![3cdab836e5c793232d448e7e39563f9a.png][]

**测试代码**

//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

## 自定义注解 ##

当上面的方面都无法满足校验的需求以后，可以考虑使用[自定义注解][Link 2]。另外，关注公众号Java技术栈，在后台回复：面试，可以获取我整理的 Java、Spring 系列面试题和答案，非常齐全。

![9871410c5099661f271d1dc090350d7c.gif][]

[![ea092bce8d553ead86201b932d0657a0.png][]][ea092bce8d553ead86201b932d0657a0.png 1]

[![a4ee1bdd87ad769b4ca29cdb6f8385df.png][]][a4ee1bdd87ad769b4ca29cdb6f8385df.png 1]

[![1e7bcf87935d2dfccb4351ace3dd61ff.png][]][1e7bcf87935d2dfccb4351ace3dd61ff.png 1]

[![f88d9e01d61acc7e2d0a5ec3bbfb19b5.png][]][f88d9e01d61acc7e2d0a5ec3bbfb19b5.png 1]

[![fac47a8182dac0bed24e833a136228bc.png][]][fac47a8182dac0bed24e833a136228bc.png 1]

[![6c9350b19dccb977411018cc4ab81664.png][]][6c9350b19dccb977411018cc4ab81664.png 1]

[![404d3ad8d83b25c2cb4b0d78505e486b.png][]][404d3ad8d83b25c2cb4b0d78505e486b.png 1]

**关注Java技术栈看更多干货**

![43237c2d2c5bb935dfaabb0d144fe09d.png][]

![92e61ea40905caa02d29dc26b4569203.gif][]

获取 Spring Boot 实战笔记！

[25b0b46a804b4af5012e25f94c49ca1e.png]: /images/20220828/9e0172f9194c4f758d7af45950da4c83.png
[37b90a80d0cd7b8cb9b88fe2343195af.png]: /images/20220828/a4cb38059d6c49f683a23e7611341c77.png
[b0a52ae143573c7d6b38b869aa81b213.png]: /images/20220828/503a2d7b1a0c4437b5318d413ab8265a.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247542384&idx=2&sn=4f1148b7fc0090760ba0e8ef4c299ac1&chksm=eb50a346dc272a50baca4f3f935323612c0ce4283599e87550276336dcc79b9bd6bde2f627df&scene=21#wechat_redirect
[3cdab836e5c793232d448e7e39563f9a.png]: /images/20220828/9d3a7323cb2c43b7998ca0211fb70b59.png
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247504781&idx=2&sn=4066eb337ac23e252f339631ffbe00ac&chksm=eb5056bbdc27dfadb5271d227d8e2adc240d771e26c5553373d7210fcb5c0e6e65339a350f56&scene=21#wechat_redirect
[9871410c5099661f271d1dc090350d7c.gif]: /images/20220828/63036b32d9ca4fed87ebfccbd812aa60.png
[ea092bce8d553ead86201b932d0657a0.png]: /images/20220828/b5ad98f894eb4c16a3087c678bec80c6.png
[ea092bce8d553ead86201b932d0657a0.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247546398&idx=1&sn=59d44271685cf64440507acb9ed2e926&scene=21#wechat_redirect
[a4ee1bdd87ad769b4ca29cdb6f8385df.png]: /images/20220828/8761b237380a4813abf2c1f9547276c9.png
[a4ee1bdd87ad769b4ca29cdb6f8385df.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247545678&idx=1&sn=a430fb2e260c200dc79fe37f5382868e&scene=21#wechat_redirect
[1e7bcf87935d2dfccb4351ace3dd61ff.png]: /images/20220828/dc60e95eef4b44358962dfbde1de24e9.png
[1e7bcf87935d2dfccb4351ace3dd61ff.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247545350&idx=1&sn=c1bbc0bd21799c3d936d59ecdaf97f8e&scene=21#wechat_redirect
[f88d9e01d61acc7e2d0a5ec3bbfb19b5.png]: /images/20220828/2fdb8e267f834026910ae263f32510ef.png
[f88d9e01d61acc7e2d0a5ec3bbfb19b5.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247539795&idx=1&sn=1efca511169265e8146e90db220159d5&scene=21#wechat_redirect
[fac47a8182dac0bed24e833a136228bc.png]: /images/20220828/addaa2d9507645ddb213dcf8462afa07.png
[fac47a8182dac0bed24e833a136228bc.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247542231&idx=1&sn=75ab147414255cc18c26b03746833be8&scene=21#wechat_redirect
[6c9350b19dccb977411018cc4ab81664.png]: /images/20220828/d858488c35e340acab3baf93fc286ba9.png
[6c9350b19dccb977411018cc4ab81664.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247537730&idx=1&sn=3869e164e482b838671fa8896cb33cdb&scene=21#wechat_redirect
[404d3ad8d83b25c2cb4b0d78505e486b.png]: /images/20220828/5cacb1b179b54af7bc04bdcd39a0ec59.png
[404d3ad8d83b25c2cb4b0d78505e486b.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247546343&idx=1&sn=b85c30a38d535a1c219b2c72f52a9cb1&scene=21#wechat_redirect
[43237c2d2c5bb935dfaabb0d144fe09d.png]: /images/20220828/b882b11fca814bb0b0dabd45e20c8aa5.png
[92e61ea40905caa02d29dc26b4569203.gif]: /images/20220828/729018907c714df7a0ca73f46b701734.png