Spring Boot 实现各种参数校验，写得太好了，发起收藏！

手机软件开发 · 2024-9-29 02:30:03

简朴使用

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，则必要手动引入依赖：
<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.1.Final</version></dependency>对于web服务来说，为防止非法参数对业务造成影响，在Controller层肯定要做参数校验的！大部门环境下，请求参数分为如下两种情势：

POST、PUT请求，使用requestBody通报参数；
GET请求，使用requestParam/PathVariable通报参数。

下面我们简朴先容下requestBody和requestParam/PathVariable的参数校验实战！
requestBody参数校验

POST、PUT请求一样寻常会使用requestBody通报参数，这种环境下，后端使用DTO对象进行吸取。只要给DTO对象加上@Validated注解就能实现自动参数校验。好比，有一个生存User的接口，要求userName长度是2-10，account和password字段长度是6-20。
假如校验失败，会抛出MethodArgumentNotValidException非常，Spring默认会将其转为400（Bad Request）请求。

DTO表现数据传输对象（Data Transfer Object），用于服务器和客户端之间交互传输使用的。在spring-web项目中可以表现用于吸取请求参数的Bean对象。

在DTO字段上声明束缚注解
@Datapublic class UserDTO { private Long userId; @NotNull @Length(min = 2, max = 10) private String userName; @NotNull @Length(min = 6, max = 20) private String account; @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传参。假如参数比力多(好比凌驾6个)，还是保举使用DTO对象吸取。
否则，保举将一个个参数平铺到方法入参中。在这种环境下，必须在Controller类上标注@Validated注解，并在入参上声明束缚注解(如@Min等)。假如校验失败，会抛出ConstraintViolationException非常。
代码示比方下：
@RequestMapping("/api/user")@RestController@Validatedpublic class UserController { // 路径变量 @GetMapping("{userId}") public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {       // 校验通过，才会实验业务逻辑处理惩罚       UserDTO userDTO = new UserDTO();       userDTO.setUserId(userId);       userDTO.setAccount("11111111111111111");       userDTO.setUserName("xixi");       userDTO.setAccount("11111111111111111");       return Result.ok(userDTO); } // 查询参数 @GetMapping("getByAccount") public Result getByAccount(@Length(min = 6, max = 20) @NotNull String  account) {       // 校验通过，才会实验业务逻辑处理惩罚       UserDTO userDTO = new UserDTO();       userDTO.setUserId(10000000000000003L);       userDTO.setAccount(account);       userDTO.setUserName("xixi");       userDTO.setAccount("11111111111111111");       return Result.ok(userDTO); }}同一非常处理惩罚

前面说过，假如校验失败，会抛出MethodArgumentNotValidException大概ConstraintViolationException非常。在现实项目开发中，通常会用同一非常处理惩罚来返回一个更友爱的提示。
好比我们体系要求无论发送什么非常，http的状态码必须返回200，由业务码去区分体系的非常环境。
@RestControllerAdvicepublic 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(BusinessCode.参数校验失败, msg); } @ExceptionHandler({ConstraintViolationException.class}) @ResponseStatus(HttpStatus.OK) @ResponseBody public Result handleConstraintViolationException(ConstraintViolationException ex) {       return Result.fail(BusinessCode.参数校验失败, ex.getMessage()); }}进阶使用

分组校验

