Java服务端接口参数校验梳理

1,192次阅读

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

JSR 是 Java Specification Requests 的缩写，即 Java 规范提案。
JSR 303 就是数据检验的一个标准（Bean Validation (JSR 303)）。

处理一段业务逻辑，首先要确保数据输入的正确性，所以需要先对数据进行检查，保证数据在语义上的正确性，再根据数据进行下一步的处理。
前端可以通过 js 程序校验数据是否合法，后端同样也需要进行校验。
而后端最简单的实现就是直接在业务方法中对数据进行处理，但是不同的业务方法可能会出现同样的校验操作，这样就出现了数据的冗余。
为了解决这个情况，JSR 303 出现了。
JSR 303 使用 Bean Validation，即在 Bean 上添加相应的注解，去实现数据校验。
这样在执行业务方法前，都会根据注解对数据进行校验，从而减少自定义的校验逻辑，减少代码冗余。

（1）可以通过简单的注解校验 Bean 属性，比如 @NotNull、@Null 等。
（2）可以通过 Group 分组自定义需要执行校验的属性。
（3）可以自定义注解并指定校验规则。
（4）支持基于 JSR 303 的实现，比如 Hibernate Validator（额外添加一些注解）。

仓库地址: https://github.com/jiajianfa/cool-exec-samples
使用的框架: spring-boot

@RestController
@RequestMapping("/user")
public class UserController {@PostMapping("/create")
    public Result create(@RequestBody UserDTO dto) {if (dto.getId() == null || dto.getName() == null) {return Result.error(false,HttpStatus.BAD_REQUEST.value()," 请求参数错误 ");
        }

        UserVO vo = new UserVO();
        BeanUtils.copyProperties(dto, vo);

        Result result = Result.ok().data(vo);
        return result;
    }
}

@RestController
@RequestMapping("/user")
public class UserController {@PostMapping("/create2")
    public Result createValid(@Validated @RequestBody UserValidDTO dto) {UserVO vo = new UserVO();
        BeanUtils.copyProperties(dto, vo);
        Result result = Result.ok().data(vo);
        return result;
    }
}

@ToString
@Data
public class UserValidDTO extends CommonDTO {@NotNull(message = " 不能为空 ")
    private Long id;

    @NotNull(message = " 不能为空 ")
    private String name;
}

MethodArgumentNotValidException：入参为实体类，参数校验失败抛出的异常 ConstraintViolationException：入参不是实体类，参数校验失败抛出的异常 NotReadablePropertyException：入参为实体类集合，参数校验失败抛出的异常

@RestControllerAdvice
public class GlobalExceptionHandler {private Logger logger = LoggerFactory.getLogger(getClass());

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Result handlerException(Exception e) {logger.error(e.getMessage(), e);
        return Result.error().message(" 系统异常 ");
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @ExceptionHandler(HttpMessageConversionException.class)
    public Result handlerParamException(HttpMessageConversionException e) {logger.error(e.getMessage(), e);
        return Result.error(false, HttpStatus.BAD_REQUEST.value(), " 请求参数格式错误 ");
    }

    @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.substring(0, sb.length() - 2);
        return Result.error(false, HttpStatus.BAD_REQUEST.value(), msg);
    }

    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleConstraintViolationException(ConstraintViolationException ex) {return Result.error(false, HttpStatus.BAD_REQUEST.value(), ex.getMessage());
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @ExceptionHandler(GlobalException.class)
    public Result handlerGlobalException(GlobalException e) {logger.error(e.getMessage(), e);
        return Result.error().message(e.getMessage()).code(e.getCode());
    }
}

规范中都有哪些注解, 适用哪些数据类型
规范的文档地址: https://jakarta.ee/specifications/bean-validation/3.0/jakarta-bean-validation-spec-3.0.html

注解	说明
@Null	被注释的元素必须为 Null
@NotNull	被注释的元素必须不为 Null
@AssertTrue	被注释的元素必须为 True
@AssertFalse	被注释的元素必须为 False
@Min(value)	被注释的元素必须是一个数字（不包含 CharSequence），其值必须大于等于指定的最小值
@Max(value)	被注释的元素必须是一个数字（不包含 CharSequence），其值必须小于等于指定的最大值
@DecimalMin(value)	被注释的元素必须是一个数字（包含 CharSequence），其值必须大于等于指定的最小值
@DecimalMax(value)	被注释的元素必须是一个数字（包含 CharSequence），其值必须小于等于指定的最大值
@Negative	被注释的元素必须是一个正数字
@NegativeOrZero	被注释的元素必须是一个正数字, 或者 0
@Size(max, min)	被注释的元素必须在指定范围内
@Digits(integer, fraction)	被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past	被注释的元素必须是一个过去的日期
@Future	被注释的元素必须是一个将来的日期
@Pattern(value)	被注释的元素必须符合指定的正则表达式
@NotEmpty	被注释的元素必须是一个字符串，不为 null 且非空字符串, 可以是空格字符串
@NotBlank	被注释的元素必须是一个字符串，不为 null 且非空字符串, 且不是空格字符串
@Email	被注释的元素必须是一个字符串，不为 null 且为合法的邮箱地址

不同场景共用同一个实体类，而且校验规则不一样，这时可以使用分组校验
使用时，在对于的注解加上 group 即可，值为定义的类或接口都可以，如 @NotNull(groups = {Update.class})
接口参数列表使用的 @Validated(UserDTO.Save.class)，也要标注用的哪个分组规则

这个时候使用分组校验的代码示例如下：

@ToString
@Data
public class UserValidGroupDTO extends CommonDTO {@NotNull(message = " 不能为空 ",groups = {Update.class})
    private Long id;

