关于springboot: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自定义注解从入门到精通

【腾讯云】轻量 2核2G4M,首年65元

阿里云限时活动-云数据库 RDS MySQL  1核2G配置 1.88/月 速抢

本文由乐趣区整理发布,转载请注明出处,谢谢。

您可能还喜欢...

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据