springboot中参数校验（validation）使用

文章目录

介绍:
validation引入
可用约束（constraint）
应用实战
- 实体类
- 接口参数型
- 约束生效
- 实体型

介绍:

在开发中，会经常需要进行参数的校验，比如接口层、业务层、持久层等，其中接口的参数校验就是最为常见的。这里就来看一下springboot中参数校验（validation）的使用。

validation引入

在springboot官方文档上对validation的使用介绍中，说明了只要JSR-303实现（例如Hibernate验证器）在类路径上，Bean Validation 1.1支持的方法验证功能就会自动启用。为此springboot为我们提供了一个 validation starter：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId><!--<version>2.1.0.RELEASE</version>-->
</dependency>

里面校验的核心依赖就是JSR-303标准的实现（Hibernate验证器）：

<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId>
</dependency>

这个不需要添加已经包含在内了

如果我们在进行web开发的话，就不需要在引用“spring-boot-starter-validation”了，因为“spring-boot-starter-web”中已经引用了“hibernate-validator”。

可用约束（constraint）

hibernate-validator沿用了validation-api中的所有注解约束，同时也定义了一些自己的约束：

应用实战

约束应用

实体类

首先是使用约束性注解，在实体型参数上使用，代码样例如下：

/*** @author lazycece* @date 2019/02/15*/
@Setter
@Getter
@ToString
public class UserInfoReq {@NotNull(message = "id不能为null", groups = {Update.class})private Long id;@NotBlank(message = "username不能为空")private String username;@NotNull(message = "age不能为null")@Min(value = 1, message = "年龄不符合要求")@Max(value = 200, message = "年龄不符合要求")private Integer age;
}

接口参数型

在接口参数上使用，代码样例如下：

@GetMapping("/query")
public String queryUserInfo(@NotBlank(message = "username不能为空") String username) {log.info("查询用户成功: {}", username);return "success";
}

约束生效

要使我们添加的约束注解生效，那么还得使用另一个注解：@Validated 或者 @Valid（只针对实体性有用）。

实体型

要使得实体性参数生效，需要在接口参数上添加 @Validated 或者 @Valid 注解。代码样例如下：

@PutMapping("/add")
public String addUserInfo(@Validated UserInfoReq req) {log.info("添加用户成功: {}", req.toString());return "success";
}
@PostMapping("/update")
public String updateUserInfo(@Validated(value = {Update.class}) UserInfoReq req) {log.info("更新用户成功: {}", req.toString());return "success";
}

而最好使用@Validated，因为它可以使用验证组，使得某一个参数只针对属于该组的情况下验证生效，如实体参数中使用：

@NotNull(message = "id不能为null", groups = {Update.class})
private Long id;

然后生效注解上加上组：

@Validated(value = {Update.class})

这样即表示，参数id的验证只针对更新操作(update)生效，而在执行添加操作(add)的时候是不验证的。

接口参数型
要使得接口参数型的验证生效，是必须在里面加@Validated注解的。（此类型和实体性验证失败所产生的异常是不同的）