关于java:Spring-Boot-实现各种参数校验附项目源码

33次阅读

共计 12310 个字符，预计需要花费 31 分钟才能阅读完成。

<img src=”http://www.image.jincou.com/edce5ed39f5e400a9a11cc75e7a659f2″ width=”700″ height=”404″>

本文会具体介绍 Spring Validation 各种场景下的最佳实际及其实现原理，死磕到底！

我的项目源码：spring-validation

一、简略应用

Java API 标准 (JSR303) 定义了 Bean 校验的规范 validation-api，但没有提供实现。hibernate validation 是对这个标准的实现，并减少了校验注解如 @Email、@Length 等。

Spring Validation 是对 hibernate validation 的二次封装，用于反对 spring mvc 参数主动校验。接下来，咱们以 spring-boot 我的项目为例，介绍 Spring Validation 的应用。

1、引入依赖

如果 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 的参数校验实战！

2、requestBody 参数校验

POST、PUT 申请个别会应用 requestBody 传递参数，这种状况下，后端应用 DTO 对象 进行接管。

只有给 DTO 对象加上 @Validated 注解就能实现主动参数校验。

比方，有一个保留 User 的接口，要求 userName 长度是 2 -10，age 在 1 到 99 之间。如果校验失败，会抛出 MethodArgumentNotValidException 异样，Spring 默认会将其转为 400（Bad Request）申请。

  • 在 DTO 字段上申明束缚注解
@Data
public class UserDTO {

    @NotNull
    private Long userId;

    @Length(min = 2, max = 10)
    private String userName;
  
    @Min(1)
    @Max(99)
    private int age;
  • 在办法参数上申明校验注解
  @PostMapping("/save")
    public Result saveUser(@RequestBody @Validated UserQO userDTO) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}

这种状况下，应用 @Valid 和 @Validated 都能够。

3、requestParam 参数校验

GET 申请个别会应用 requestParam/PathVariable 传参。如果参数比拟多(比方超过 6 个)，还是举荐应用 DTO 对象接管。否则，举荐将一个个参数平铺到办法入参中。

在这种状况下，必须在 Controller 类上标注 @Validated 注解，并在入参上申明束缚注解 (如 @Min 等)。如果校验失败，会抛出ConstraintViolationException 异样。

@RequestMapping("/api/user")
@RestController
@Validated
public class UserController {
    // 门路变量
    @GetMapping("{userId}")
    public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}

    // 查问参数
    @GetMapping("getByUserName")
    public Result getByUserName(@Length(min = 6, max = 20) @NotNull String  userName) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}
}

4、对立异样解决

后面说过，如果校验失败，会抛出 MethodArgumentNotValidException 或者 ConstraintViolationException 异样。在理论我的项目开发中，通常会用 对立异样解决 来返回一个更敌对的提醒。比方咱们零碎要求无论发送什么异样，http 的状态码必须返回 200，由业务码去辨别零碎的异常情况。

@RestControllerAdvice
@Slf4j
public class CommonExceptionHandler {@ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {BindingResult bindingResult = ex.getBindingResult();
        StringJoiner joiner = new StringJoiner(",");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {joiner.add(fieldError.getField()).add(":").add(fieldError.getDefaultMessage());
        }
        String msg = joiner.toString();
       return Result.fail(BusinessCode.MISSING_PARAMETERS, msg);
    }

    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleConstraintViolationException(ConstraintViolationException ex) {return Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
    }

    @ExceptionHandler({NotReadablePropertyException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleNotReadablePropertyException(NotReadablePropertyException ex) {return Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
    }


    @ExceptionHandler({Exception.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleException(Exception ex) {log.error("未知零碎谬误", ex);
        return Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
    }
}

二、进阶应用

1、分组校验

在理论我的项目中，可能多个办法须要应用同一个 DTO 类来接管参数，而不同办法的校验规定很可能是不一样的。这个时候，简略地在 DTO 类的字段上加束缚注解无奈解决这个问题。因而，spring-validation 反对了 分组校验 的性能，专门用来解决这类问题。还是下面的例子，比方保留 User 的时候，userId 是可空的，然而更新 User 的时候，UserId 的值不能为空；其它字段的校验规定在两种状况下一样。这个时候应用 分组校验 的代码示例如下：

@Data
public class UserDTO {@NotNull(groups = Update.class)
    @Null(groups = Save.class)
    private Long userId;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 2, max = 10, groups = {Save.class, Update.class})
    private String userName;

    @Min(value = 1, groups = {Save.class, Update.class})
    @Max(value = 99, groups = {Save.class, Update.class})
    private int age;

    /**
     * 保留的时候校验分组
     */
    public interface Save { }

    /**
     * 更新的时候校验分组
     */
    public interface Update {}}
  • @Validated 注解上指定校验分组
    @PostMapping("/save")
    public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}

    @PostMapping("/update")
  public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}

优化，失常咱们如果一个 DTO 进行通用的话，个别就相似userId，保留和更新不一样，其它都会一样，所以没必要每个属性都要加 groups = {Save.class, Update.class})。咱们能够这样

@Data
public class UserGroupsDTO {@NotNull(groups = Update.class)
    @Null(groups = Save.class)
    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @Min(1)
    @Max(99)
    private int age;
}

