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

妖狐艹你老母 2022-10-15 05:49 108阅读 0赞

![698966b9eade1846afc5940d99334bef.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>

**常用注解说明**

![94938738d6578ac2f90bd2309e1e1042.png][]

**使用姿势**

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

![247df29fed37c28082f065537a7b03d5.png][]

虽然@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));
    }

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

#### 使用commons-lang3 ####

**引入依赖**

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

**常用方法说明**

![0fb8c89688444f6802eae6e22b19c4aa.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

### 自定义注解 ###

当上面的方面都无法满足校验的需求以后，可以考虑使用自定义注解，如何写一个自定义注解，可以参考之前写的文章：[Spring自定义注解从入门到精通][Spring]

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![773420dcedbf15eb0d5d9a3b0397fa81.png][]

[698966b9eade1846afc5940d99334bef.png]: /images/20221014/bbc44724b07c447f8da7a29a27dc408f.png
[94938738d6578ac2f90bd2309e1e1042.png]: /images/20221014/bd53f71023cd42beb861977e9b225726.png
[247df29fed37c28082f065537a7b03d5.png]: /images/20221014/6b7c0e06fab143b8bcca6c9a7254e1dc.png
[0fb8c89688444f6802eae6e22b19c4aa.png]: /images/20221014/df72d54a72e9499c86598be905f43a28.png
[Spring]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd628e1dca1a1f7eea004c5588b2c9d13292fffa74c32eeac46dfc1db7e25baf7ae5ec78e73&idx=2&mid=2247489485&scene=21&sn=157827d4ffa6710d75a1f39944378709#wechat_redirect
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[773420dcedbf15eb0d5d9a3b0397fa81.png]: /images/20221014/f0b9b875e9364bf5ac3eacdf9303d18c.png