简介
通常项目使用 Hibernate Validator 框架，对 RESTful API 接口进行参数的校验，以保证最终数据入库的正确性。例如说，用户注册时，会校验手机格式的正确性，密码非弱密码。
如果参数校验不通过，会抛出ConstraintViolationException异常，被全局的异常处理捕获，返回“请求参数不正确”的响应。示例如下：
{
"code": 400,
"data": null,
"msg": "请求参数不正确:密码不能为空"
}
1. 参数校验注解
Validator 内置了 20+ 个参数校验注解，整理成常用与不常用的注解。
1.1 常用注解
| 注解 | 功能 |
|---|---|
@NotBlank |
只能用于字符串不为 null，并且字符串 #trim() 以后 length 要大于 0 |
@NotEmpty |
集合对象的元素不为 0（集合不为空），也可以用于字符串不为 null |
@NotNull |
不能为 null |
@Pattern(value) |
被注释的元素必须符合指定的正则表达式 |
@Max(value) |
该字段的值只能小于或等于该值 |
@Min(value) |
该字段的值只能大于或等于该值 |
@Range(min=, max=) |
被注释的元素必须在指定的范围内 |
@Size(max, min) |
检查该字段的 size 是否在 min 和 max 之间（支持字符串、数组、集合、Map 等） |
@Length(max, min) |
被注释的字符串的大小必须在指定的范围内 |
@AssertFalse |
被注释的元素必须为 true |
@AssertTrue |
被注释的元素必须为 false |
@Email |
被注释的元素必须是电子邮箱地址 |
@URL(protocol=,host=,port=,regexp=,flags=) |
被注释的字符串必须是一个有效的 URL |
1.2 不常用注解
| 注解 | 功能 |
|---|---|
@Null |
必须为 null |
@DecimalMax(value) |
被注释的元素必须是一个数字，其值必须小于等于指定的最大值 |
@DecimalMin(value) |
被注释的元素必须是一个数字，其值必须大于等于指定的最小值 |
@Digits(integer, fraction) |
被注释的元素必须是一个数字，其值必须在可接受的范围内 |
@Positive |
判断正数 |
@PositiveOrZero |
判断正数或 0 |
@Negative |
判断负数 |
@NegativeOrZero |
判断负数或 0 |
@Future |
被注释的元素必须是一个将来的日期 |
@FutureOrPresent |
判断日期是否是将来或现在日期 |
@Past |
检查该字段的日期是在过去 |
@PastOrPresent |
判断日期是否是过去或现在日期 |
@SafeHtml |
判断提交的 HTML 是否安全。例如说，不能包含 JavaScript 脚本等 |
2. 参数校验使用
只需要三步，即可开启参数校验的功能。
第零步，引入参数校验的 spring-boot-starter-validation 依赖。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>第一步，在需要参数校验的类上，添加
@Validated注解，例如说 Controller、Service 类。代码如下：// Controller 示例 @Validated public class AuthController { } // Service 示例，一般放在实现类上 @Service @Validated public class AdminAuthServiceImpl implements AdminAuthService { }第二步（情况一）如果方法的参数是
Bean类型，则在方法参数上添加@Valid注解，并在 Bean 类上添加参数校验的注解。代码如下：// Controller 示例 @Validated public class AuthController { @PostMapping("/login") public CommonResult<AuthLoginRespVO> login(@RequestBody @Valid AuthLoginReqVO reqVO) { } } // Service 示例，一般放在接口上 public interface AdminAuthService { String login(@Valid AuthLoginReqVO reqVO, String userIp, String userAgent); } // Bean 类的示例。一般建议添加参数注解到属性上。原因：采用 Lombok 后，很少使用 getter 方法 public class AuthLoginReqVO { @NotEmpty(message = "登录账号不能为空") @Length(min = 4, max = 16, message =