咱们只须要 userId 分组就能够了，其它不必分组。

接口申请也略微批改下

    @PostMapping("/save")
    public Result saveUser(@RequestBody @Validated({UserDTO.Save.class, Default.class}) UserDTO userDTO) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}


    @PostMapping("/update")
    public Result updateUser(@RequestBody @Validated({UserDTO.Update.class, Default.class}) UserDTO userDTO) {
        // 校验通过，才会执行业务逻辑解决
        return Result.success();}

只有在分组这里多传入一个默认分组 Default.class 就能够，是不是比下面要简便些。

2、嵌套校验

后面的示例中，DTO类外面的字段都是 根本数据类型 和String类型。然而理论场景中，有可能某个字段也是一个对象，这种状况先，能够应用 嵌套校验 。比方，下面保留User 信息的时候同时还带有 Interest 信息。须要留神的是，

此时 DTO 类的对应字段必须标记 @Valid 注解。

@Data
public class UserGroupsDTO {@NotNull(groups = Update.class)
    @Null(groups = Save.class)
    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @Min(1)
    @Max(99)
    private int age;

    @NotNull
    @Valid
    private Interest interest;

    /**
     * 趣味实体
     */
    @Data
    public static class Interest {@Min(1)
        private Long interestId;

        @NotNull
        @Length(min = 2, max = 10)
        private String interestName;
    }

    /**
     * 保留的时候校验分组
     */
    public interface Save { }

    /**
     * 更新的时候校验分组
     */
    public interface Update {}}

嵌套校验能够联合分组校验一起应用。还有就是 嵌套汇合校验 会对汇合外面的每一项都进行校验，例如 List\<Job\> 字段会对这个 list 外面的每一个 Interest 对象都进行校验。

3、汇合校验

如果申请体间接传递了 json 数组给后盾，并心愿对数组中的每一项都进行参数校验。此时，如果咱们间接应用 java.util.Collection 下的 list 或者 set 来接收数据，参数校验并不会失效！咱们能够应用自定义 list 汇合来接管参数：

@Data
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.success();}

4、自定义校验

业务需要总是比框架提供的这些简略校验要简单的多，咱们能够自定义校验来满足咱们的需要。自定义spring validation 非常简单，假如咱们自定义sex（性别只有 man 跟 woman）校验，次要分为两步：

  • 自定义束缚注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {SexValidator.class})
public @interface Sex {

    // 默认谬误音讯
    String message() default "性别格局格局谬误";

    // 分组
    Class<?>[] groups() default {};

    // 负载
    Class<? extends Payload>[] payload() default {};}
  • 实现 ConstraintValidator 接口编写束缚校验器
public class SexValidator implements ConstraintValidator<Sex, String> {

    private static final String MAN = "man";
    private static final String WOMAN = "woman";

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 不为 null 才进行校验
        if (value != null) {if(!Objects.equals(value,MAN) && !Objects.equals(value,WOMAN)) {return Boolean.FALSE;}
        }
        return Boolean.TRUE;
    }
}

这样咱们就能够应用 @Sex 进行参数校验了！

5、编程式校验

下面的示例都是基于 注解 来实现主动校验的，在某些状况下，咱们可能心愿以 编程形式 调用验证。这个时候能够注入 javax.validation.Validator 对象，而后再调用其api。

    @Autowired
    private javax.validation.Validator globalValidator;

    // 编程式校验
    @PostMapping("/saveWithCodingValidate")
    @ApiOperation("编程式校验")
    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.success();}

6、疾速失败(Fail Fast)

Spring Validation 默认会校验完所有字段，而后才抛出异样。能够通过一些简略的配置，开启 Fali Fast 模式，一旦校验失败就立刻返回。

@Bean
public Validator validator() {ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
            .configure()
            // 疾速失败模式
            .failFast(true)
            .buildValidatorFactory();
    return validatorFactory.getValidator();}

7、@Valid 和 @Validated 区别

区别 @Valid @Validated
提供者 JSR-303 标准 Spring
是否反对分组 不反对 反对
标注地位 METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE TYPE, METHOD, PARAMETER
嵌套校验 反对 不反对

三、实现原理

1、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() 实现。

@Override
public void validate(Object target, Errors errors, Object... validationHints) {if (this.targetValidator != null) {
        processConstraintViolations(
            // 此处调用 Hibernate Validator 执行真正的校验
            this.targetValidator.validate(target, asValidationGroups(validationHints)), errors);
    }
}

最终发现底层最终还是调用了Hibernate Validator 进行真正的校验解决。

2、办法级别的参数校验实现原理

下面提到的将参数一个个平铺到办法参数中，而后在每个参数后面申明 束缚注解 的校验形式，就是办法级别的参数校验。实际上，这种形式可用于任何 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 只是做了一层封装。

感激

这篇文章基本上来自 https://juejin.cn/post/685654…

本人只是跟着做了个 demo，批改了其中个别的谬误。

本文由博客一文多发平台 OpenWrite 公布！

正文完
java
发表至： java
2021-12-03
 0
SpringBoot整合MyBatisPlus
关于spring:SpringMVC-九大组件之-ViewResolver-深入分析
关于java:Podman-已成-Linux-官方标配Docker-没戏了
关于java:Enum使用name还是toString方法