简单使用
Java API
规范 (JSR303
) 定义了Bean
校验的标准validation-api
,但没有提供实现。hibernate validation
是对这个规范的实现,并增加了校验注解如@Email
、@Length
等。Spring Validation
是对hibernate validation
的二次封装,用于支持spring mvc
参数自动校验。接下来,我们以spring-boot
项目为例,介绍Spring Validation
的使用。
引入依赖
如果spring-boot
版本小于2.3.x
,spring-boot-starter-web
会自动传入hibernate-validator
依赖。如果spring-boot
版本大于2.3.x
,则需要手动引入依赖:
<!--JSR303数据校验-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
<version>2.6.4</version>
</dependency>
对于web
服务来说,为防止非法参数对业务造成影响,在Controller
层一定要做参数校验的!大部分情况下,请求参数分为如下两种形式:
-
POST
、PUT
请求,使用requestBody
传递参数; -
GET
请求,使用requestParam/PathVariable
传递参数。
下面我们简单介绍下requestBody
和requestParam/PathVariable
的参数校验实战!
requestBody参数校验
POST
、PUT
请求一般会使用requestBody
传递参数,这种情况下,后端使用DTO 对象进行接收。只要给 DTO 对象加上@Validated
注解就能实现自动参数校验。比如,有一个保存User
的接口,要求userName
长度是2-10
,password
字段长度是6-20
。如果校验失败,会抛出MethodArgumentNotValidException
异常,Spring
默认会将其转为400(Bad Request)
请求。
-
在
DTO
字段上声明约束注解
@Data
public class UserDTO {
private Long userId;
@NotNull
@Length(min = 2, max = 10)
private String userName;
@NotNull
@Length(min = 6, max = 20)
private String password;
}
-
在方法参数上声明校验注解
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserDTO userDTO) {
return Result.ok();
}
这种情况下,使用@Valid
和@Validated
都可以。
requestParam/PathVariable参数校验
GET
请求一般会使用requestParam/PathVariable
传参。在这种情况下,必须在Controller
类上标注@Validated
注解,并在入参上声明约束注解 (如@Min
等)。如果校验失败,会抛出ConstraintViolationException
异常。代码示例如下:
@RequestMapping("/api/user")
@RestController
@Validated
public class UserController {
@GetMapping("{userId}")
public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
UserDTO userDTO = new UserDTO();
userDTO.setUserId(userId);
userDTO.setUserName("xiaoxiao");
return Result.ok(userDTO);
}
@GetMapping("getByAccount")
public Result getByAccount(@Length(min = 2, max = 10) @NotNull String username) {
UserDTO userDTO = new UserDTO();
userDTO.setUserId(10000000000000003L);
userDTO.setUserName(username);
return Result.ok(userDTO);
}
}
统一异常处理
如果校验失败,会抛出MethodArgumentNotValidException
或者ConstraintViolationException
异常。在实际项目开发中,通常会用统一异常处理来返回一个更友好的提示。比如我们系统要求无论发送什么异常,http
的状态码必须返回200
,由业务码去区分系统的异常情况。
@RestControllerAdvice
public class CommonExceptionHandler {
@ExceptionHandler({MethodArgumentNotValidException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
BindingResult bindingResult = ex.getBindingResult();
StringBuilder sb = new StringBuilder("校验失败:");
for (FieldError fieldError : bindingResult.getFieldErrors()) {
sb.append(fieldError.getField()).append(":").append(fieldError.getDefaultMessage()).append(", ");
}
String msg = sb.toString();
return Result.fail(msg);
}
@ExceptionHandler({ConstraintViolationException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleConstraintViolationException(ConstraintViolationException ex) {
return Result.fail(ex.getMessage());
}
}
分组校验
在实际项目中,可能多个方法需要使用同一个DTO
类来接收参数,而不同方法的校验规则很可能是不一样的。这个时候,简单地在DTO
类的字段上加约束注解无法解决这个问题。因此,spring-validation
支持了分组校验的功能,专门用来解决这类问题。还是上面的例子,比如保存User
的时候,UserId
是可空的,但是更新User
的时候,UserId
的值必须>=10000000000000000L
;其它字段的校验规则在两种情况下一样。这个时候使用分组校验的代码示例如下:
-
约束注解上声明适用的分组信息
groups
@Data
public class UserDTO {
// 只限制更新(Update.class)
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
// 不为null,长度限制对save、updata都有效
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String userName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String password;
}
-
@Validated
注解上指定校验分组
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
return Result.ok();
}
@PostMapping("/update")
public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
return Result.ok();
}
嵌套校验
前面的示例中,DTO
类里面的字段都是基本数据类型
和String
类型。但是实际场景中,有可能某个字段也是一个对象,这种情况下,可以使用嵌套校验
。
比如,上面保存User
信息的时候同时还带有Address信息。需要注意的是,此时DTO
类的对应字段必须标记@Valid
注解。
@Data
public class UserDTO {
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String userName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String password;
@NotNull(groups = {Save.class, Update.class})
@Valid
private Address addr;
@Data
public static class Address{
@Min(value = 1, groups = Update.class)
private Long addrId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String addrName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String location;
}
}
集合校验
如果请求体直接传递了集合给后台,并希望对集合中的每一项都进行参数校验。此时,如果我们直接使用java.util.Collection
下的list
或者set
来接收数据,参数校验并不会生效!我们可以使用自定义list
集合来接收参数:
集合校验
会对集合里面的每一项都进行校验,例如List<Address>
字段会对这个list
里面的每一个address
对象都进行校验。
- 自定义List集合
public class ValidationList<E> implements List<E> {
@Delegate
@Valid
public List<E> list = new ArrayList<>();
@Override
public String toString() {
return list.toString();
}
}
@Delegate
注解受lombok
版本限制,1.18.6
以上版本可支持。如果校验不通过,会抛出NotReadablePropertyException
,同样可以使用统一异常进行处理。
一次请求保存多个User对象
@PostMapping("/saveList")
public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) {
return Result.ok();
}
@Valid和@Validated区别