关于对象入参的校验,我们可能第一个想到的就是在Controller层或者Service层增加很多if else的判断,如:

if (user.getPassword() == "") {
throw new BusinessException("password can not be empty!");
} if (user.getRank() > 30 || user.getRank() <= -1) {
throw new BusinessException("The value of the rank should be in valid range");
}
// other codes

这样一路写下来非常容易心态暴躁,时间久了也会越来越冗余。Spring Boot提供了一个通过注解就能实现的字段验证方法。常用的注解如下:

//被注释的元素必须为null
@Null
//被注释的元素不能为null
@NotNull
//被注释的元素必须为true
@AssertTrue
//被注释的元素必须为false
@AssertFalse
//被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Min(value)
//被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Max(value)
//被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMin(value)
//被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMax(value)
//被注释的元素的大小必须在指定的范围内。
@Size(max,min)
//被注释的元素必须是一个数字,其值必须在可接受的范围内
@Digits(integer,fraction)
//被注释的元素必须是一个过去的日期
@Past
//被注释的元素必须是一个将来的日期
@Future
//被注释的元素必须符合指定的正则表达式。
@Pattern(value)
//被注释的元素必须是电子邮件地址
@Email
//被注释的字符串的大小必须在指定的范围内
@Length
//被注释的字符串必须非空
@NotEmpty
//被注释的元素必须在合适的范围内
@Range

而我们选出最高频的三个:

@NotNull用于Integer Double等类型

@NotBlank 用于String字符串

@NotEmpty 用于集合类或者数组。

这些验证注解都写在Bean对象,也就是pojo或者dao层文件中,下面举个栗子:

@Data
@NoArgsConstructor
@AllArgsConstructor
public class MyArticle {
// 文章ID
private int id;
// 文章标题
@NotBlank(message = "文章标题不能是空")
private String title;
// 文章作者
@NotBlank(message = "作者名不能是空")
private String author;
// 文章内容
@NotBlank(message = "文章内容不能是空")
private String content;
// 文章分类ID
@NotNull(message = "分类ID不能为空")
private int categoryId;
// 标签
@NotEmpty(message = "标签不能为空")
private List<String> tags;
// 创建时间
private int created;
// 修改时间
private int modified;
}

然后在对应的Controller接口中需要被验证的入参上增加一个注解@Validated即可,然后通过BindingResult对象来获取判断后的处理结果:

@PostMapping("/article")
@UserLoginToken
public Result add(@Validated @RequestBody MyArticle myArticle, BindingResult bindingResult) {
try {
if (bindingResult.hasErrors()) {
return new Result("400", "新发布文章失败!", bindingResult.getFieldError().getDefaultMessage(), "Bad Params", null);
}
boolean addResult = articleService.add(myArticle);
if (addResult) {
return new Result("200", "新发布文章成功!", "", "", null);
} else {
return new Result("200", "新发布文章失败!", "Oops, something weird", "10010", null);
}
} catch (Exception e) {
return new Result("400", "新发布文章失败!", e.getMessage(), "Bad Params", null);
}
}

一般情况下就结束了,但是等一下,你如果和我一样都是使用的高版本的Spring Boot,也就是2.3.x系列,那么以上增加的校验数据的注解会失效。这是由于高版本的Spring Boot需要单独手动安装Validate依赖包,在pom.xml文件中增加如下依赖:

<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.17.Final</version>
<scope>compile</scope>
</dependency>

安装好之后,重启项目,一切搞定!

解放生产力,从善用注解校验开始吧!

