SpringBoot 参数验证之 @Validated 和 @Valid
0x01：Spring Validation 验证框架
Spring Validation 验证框架对参数的验证机制提供了@Validated （Spring's JSR-303 规范，是标准 JSR-303 的一个变种），javax 提供了@Valid（标准 JSR-303 规范），配合 BindingResult 可以直接提供参数验证结果。其中对于字段的特定验证注解，比如 @NotNull。
两者在检验 Controller 的入参是否符合规范时，使用@Validated 或者 @Valid 在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：
@Validated
分组：提供分组功能，可在入参验证时，根据不同的分组采用不同的验证机制。
可注解位置 ：可以用在类型、方法和方法参数上。但是不能用在成员属性上
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；不能用在成员属性上；也无法提供框架进行嵌套验证；能配合嵌套验证注解 @Valid 进行嵌套验证。
@Valid
分组：无分组功能
可注解位置：可以用在方法、构造函数、方法参数和成员属性上（两者是否能用于成员属性上直接影响能否提供嵌套验证的功能）
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；能够用在成员属性上，提示验证框架进行嵌套验证；能配合嵌套验证注解@Valid进行嵌套验证。
0x02：简单集成
pom.xml 文件添加如下依赖
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.olive</groupId>
<artifactId>valid-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.8.RELEASE</version>
<relativePath />
</parent>
<name>valid-demo</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>
创建 Cotroller
@RestController
public class UserController {
@RequestMapping("/user/queryUser")
public Map queryUser(@RequestBody @Validated UserQueryVo queryVo){
Map result = new HashMap();
result.put("code", 200);
result.put("msg", "success");
return result;
}
}
主要在参数中添加 @Validated 注解，然后使用的 JSON 格式数据提交
创建参数 Vo 类
BaseVo.java
public class BaseVo implements Serializable{
}
UserQueryVo.java
public class UserQueryVo extends BaseVo {
@NotEmpty(message="不能为空")
private String query;
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
}
主要在查询条件字段添加注解 @NotEmpty，标识不能为空
创建启动引导类
@SpringBootApplication
public class Application
{
public static void main( String[] args )
{
SpringApplication.run(Application.class, args);
}
}
测试验证
请求参数
如果为空，则验证不过；如果不为空，则验证通过
0x03：分组验证
controller 增加添加用户和修改用户接口
@RequestMapping("/user/addUser")
public Map addUser(@RequestBody @Validated(value={UserDto.Add.class}) UserDto userDto){
Map result = new HashMap();
result.put("code", 200);
result.put("msg", "success");
return result;
}
@RequestMapping("/user/editUser")
public Map editUser(@RequestBody @Validated(value={UserDto.Update.class}) UserDto userDto){
Map result = new HashMap();
result.put("code", 200);
result.put("msg", "success");
return result;
}
关键代码
@Validated(value={UserDto.Add.class})
@Validated(value={UserDto.Update.class})
进行了分组校验
UserDto 对象代码
package com.olive.vo;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;
public class UserDto extends BaseVo{
@NotNull(groups=Update.class, message="不能为空")
@Null(groups=Add.class)
private Integer id;
private String userName;
// 省略 getter setter
}
测试验证
添加用户
更新用户
如有id参数
中奖名单
喜欢，在看