    @NotNull(message = " 不能为空 ",groups = {Create.class,Update.class})
    private String name;

    public interface Update{}

    public interface  Create{}}

@PostMapping("/createGrp")
public Result createGrpValid(@Validated(UserGroupValidDTO.Create.class) @RequestBody UserGroupValidDTO dto) {UserVO vo = new UserVO();
    BeanUtils.copyProperties(dto, vo);
    Result result = Result.ok().data(vo);
    return result;
}

@PostMapping("/updateGrp")
public Result updateGrpValid(@Validated(UserGroupValidDTO.Update.class) @RequestBody UserGroupValidDTO dto) {UserVO vo = new UserVO();
    BeanUtils.copyProperties(dto, vo);
    Result result = Result.ok().data(vo);
    return result;
}

@PostMapping("/createNest")
public Result createNestValid(@RequestBody @Validated UserNestValidDTO dto) {UserVO vo = new UserVO();
    BeanUtils.copyProperties(dto, vo);
    Result result = Result.ok().data(vo);
    return result;
}

业务需求总是比框架提供的这些简单校验要复杂的多，我们可以自定义校验来满足我们的需求。
自定义 spring validation 非常方便，假设我们自定义加密 idCardNo（由数字或者 a-f 的字母组成，32-256 长度）校验，
主要分为两步：

1、自定义约束注解

/**
 * @Description 用户身份证号码校验
 * @Author justin
 * @Date 2024/5/14
 */@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {IdCardNoValidator.class})
public @interface IdCardNo {

    /**
     * 默认错误消息
     **/
    String message() default "id 格式错误 ";

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

    /**
     * 负载
     **/
    Class<? extends Payload>[] payload() default {};}

2、实现 ConstraintValidator 接口编写约束校验器

public class IdCardNoValidator implements ConstraintValidator<IdCardNo, String> {

    /**
     * 中国大陆的身份证号码通常由 18 位数字组成，其中最后一位可能是数字或字母 X。* 前 17 位是数字，最后一位是校验码。* 身份证号码的第 7 到第 14 位表示出生年月日，第 17 位表示性别（奇数为男性，偶数为女性）*
     * 这个正则表达式的组成部分说明如下:
     * ^[1-9]：第一位数字不能为 0。* \\d{5}：接下来的 5 位是地址码。* (18|19|20)：年份的前两位数必须是 18, 19 或 20。* \\d{2}：年份的后两位数。* (0[1-9]|1[0-2])：月份，范围是 01 到 12。* (0[1-9]|[12]\\d|3[01])：日期，范围是 01 到 31。* \\d{3}：身份证号码中的顺序码，表示在同一地址码和出生日期下分配的序号。* [0-9Xx]：最后一位是校验码，可以是数字或大写或小写的 X。* $：正则表达式的结束。*/
    private static final String regex = "^[1-9]\\d{5}(18|19|20)\\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])\\d{3}[0-9Xx]$";