在现实项目中，大概多个方法必要使用同一个DTO类来吸取参数，而不同方法的校验规则很大概是不一样的。这个时间，简朴地在DTO类的字段上加束缚注解无法办理这个标题。因此，spring-validation支持了分组校验的功能，专门用来办理这类标题。
还是上面的例子，好比生存User的时间，UserId是可空的，但是更新User的时间，UserId的值必须>=10000000000000000L；别的字段的校验规则在两种环境下一样。这个时间使用分组校验的代码示比方下：
束缚注解上声明实用的分组信息groups
@Datapublic 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 account; @NotNull(groups = {Save.class, Update.class}) @Length(min = 6, max = 20, groups = {Save.class, Update.class}) private String password; /**    * 生存的时间校验分组    */ public interface Save { } /**    * 更新的时间校验分组    */ public interface Update { }}@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信息的时间同时还带有Job信息。必要留意的是，此时DTO类的对应字段必须标志@Valid注解。
@Datapublic 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 account; @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 Job job; @Data public static class Job {       @Min(value = 1, groups = Update.class)       private Long jobId;       @NotNull(groups = {Save.class, Update.class})       @Length(min = 2, max = 10, groups = {Save.class, Update.class})       private String jobName;       @NotNull(groups = {Save.class, Update.class})       @Length(min = 2, max = 10, groups = {Save.class, Update.class})       private String position; } /**    * 生存的时间校验分组    */ public interface Save { } /**    * 更新的时间校验分组    */ public interface Update { }}嵌套校验可以连合分组校验一起使用。另有就是嵌套聚集校验会对聚集内里的每一项都进行校验，比方List<Job>字段会对这个list内里的每一个Job对象都进行校验
聚集校验

