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

 更新时间:2021年01月05日 14:58:17   作者:何甜甜在吗  
这篇文章主要给大家介绍了关于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字段校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java通过SMS短信平台实现发短信功能 含多语言

    Java通过SMS短信平台实现发短信功能 含多语言

    这篇文章主要为大家详细介绍了Java通过SMS短信平台实现发短信功能的相关资料,感兴趣的小伙伴们可以参考一下
    2016-07-07
  • SpringBoot外部化配置示例解析

    SpringBoot外部化配置示例解析

    这篇文章主要介绍了SpringBoot外部化配置示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • java接口用户上下文的设计与实现

    java接口用户上下文的设计与实现

    这篇文章主要为大家介绍了接口用户上下文的设计与实现实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Java 用两个线程交替打印数字和字母

    Java 用两个线程交替打印数字和字母

    这篇文章主要介绍了Java 用两个线程交替打印数字和字母的方法,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-03-03
  • 详解pom.xml中maven profile的激活方式

    详解pom.xml中maven profile的激活方式

    本文主要介绍了详解pom.xml中maven profile的激活方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • springboot自帶线程池ThreadPoolTaskExecutor使用

    springboot自帶线程池ThreadPoolTaskExecutor使用

    本文主要介绍了springboot自帶线程池ThreadPoolTaskExecutor使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • 一篇文章带你了解Java Stream流

    一篇文章带你了解Java Stream流

    Stream流是数据渠道,用于操作数据源(集合、数组等)所生成的元素序列。这篇文章主要介绍了Java8新特性Stream流的相关资料,需要的朋友参考下吧
    2021-08-08
  • SpringBoot统一返回处理出现cannot be cast to java.lang.String异常解决

    SpringBoot统一返回处理出现cannot be cast to java.lang.String异常解决

    这篇文章主要给大家介绍了关于SpringBoot统一返回处理出现cannot be cast to java.lang.String异常解决的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-09-09
  • Spark SQL的自定义函数UDF使用

    Spark SQL的自定义函数UDF使用

    Spark Sql可以通过UDF来对DataFrame的Column进行自定义操作。在特定场景下定义UDF可能需要用到Spark Context以外的资源或数据。比如从List或Map中取值,或是通过连接池从外部的数据源中读取数据,然后再参与Column的运算
    2023-02-02
  • JAVA演示阿里云图像识别API,印刷文字识别-营业执照识别

    JAVA演示阿里云图像识别API,印刷文字识别-营业执照识别

    最近有由于工作需要,开始接触阿里云的云市场的印刷文字识别API-营业执照识别这里我加上了官网的申请说明,只要你有阿里云账号就可以用,前500次是免费的,API说明很简陋,只能做个简单参考
    2019-05-05

最新评论