Spring Boot的参数校验使用方法

最新推荐文章于 2024-07-26 14:31:54 发布

iQM75

最新推荐文章于 2024-07-26 14:31:54 发布

阅读量1.5k

点赞数 35

分类专栏： Spring Boot实战文章标签： java 数据库前端 spring boot spring 后端

本文链接：https://blog.csdn.net/2301_76419561/article/details/140609131

版权

Spring Boot实战专栏收录该内容

33 篇文章 2 订阅

订阅专栏

博客主页: 南来_北往

🔥系列专栏：Spring Boot实战

前言

Spring Boot参数校验的使用方法主要包括引入依赖、使用注解进行标注、在Controller层进行校验、以及定义异常处理类来处理校验异常等步骤。以下是具体说明：
引入依赖：需要引入spring-boot-starter-validation依赖，以获得参数校验的功能支持。
使用注解进行标注：在需要进行校验的参数上添加相应的校验注解，如@NotNull、@Min、@Max等，来指明参数的合法性要求。
在Controller层进行校验：在Controller层使用@Validated注解开启校验功能，同时在需要校验的参数前加上@Valid注解，这样当方法被调用时，就会对参数进行校验。
定义异常处理类处理校验异常：通过定义异常处理类并使用@ExceptionHandler注解来处理方法参数校验异常（MethodArgumentNotValidException），在异常处理类中可以获取校验错误信息，并进行适当的处理。
此外，在进行自定义校验规则时，可以实现一个自定义注解和一个对应的Validator，并在需要应用自定义校验规则的地方使用该注解。Spring Boot会自动调用相应的Validator进行校验。
总的来说，使用Spring Boot进行参数校验，能够有效地提高接口的安全性和稳定性，防止非法参数导致的程序异常。通过合理定义参数校验规则并对非法参数做出适当的处理，可以在保证接口健壮性的同时，提升用户体验。

简单使用

在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及以上版本，这一自动传递的便利不复存在，此时便需开发者自行在项目的依赖列表中明确指定hibernate-validator的引入，以确保验证机制的正确运行。

<dependency>  
    <groupId>org.hibernate</groupId>  
    <artifactId>hibernate-validator</artifactId>  
    <version>6.0.1.Final</version>  
</dependency>

在构建Web服务时，确保接口不受不当参数影响是至关重要的。因此，在Controller层实施严格的参数校验是开发过程中的必要步骤。通常，请求参数可通过以下两种方式提交：
1、POST、PUT请求，通过requestBody机制传输数据；
2、GET请求，则多通过requestParam或PathVariable方式指定参数。

接下来，本文将详细讲解如何针对requestBody以及requestParam/PathVariable这两种参数传递方式进行精确的校验操作。

requestBody参数校验

在处理POST和PUT请求时，通常采用requestBody方式传递参数，此时后端通过数据传递对象（DTO）作为接收载体。为实现参数的自动校验功能，仅需在DTO类上添加@Validated注解。例如，设想一个用于保存用户信息的接口，其中用户名称（userName）的长度需控制在2至10字符，同时账号（account）与密码（password）的长度均需介于6至20字符之间。若参数校验未能通过，系统将引发MethodArgumentNotValidException异常，并由Spring框架默认处理为HTTP 400（Bad Request）响应。

数据传输对象（DTO），即Data Transfer Object，承担着服务端与客户端之间数据交互的重要角色。在基于spring-web的项目中，DTO通常被用作接收请求参数的Bean实体。

通过对DTO中各字段施加相应的约束注解，可以精确控制参数的校验规则。

@Data  
public 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方式进行参数传递。当参数数量较多（例如超过六个）时，建议使用数据传输对象（DTO）作为接收载体。若参数较少，则推荐直接将各个参数作为方法的入参进行处理。在此情形下，必须在Controller类上标注@Validated注解，并在入参上声明约束注解 (如@Min等)。如果校验失败，会抛出ConstraintViolationException异常。代码示例如下：

@RequestMapping("/api/user")  
@RestController  
@Validated  
public 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，而通过业务代码来区分和指示不同的系统异常状态。

@RestControllerAdvice  
public 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引入了分组校验机制，旨在解决此类复杂场景下的校验问题。