    private static final Pattern PATTERN = Pattern.compile(regex);

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {if (value != null) {Matcher matcher = PATTERN.matcher(value);
            return matcher.find();}
        return true;
    }
}

3、使用方法

@ToString
@Data
public class UserCustomizeValidDTO extends CommonDTO {@NotNull(message = " 不能为空 ")
    private Long id;

    @NotNull(message = " 不能为空 ")
    private String name;

    @IdCardNo(message = " 身份证号码格式不正确 ")
    private String idCardNo;
}

快速失败(Fail Fast)
Spring Validation 默认会校验完所有字段，然后才抛出异常。
可以通过一些简单的配置，开启 Fali Fast 模式，一旦校验失败就立即返回

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

编码校验

@Autowired
private javax.validation.Validator globalValidator;

Set<ConstraintViolation<UserValidDTO>> validate = globalValidator.validate(dto);
// 如果校验通过，validate 为空；否则，validate 包含未校验通过项
if (validate.isEmpty()) {// 校验通过，才会执行业务逻辑处理} else {for (ConstraintViolation<UserValidDTO> userDTOConstraintViolation : validate) {
        // 校验失败，做其它逻辑
        log.info(userDTOConstraintViolation.getMessage());
    }
}

集合校验
如果请求体直接传递了 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();
    }
}

区别	@Valid	@Validated
提供者	JSR-303 规范	Spring
是否支持分组	不支持	支持
标注位置	Method、Field、Constructor、Paraneter	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()的实现, 可以看出，最终发现底层最终还是调用了 Hibernate Validator 进行真正的校验处理。

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

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 只是做了一层封装。

在实际业务开发过程中, 规范中的和框架扩展的基本满足大部分需求开发, 但也有一些场景是这些基本注解解决不了的，
只能用一些其他的方式处理，这样就导致参数校验变成了多层，其实是不利于代码维护的。
于是, 在撸了若干个项目之后, 封装了一套基于 SpEL 表达的参数校验工具

他有如下特性:

@SpelAssert(assertTrue = " T(cn.sticki.enums.UserStatusEnum).getByCode(#this.userStatus) != null ", message = " 用户状态不合法 ")
private Integer userStatus;

@NotNull
private Integer contentType;

@SpelNotNull(condition = "#this.contentType == 1", message = " 语音内容不能为空 ")
private Object audioContent;

@SpelNotNull(condition = "#this.contentType == 2", message = " 视频内容不能为空 ")
private Object videoContent;

// 中文算两个字符，英文算一个字符，要求总长度不超过 10
// 调用外部静态方法进行校验
@SpelAssert(assertTrue = "T(cn.sticki.util.StringUtil).getLength(#this.userName) <= 10", message = " 用户名长度不能超过 10")
private String userName;

// 这里只是简单举例，实际开发中不建议这样判断用户是否存在
@SpelAssert(assertTrue = "@userService.getById(#this.userId) != null", message = " 用户不存在 ")
private Long userId;

强大的参数校验功能，几乎支持所有场景下的参数校验。
扩展自 javax.validation 包，只新增不修改，无缝集成到项目中。
基于 SpEL（Spring Expression Language）表达式，支持复杂的校验逻辑。
支持调用 Spring Bean，可在表达式中使用注入过的 Spring Bean。
校验时基于整个对象，支持对象内字段间的校验逻辑。
支持自定义校验注解，可根据业务需求自定义校验逻辑。
无需额外的异常处理，校验失败时会上报到 javax.validation 的异常体系中。
简单易用，使用方式几乎与 javax.validation 一致，学习成本低，上手快。

开源的项目地址:
https://github.com/jiajianfa/spel-validator
https://github.com/jiajianfa/spel-validator-example

如果分享对于你有帮助的话, 欢迎关注我的公众号, 获取更多内容~~~
Java 服务端接口参数校验梳理