掌握Spring Boot参数校验技巧，告别冗余if-else。文章涵盖常用注解、全局异常处理、分组校验、嵌套对象校验、快速失败和自定义校验规则。
原文标题：优雅的参数校验，告别冗余if-else
原文作者：阿里云开发者
冷月清谈：
怜星夜思：
2、文章中自定义校验规则的例子是手机号校验，感觉有点多余，现在已经有很多成熟的手机号校验工具类库。大家在实际工作中，都自定义过哪些比较有用的校验规则？
3、文章里提到了分组校验，感觉挺实用的，可以避免创建过多的VO类。大家在实际项目中，除了CreateGroup和UpdateGroup，还用过哪些其他的分组？
原文内容
在实际工作中，得到数据得到的第一步就是校验数据的正确性，如果存在录入上的问题，一般会通过注解校验，发现错误后返回给用户，但是对于一些逻辑上的错误，比如购买金额=购买数量*单价，这样的规则就很难使用注解方式验证了，此时可以使用Spring提供的验证器(Validator)规则去验证。
|
约束
|
说明
|
|
@Null
|
被注解的元素必须为Null
|
|
@NotNull
|
被注解的元素必须不为Null
|
|
@AssertTrue
|
被注解的元素必须为true
|
|
@AssertFalse
|
被注解的元素必须为false
|
|
@Min(value)
|
被注解的元素必须是一个数字，其值必须大于等于最小值
|
|
@Max(value)
|
被注解的元素必须是一个数字，其值必须小于等于最大值
|
|
@DecimalMin(value)
|
被注解的元素必须是一个数字，其值必须大于等于最小值
|
|
@DecimalMax(value)
|
被注解的元素必须是一个数字，其值必须小于等于最大值
|
|
@Size(max,min)
|
被注解的元素的大小必须在指定的范围内
|
|
@Digits(integer,fraction)
|
被注解的元素必须是一个数字，其值必须在可接受范围内
|
|
@Past
|
被注解的元素必须是一个过去的日期
|
|
@Future
|
被注解的元素必须是一个将来的日期
|
|
@Pattern(value)
|
被直接的元素必须符合指定的正则表达式
|
Hibernate Validator是JSR 303的一个参考实现,除了支持所有标准的校验注解之外，还扩展了如下表所示的注解。
|
约束
|
说明
|
|
@NotBlank
|
检查被注解的元素是不是Null，以及被去掉前后空格的长度是否大于0
|
|
@Email
|
被注解的元素必须是电子邮件格式
|
|
@URL
|
被注解的元素必须是合法的URL地址
|
|
@Length
|
被注解的字符串的字符串的大小必须在指定的范围内
|
|
@NotEmpty
|
校验集合元素或数组元素或者字符串是否非空。通常作用于集合字段或数组字段，此时需要集合或者数字的元素个数大于0。也可以作用于字符串，此时校验字符串不能为null或空串（可以是一个空格）。
|
|
@Range
|
被注解的元素必须在合适的范围内
|
二、实战
<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>
2.1 全局异常处理
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
//参数校验异常
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public Result error(MethodArgumentNotValidException e){
log.warn(e.getMessage());
return Result.fail()
.code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
.message(e.getBindingResult().getFieldError().getDefaultMessage());
}
//参数校验异常
@ExceptionHandler(BindException.class)
@ResponseBody
public Result error(BindException e){
log.warn(e.getMessage());
StringBuilder sb = new StringBuilder();
for (ObjectError error : e.getBindingResult().getAllErrors()) {
sb.append(error.getDefaultMessage());
}
return Result.fail()
.code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
.message(sb.toString());
}
//参数校验异常
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public Result error(ConstraintViolationException e){
log.warn(e.getMessage());
StringBuilder sb = new StringBuilder();
for (ConstraintViolation<?> violation : e.getConstraintViolations()) {
sb.append(violation.getMessage());
}
return Result.fail()
.code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
.message(sb.toString());
}
//全局异常
@ExceptionHandler(Exception.class)
@ResponseBody
public Result error(Exception e){
log.warn(e.getMessage());
return Result.fail().message("执行了全局异常处理");
}
}
2.2 快速开始
@Data public class UserCreateVO { @NotBlank(message = "用户名不能为空") private String userName;@NotBlank(message = “姓名不能为空”)
private String name;@Size(min=11,max=11,message = “手机号长度不符合要求”)
private String phone;
@NotNull(message = “性别不能为空”)
private Integer sex;
}
@Data public class UserUpdateVO {@NotBlank(message = “id不能为空”)
private String id;@NotBlank(message = “用户名不能为空”)
private String userName;@NotBlank(message = “姓名不能为空”)
private String name;@Size(min=11,max=11,message = “手机号长度不符合要求”)
private String phone;
@NotNull(message = “性别不能为空”)
private Integer sex;
}
@Validated @RestController @RequestMapping("/user") public class UserController {@PostMapping(“create”)
public Result createUser(@Validated @RequestBody UserCreateVO userCreateVo){
return Result.ok(“参数校验成功”);
}
@PostMapping(“update”)
public Result updateUser(@Validated @RequestBody UserUpdateVO userUpdateVo){
return Result.ok(“参数校验成功”);
}
}
新增接口测试：
这里故意不写用户名
有时候我们是通过 @Pathvariable 注解实现参数传递的，这个时候校验如下：
@GetMapping("getUserById/{id}")
public Result getUserById(@PathVariable @Size(min=2,max=5,message = "id长度不符合要求") String id){
return Result.ok("参数校验成功");
}
2.4 分组校验
//分组校验
public class UserGroup {
public interface CreateGroup extends Default {
}
public interface UpdateGroup extends Default {
}
}
@Data public class UserVo {@NotBlank(message = “id不能为空”,groups = UserGroup.UpdateGroup.class)
private String id;@NotBlank(message = “用户名不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String userName;@NotBlank(message = “姓名不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String name;@Size(min=11,max=11,message = “手机号长度不符合要求”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String phone;
@NotNull(message = “性别不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private Integer sex;
}
参数上边添加 @Validated 接口，并指定分组名称,并统一使用 UserVO 类接收参数。
@Validated @RestController @RequestMapping("/user") public class UserController {@PostMapping(“create”)
public Result createUser(@Validated(UserGroup.CreateGroup.class) @RequestBody UserVO userVO) {
return Result.ok(“参数校验成功”);
}@PutMapping(“update”)
public Result updateUser(@Validated(UserGroup.UpdateGroup.class) @RequestBody UserVO userVO) {
return Result.ok(“参数校验成功”);
}
@GetMapping(“getUserById/{id}”)
public Result getUserById(@PathVariable @Size(min = 2, max = 5, message = “id长度不符合要求”) String id) {
return Result.ok(“参数校验成功”);
}
}
新增接口：
2.5 嵌套对象校验
存在嵌套对象校验的时候，使用 @Valid 注解解决。
@Data
public class Role {
@NotBlank(message = "角色名称不能为空")
private String roleName;
}
在 User 类中引入角色实体，并加入 @Valid 注解。
@Data public class UserVo {@NotBlank(message = “id不能为空”,groups = UserGroup.UpdateGroup.class)
private String id;@NotBlank(message = “用户名不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String userName;@NotBlank(message = “姓名不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String name;@Size(min=11,max=11,message = “手机号长度不符合要求”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private String phone;@NotNull(message = “性别不能为空”,groups =
{UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
private Integer sex;
@Valid
@NotNull(message = “角色信息不能为空”)
private Role role;
}
测试新增接口，故意不传角色信息：
2.6 快速失败配置
/**
* 参数校验相关配置
*/
@Configuration
public class ValidConfig {
/**
* 快速返回校验器
* @return
*/
@Bean
public Validator validator(){
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
//快速失败模式
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
}
/**
- 设置快速校验，返回方法校验处理器
- 使用MethodValidationPostProcessor注入后，会启动自定义校验器
@return
*/
@Bean
public MethodValidationPostProcessor methodValidationPostProcessor(){
MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
methodValidationPostProcessor.setValidator(validator());
return methodValidationPostProcessor;
}
}
2.7 自定义校验规则
@Documented@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Constraint(validatedBy = PhoneValidator.class)
public @interface PhoneValid {
String message() default “请填写正确的手机号”;Class<?> groups() default {};
Class<? extends Payload> payload() default {};
}
实现 ConstraintValidator 接口。
public class PhoneValidator implements ConstraintValidator<PhoneValid,Object> { /** * 11位手机号的正则表达式,以13、14、15、17、18头 * ^：匹配字符串的开头 * 13\d：匹配以13开头的手机号码 * 14[579]:匹配以145、147、149开头的手机号 * 15[^4\D]：匹配以15开头且第3位数字不为4的手机号码 * 17[^49\D]:匹配以17开头且第3位数字部位4或9的手机号码 * 18\d :匹配以18开头的手机号码 * \d{8}：匹配手机号码的后8位，即剩余的8个数字 * $：匹配字符串的结尾 */ public static final String REGEX_PHONE="^(13\\d|14[579]|15[^4\\D]|17[^49\\D]|18\\d)\\d{8}$";//初始化注解
@Override
public void initialize(PhoneValid constraintAnnotation) {
ConstraintValidator.super.initialize(constraintAnnotation);
}
//校验参数，true表示校验通过，false表示校验失败
@Override
public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
String phone = String.valueOf(o);
if(phone.length()!=11){
return false;
}
//正则校验
return phone.matches(REGEX_PHONE);
}
}
先使用一个正确的手机号测试，校验成功。
[01]. Hibernate Validator
[02]. SpringBoot + validator优雅参数校验，消除if-else
[03]. 新来的一个同事，把SpringBoot参数校验玩的那叫一个优雅
[04]. 快速失败(Fail Fast) Spring Validation