以用户信息处理为例，假设在创建用户时，用户ID（UserId）可以空缺，但在更新用户信息时，该ID必须存在且大于特定的数值，例如10000000000000000。与此同时，其他字段在不同操作中的校验标准保持一致。针对这种需求，分组校验便能展现其灵活性和精准性。

通过在约束注解中明确指定适用的分组信息（groups），便可以实现特定业务场景下的精确校验，从而确保数据处理的准确性和安全性。

@Data  
public 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）中的基本信息单元，即基本数据类型和字符串类型字段的校验。然而，在更加复杂的业务场景下，DTO类可能不仅包含基础字段，还涉及到其他对象的嵌套。在这样的情况下，我们可以采用层级化的嵌套校验策略。

例如，在处理用户信息的保存过程中，如果同时需要处理与之相关的职业（Job）信息，这就涉及到了一个复杂的数据结构。关键在于，对于DTO中对应于该对象类型的字段，必须显式标注@Valid注解，以确保嵌套对象的数据也同样符合预设的校验规则。

通过这种方式，我们可以确保每一块数据，无论是独立的基础字段还是作为对象一部分的复杂信息，都能得到恰当和严格的验证处理，从而提升整体数据的有效性与准确性。

@Data  
public 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对象执行严格的校验过程。

这种方法论不仅确保了代码的整洁和逻辑的清晰，还大大提高了数据处理流程中的可靠性和准确性，为高质量的软件开发奠定了坚实的基础。

集合校验

在处理由前端直接传递的JSON数组时，若期望对数组中的每个元素实施参数校验，单纯依靠Java的Collection框架下的List或Set类型来接收数据，将无法触发预期的校验机制。为了确保校验过程得以执行，我们可以设计一个自定义的列表结构，通过在其中加入@Valid注解来实现对列表内每个元素的系统校验。

这种做法不仅保障了数据的整体有效性，还提升了代码的适应性和可维护性，为后端数据处理提供了一种既直观又高效的解决方案。

public class ValidationList<E> implements List<E> {  
  
    @Delegate  
    @Valid  
    public List<E> list = new ArrayList<>();  
  
    @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进行校验，该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) {  
  
        if (value != null) {  
            Matcher matcher = PATTERN.matcher(value);  
            return matcher.find();  
        }  
        return true;  
    }  
}

这样我们就可以使用@EncryptId进行参数校验了！

编程式校验

上面的示例都是基于注解来实现自动校验的，在某些情况下，我们可能希望以编程方式调用验证。这个时候可以注入javax.validation.Validator对象，然后再调用其api。

@Autowired  
private javax.validation.Validator globalValidator;  
  
@PostMapping("/saveWithCodingValidate")  
public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) {  
    Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);  
  
    if (validate.isEmpty()) {  
  
    } else {  
        for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {  
  
            System.out.println(userDTOConstraintViolation);  
        }  
    }  
    return Result.ok();  
}

快速失败 (Fail Fast)

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

@Bean  
public 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();  
  
        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) {  
  
    Annotation[] annotations = parameter.getParameterAnnotations();  
    for (Annotation ann : annotations) {  
  
        Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);  
  
        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(  
  
            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() {  
  
        Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);  
  
        this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));  
    }  
  
    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 {  
  
            result = execVal.validateParameters(  
                invocation.getThis(), methodToValidate, invocation.getArguments(), groups);  
        }  
        catch (IllegalArgumentException ex) {  
            ...  
        }  
  
        if (!result.isEmpty()) {  
            throw new ConstraintViolationException(result);  
        }  
  
        Object returnValue = invocation.proceed();  
  
        result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);  
  
        if (!result.isEmpty()) {  
            throw new ConstraintViolationException(result);  
        }  
        return returnValue;  
    }  
}

实际上，不管是requestBody参数校验还是方法级别的校验，最终都是调用Hibernate Validator执行校验，Spring Validation只是做了一层封装。

iQM75

关注

35
点赞
踩
23

收藏

觉得还不错? 一键收藏
1
评论
Spring Boot的参数校验使用方法

Spring Boot参数校验的使用方法主要包括引入依赖、使用注解进行标注、在Controller层进行校验、以及定义异常处理类来处理校验异常等步骤。以下是具体说明：引入依赖：需要引入spring-boot-starter-validation依赖，以获得参数校验的功能支持。使用注解进行标注：在需要进行校验的参数上添加相应的校验注解，如@NotNull、@Min、@Max等，来指明参数的合法性要求。
复制链接

扫一扫