Springboot如何优雅地进行字段校验

差不多大半年没写文章了，终于将手头上的事忙完了，可以对外输出了。前段时间提交代码审核，同事提了一个代码规范缺陷：参数校验应该放在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>

常用注解说明

注解	说明
@length(min=,max=)	检查所属的字段的长度是否在min和max之间，只能用于字符串
@range(min=,max=,message=)	被注释的元素必须在合适的范围内
@max	该字段的值只能小于或等于该值
@min	该字段的值只能大于或等于该值
@notnull	不能为null
@notblank	不能为空，检查时会将空格忽略
@notempty	不能为空，这里的空是指空字符串
@pattern(regex=,flag=)	被注释的元素必须符合指定的正则表达式

使用姿势

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

注解	@validated	@valid
所属的包	属于org.springframework.validation.annotation包下的,是spring提供的	属于javax.validation包下,是jdk给提供的
是否支持分组和排序	是	否

虽然@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>

常用方法说明

方法	说明
collectionutils.isempty	判断集合是否为空，为null或者size==0，返回true
collectionutils.isnotempty	判断集合是否为非空
stringutils.isempty	判断字符串是否为空
stringutils.isnotempty	判断字符串是否非空
stringutils.isblank	判断字符串是否为空，为null或者size==0或者只存在空白字符(如" ")，则返回true
stringutils.isnotblank	判断字符串是否为非空

测试代码

//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自定义注解从入门到精通

到此这篇关于springboot如何优雅地进行字段校验的文章就介绍到这了,更多相关springboot字段校验内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！