解放生产力:Spring Boot的注解校验的更多相关文章

  1. Spring Boot常用注解总结

    Spring Boot常用注解总结 @RestController和@RequestMapping注解 @RestController注解,它继承自@Controller注解.4.0之前的版本,Spr ...

  2. spring boot常用注解使用小结

    1.@RestController和@RequestMapping注解 4.0重要的一个新的改进是@RestController注解,它继承自@Controller注解. 4.0之前的版本,Sprin ...

  3. spring boot 常用注解

    @RestController和@RequestMapping注解 4.0重要的一个新的改进是@RestController注解,它继承自@Controller注解.4.0之前的版本,spring M ...

  4. Spring Boot 常用注解汇总

    一.启动注解 @SpringBootApplication @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documen ...

  5. 3个Spring Boot核心注解,你知道几个?

    Spring Boot 核心注解讲解 Spring Boot 最大的特点是无需 XML 配置文件,能自动扫描包路径装载并注入对象,并能做到根据 classpath 下的 jar 包自动配置. 所以 S ...

  6. Spring Boot@Component注解下的类无法@Autowired的问题

    title: Spring Boot@Component注解下的类无法@Autowired的问题 date: 2019-06-26 08:30:03 categories: Spring Boot t ...

  7. Spring boot 基于注解方式配置datasource

    Spring boot 基于注解方式配置datasource 编辑 ​ Xml配置 我们先来回顾下,使用xml配置数据源. 步骤: 先加载数据库相关配置文件; 配置数据源; 配置sqlSessionF ...

  8. 【SpringBoot】15. Spring Boot核心注解

    Spring Boot核心注解 1 @SpringBootApplication 代表是Spring Boot启动的类 2 @SpringBootConfiguration 通过bean对象来获取配置 ...

  9. spring boot纯注解开发模板

    简介 spring boot纯注解开发模板 创建项目 pom.xml导入所需依赖 点击查看源码 <dependencies> <dependency> <groupId& ...

随机推荐

  1. 阿里Canal中间件的初步搭建和使用

    一.前言 Binlog是MySQL数据库的二进制日志,用于记录用户对数据库操作的SQL语句(除了数据查询语句)信息.而Binlog格式也有三种,分别为STATEMENT.ROW.MIXED.STATM ...

  2. Pytorch_第九篇_神经网络中常用的激活函数

    神经网络中常用的激活函数 Introduce 理论上神经网络能够拟合任意线性函数,其中主要的一个因素是使用了非线性激活函数(因为如果每一层都是线性变换,那有啥用啊,始终能够拟合的都是线性函数啊).本文 ...

  3. 1、Java 开发环境配置

    Java 开发环境配置 在本章节中我们将为大家介绍如何搭建Java开发环境. Windows 上安装开发环境 Linux 上安装开发环境 安装 Eclipse 运行 Java window系统安装ja ...

  4. JavaScript Object初始化的不同方式

    不带原型的对象,纯对象 const plaintObject = Object.create(null) 带原型的对象 const originObject = new Object()

  5. golang 浮点型

    目录 前言 1.三要素 2.表现形式 3.类型 4.精度 5.格式化 6.使用细节 跳转 前言 不做文字的搬运工,多做灵感性记录 这是平时学习总结的地方,用做知识库 平时看到其他文章的相关知识,也会增 ...

  6. 微信小程序setData局部刷新列表

    利用setData局部刷新列表 当列表管理加载到第几页时,这个list的数据有十几条的,如果重新setData的话就要重新刷新和渲染列表, 这是个比较麻烦的事,当数据量大时,就会造成白屏, 这时就要局 ...

  7. 理解正向代理&反向代理

    通常的代理服务器,只用于代理内部网络对Internet的连接请求,客户机必须指定代理服务器,并将本来要直接发送到Web服务器上的http请求发送到代理服务器中.由于外部网络上的主机并不会配置并使用这个 ...

  8. 编译Uboot时出错:【已解决】 /bin/bash: arm-linux-gcc: command not found dirname: missing operand Try 'dirname --help' for more information.

    编译Uboot时出错: 错误信息如下: /bin/bash: arm-linux-gcc: command not found dirname: missing operand Try 'dirnam ...

  9. springmvc中get和post区别和应用

    最近对post和get什么时候使用 和 应该怎么使用  他俩的区别  有了一些疑问 根据本人的了解   post是对数据进行了封装保护 get是安全性较差的 可以看到数据的信息    post是用来改 ...

  10. 详解Python中的__init__和__new__

    转载:https://my.oschina.net/liuyuantao/blog/747164 1.__init__ 方法是什么? 使用Python写过面向对象的代码的同学,可能对 __init__ ...