Spring Boot下如何校验Spring MVC的请求参数及如何自定义校验注解

开发 后端
Spring Boot提供了spring-boot-starter-validation 为Bean的校验提供支持。我们可以通过一系列的校验注解对Java Bean的属性进行校验。

在Java世界里,用于Java Bean的校验的标准规范是JSR 380,又被称作Bean Validation 2.0。而JSR 380的实现是Hibernate Validator。

Spring Boot提供了spring-boot-starter-validation 为Bean的校验提供支持。我们可以通过一系列的校验注解对Java Bean的属性进行校验。

本文将演示如何在对Spring MVC的请求参数进行校验。当然它可以用在任何Java Bean的校验上。

我们先新建一个演示项目,注意除了添加“Spring Web”依赖,还需要额外添加“Validation”依赖,从Spring Boot 2.3后,我们需要显示添加此依赖。

常用JSR 380注解及如何校验请求DTO

@Data
public class PersonDto {
@NotNull(message = "姓名不能为空")
private String name;
@Min(value = 18, message = "年纪最小18")
@Max(value = 60, message = "年纪最大60")
private Integer age;
@Email(message = "地址只能邮件")
private String email;
}

在DTO这个JavaBean上使用JSR 380注解,主要的注解有:

  • @NotNull :校验注解的属性不能为null
  • @AssertTrue : 校验注解的属性是true
  • @Size : 校验大小范围是在min和max之间,可以是String、Collection、Map,和数组属性
  • @Min: 校验注解的属性最小不能小于设定的值
  • @Max: 校验注解的属性最大不能大于设定的值
  • @Pattern:校验当前字符串属性符合指定的正则表达式
  • @Email :校验注解属性是一个有效的邮件地址
  • @NotEmpty:校验注解的属性不能为null或者是empty,以是String、Collection、Map,和数组属性
  • @NotBlank: 校验文本属性不为null或者空格
  • @Positive 和 @PositiveOrZero :校验整数是正数/正数或0
  • @Negative 和 @NegativeOrZero :校验整数是负数/负数或0
  • @Past and @PastOrPresent :校验日期是过去/过去或现在
  • @Future and @FutureOrPresent :校验日期是未来/未来或现在

注意上面的“message”中设置提示错误的信息。

控制器如何生效及如何校验请求参数

@RestController
@RequestMapping("/people")
@Validated //2
public class PersonController {

@PostMapping
public String save(@Valid @RequestBody PersonDto personDto){ //1
return "OK";
}

@GetMapping("/findByAge") //2
public String findByAge(@Range(min = 18,max = 60, message = "年纪只能是18到60之间") Integer age){
return "OK";
}
}

1、校验DTO,只需要在@RequestBody前加上注解“@Valid”,若出现校验错误,抛出MethodArgumentNotValidException

2、检验请求中的参数(包括路径变量),我们需要在类上注解“@Validated”才会生效,若出现校验错误,抛出ConstraintViolationException。此处的@Range注解来自于Hibernate Validator,非标准JSR 380注解。

全局异常处理,给前端友好的校验提示

当出现校验错误时,Spring Boot只会抛出异常,所以为了让前端更友好的处理这些异常,我们将对这些抛出的异常做出处理。

@RestControllerAdvice
public class CustomExceptionHandler {

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, String> validationExceptionHandler(MethodArgumentNotValidException ex) {
Map<String, String> errors = new HashMap<>();
ex.getBindingResult().getAllErrors().forEach((error) -> {
String fieldName = ((FieldError) error).getField();
String errorMessage = error.getDefaultMessage();
errors.put(fieldName, errorMessage);
});
return errors;
}

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(ConstraintViolationException.class)
public String validationExceptionHandler(ConstraintViolationException ex) {

return ex.getMessage();
}
}

验证效果

运行应用,并违反校验规则,如图:

如何自定义检验注解

上面我们使用了JSR 380以及Hibernate的注解来校验,这节我们演示如何自定义校验注解。

我们通过定义个校验注解“@Enumeration”和在“EnumerationValidator”类中定义校验规则。

当前例子演示功能为:只能是枚举里允许的值,否则校验不通过。

  • 注解定义

@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumerationValidator.class) //3
public @interface Enumeration {
String message() default "属性只能从列表中来"; //1
String[] values(); //2
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}

1、message属性定义错误信息

2、values设置可选的枚举值

3、通过“@Constraint”指定校验的类

注意:若没有groups()和payload(),会报:javax.validation.constraintdefinitionexception: hv000074

  • 校验逻辑类

public class EnumerationValidator implements ConstraintValidator<Enumeration,String> {
private String message;
private List<String> allowable;
@Override
public void initialize(Enumeration enumeration){
this.message = enumeration.message();
this.allowable = Arrays.asList(enumeration.values());
}

@Override
public boolean isValid(String value, ConstraintValidatorContext context){
return this.allowable.contains(value);
}
}

这里的逻辑很简单,只需要可选的枚举值包含被校验的值即可。

  • 控制器中,当然也配合了类上注解的“@Validated”

@GetMapping("/findByGender")
public String findByGender(@Enumeration(values = {"男","女"}, message = "性别只能是男或女") String gender){
return "OK";
}

启动验证结果:

感谢对我的书《从企业级开发到云原生微服务:Spring Boot实战》的支持。

参考资料:

https://medium.com/codex/spring-boot-create-custom-annotation-to-validate-request-parameter-dcf483539d90

https://www.baeldung.com/spring-boot-bean-validation

https://reflectoring.io/bean-validation-with-spring-boot/

文章出自:​​爱科学的卫斯理​​,如有转载本文请联系爱科学的卫斯理今日头条号。

责任编辑:武晓燕 来源: 今日头条
相关推荐

2021-08-12 10:32:50

Spring Boot参数校验分组校验

2021-08-10 15:11:27

Spring Boot参数校验

2023-12-04 07:27:54

SpringMVC方法

2021-08-13 08:36:15

SpringMVC自定义

2017-08-03 17:00:54

Springmvc任务执行器

2022-03-07 07:33:24

Spring自定义机制线程池

2020-11-25 11:20:44

Spring注解Java

2022-06-28 14:57:09

FormatterSpring

2018-07-06 15:58:34

SpringSchemaJava

2022-06-27 08:16:34

JSON格式序列化

2021-10-22 14:50:23

Spring BootJava

2023-10-07 14:49:45

2023-09-19 22:41:30

控制器HTTP

2023-03-09 12:04:38

Spring文件校验

2023-10-23 08:18:50

扫描SpringBean

2021-07-13 14:05:37

单点登录页面

2016-08-23 13:21:15

MVC路由视图

2021-03-09 13:18:53

加密解密参数

2022-06-04 12:25:10

解密加密过滤器

2023-11-01 08:01:04

SpringWeb容器
点赞
收藏

51CTO技术栈公众号