假如请求体直接通报了json数组给配景，并渴望对数组中的每一项都进行参数校验。此时，假如我们直接使用java.util.Collection下的list大概set来吸取数据，参数校验并不会收效！我们可以使用自界说list聚集来吸取参数：
包装List范例，并声明@Valid注解
public class ValidationList<E> implements List<E> { @Delegate // @Delegate是lombok注解 @Valid // 肯定要加@Valid注解 public List<E> list = new ArrayList<>(); // 肯定要记得重写toString方法 @Override public String toString() {       return list.toString(); }}@Delegate注解受lombok版本限定，1.18.6以上版本可支持。假如校验不通过，会抛出NotReadablePropertyException，同样可以使用同一非常进行处理惩罚。
好比，我们必要一次性生存多个User对象，Controller层的方法可以这么写：
@PostMapping("/saveList")public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) { // 校验通过，才会实验业务逻辑处理惩罚 return Result.ok();}自界说校验

业务需求总是比框架提供的这些简朴校验要复杂的多，我们可以自界说校验来满意我们的需求。
自界说spring validation非常简朴，假设我们自界说加密id（由数字大概a-f的字母构成，32-256长度）校验，主要分为两步：
自界说束缚注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})@Retention(RUNTIME)@Documented@Constraint(validatedBy = {EncryptIdValidator.class})public @interface EncryptId { // 默认错误消息 String message() default "加密id格式错误"; // 分组 Class<?>[] groups() default {}; // 负载 Class<? extends Payload>[] payload() default {};}实现ConstraintValidator接口编写束缚校验器
public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> { private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$"); @Override public boolean isValid(String value, ConstraintValidatorContext context) {       // 不为null才进行校验       if (value != null) {          Matcher matcher = PATTERN.matcher(value);          return matcher.find();       }       return true; }}如许我们就可以使用@EncryptId进行参数校验了！
编程式校验

上面的示例都是基于注解来实现自动校验的，在某些环境下，我们大概渴望以编程方式调用验证。这个时间可以注入javax.validation.Validator对象，然后再调用其api。
@Autowiredprivate javax.validation.Validator globalValidator;// 编程式校验@PostMapping("/saveWithCodingValidate")public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) { Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class); // 假如校验通过，validate为空；否则，validate包罗未校验通过项 if (validate.isEmpty()) {       // 校验通过，才会实验业务逻辑处理惩罚 } else {       for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {          // 校验失败，做别的逻辑          System.out.println(userDTOConstraintViolation);       } } return Result.ok();}快速失败(Fail Fast)

Spring Validation默认会校验完全部字段，然后才抛出非常。可以通过一些简朴的设置，开启Fali Fast模式，一旦校验失败就立刻返回。
@Beanpublic Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)          .configure()          // 快速失败模式          .failFast(true)          .buildValidatorFactory(); return validatorFactory.getValidator();}@Valid和@Validated区别

实现原理

requestBody参数校验实现原理

在spring-mvc中，RequestResponseBodyMethodProcessor是用于剖析@RequestBody标注的参数以及处理惩罚@ResponseBody标注方法的返回值的。显然，实验参数校验的逻辑肯定就在剖析参数的方法resolveArgument()中：
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor { @Override public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,                               NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {       parameter = parameter.nestedIfOptional();       //将请求数据封装到DTO对象中       Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());       String name = Conventions.getVariableNameForParameter(parameter);       if (binderFactory != null) {          WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);          if (arg != null) {             // 实验数据校验             validateIfApplicable(binder, parameter);             if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {                   throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());             }          }          if (mavContainer != null) {             mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());          }       }       return adaptArgumentIfNecessary(arg, parameter); }}可以看到，resolveArgument()调用了validateIfApplicable()进行参数校验。
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) { // 获取参数注解，好比@RequestBody、@Valid、@Validated Annotation[] annotations = parameter.getParameterAnnotations(); for (Annotation ann : annotations) {       // 先实验获取@Validated注解       Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);       //假如直接标注了@Validated，那么直接开启校验。       //假如没有，那么判定参数前是否有Valid起头的注解。       if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {          Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));          Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});          //实验校验          binder.validate(validationHints);          break;       } }}看到这里，各人应该能明白为什么这种场景下@Validated、@Valid两个注解可以混用。我们接下来继承看WebDataBinder.validate()实现。
@Overridepublic void validate(Object target, Errors errors, Object... validationHints) { if (this.targetValidator != null) {       processConstraintViolations(          //此处调用Hibernate Validator实验真正的校验          this.targetValidator.validate(target, asValidationGroups(validationHints)), errors); }}终极发现底层终极还是调用了Hibernate Validator进行真正的校验处理惩罚。
方法级别的参数校验实现原理

上面提到的将参数一个个平铺到方法参数中，然后在每个参数前面声明束缚注解的校验方式，就是方法级别的参数校验。
现实上，这种方式可用于任何Spring Bean的方法上，好比Controller/Service等。其底层实现原理就是AOP，详细来说是通过MethodValidationPostProcessor动态注册AOP切面，然后使用MethodValidationInterceptor对切点方法织入增强。
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean { @Override public void afterPropertiesSet() {       //为全部`@Validated`标注的Bean创建切面       Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);       //创建Advisor进行增强       this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator)); } //创建Advice，本质就是一个方法拦截器 protected Advice createMethodValidationAdvice(@Nullable Validator validator) {       return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor()); }}接着看一下MethodValidationInterceptor：
public class MethodValidationInterceptor implements MethodInterceptor { @Override public Object invoke(MethodInvocation invocation) throws Throwable {       //无需增强的方法，直接跳过       if (isFactoryBeanMetadataMethod(invocation.getMethod())) {          return invocation.proceed();       }       //获取分组信息       Class<?>[] groups = determineValidationGroups(invocation);       ExecutableValidator execVal = this.validator.forExecutables();       Method methodToValidate = invocation.getMethod();       Set<ConstraintViolation<Object>> result;       try {          //方法入参校验，终极还是委托给Hibernate Validator来校验          result = execVal.validateParameters(             invocation.getThis(), methodToValidate, invocation.getArguments(), groups);       }       catch (IllegalArgumentException ex) {          ...       }       //有非常直接抛出       if (!result.isEmpty()) {          throw new ConstraintViolationException(result);       }       //真正的方法调用       Object returnValue = invocation.proceed();       //对返回值做校验，终极还是委托给Hibernate Validator来校验       result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);       //有非常直接抛出       if (!result.isEmpty()) {          throw new ConstraintViolationException(result);       }       return returnValue; }}现实上，不管是requestBody参数校验还是方法级别的校验，终极都是调用Hibernate Validator实验校验，Spring Validation只是做了一层封装。

Spring Boot 实现各种参数校验，写得太好了，发起收藏！

所属分类: 问答交流

新帖推荐: 30日

推荐作品