springboot参数校验处理

最新推荐文章于 2025-02-17 16:23:32 发布

原创最新推荐文章于 2025-02-17 16:23:32 发布 · 307 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring

框架相关专栏收录该内容

6 篇文章

订阅专栏

这篇博客介绍了如何在SpringBoot中使用@Validated和@Valid进行参数校验，包括对ConstraintViolationException的全局处理，实体类接收多个参数的方法，以及如何捕获并处理BindException。同时，博主分享了自定义校验器的创建过程，包括自定义注解和实现逻辑，以避免参数校验时的重复if判断。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

为了避免重复的if判断参数，记一次使用Validation来做参数校验

使用@Validated进行校验，并对异常进行处理

/**
 * @author ginwu
 * @since 2020/8/1
 */
@RestController
@RequestMapping("/v")
@Validated
public class TestController {

    @GetMapping("/t1")
    public String test1(@NotEmpty(message = "参数不能为空") String name) {
        return name;
    }

}

对ConstraintViolationException进行全局处理，并调用getConstraintViolations或者toString方法对结果进行处理

@ControllerAdvice
@Order(-1)
public class GlobalExceptionHandler {

    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseStatus(value = HttpStatus.OK)
    @ResponseBody
    public Set<String> handleValidationExceptions(ConstraintViolationException ex) {
        Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
        return constraintViolations.stream().map(ConstraintViolation::getMessage).collect(Collectors.toSet());
    }
}

当参数过多时需要实体类接收处理，需要用到@Valid

/**
 * @author ginwu
 * @since 2020/8/1
 */
@RestController
@RequestMapping("/v")
@Validated
public class TestController {

    @GetMapping("/t1")
    public String test1(@NotEmpty(message = "参数不能为空") String name) {
        return name;
    }

    @GetMapping("/t2")
    public Foo test2(@Valid Foo foo) {
        return foo;
    }

}

Foo.java

@Data
public class Foo {

    @Max(value = 20,message = "最大不能超过20")
    @Min(value = 1,message = "最小不能低于1")
    @NotNull(message = "age不能为空")
    private Integer age;

    @Size(min = 2,max = 30,message = "参数错误")
    @NotEmpty(message = "name不能为空")
    private String name;

    @Pattern(regexp = "man|woman")
    @NotEmpty(message = "sex不能为空")
    private String sex;
}

对@Valid需要BindException进行捕获处理

@ControllerAdvice
@Order(-1)
public class GlobalExceptionHandler {

    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseStatus(value = HttpStatus.OK)
    @ResponseBody
    public Set<String> handleValidationExceptions(ConstraintViolationException ex) {
        Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
        return constraintViolations.stream().map(ConstraintViolation::getMessage).collect(Collectors.toSet());
    }

    @ExceptionHandler(BindException.class)
    @ResponseStatus(value = HttpStatus.OK)
    @ResponseBody
    public Set<String> handleBindingResultValidationExceptions(BindException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        return allErrors.stream().map(ObjectError::getDefaultMessage).collect(Collectors.toSet());
    }

}

自定义校验器

自定义注解

@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = ValidtorImpl.class)
public @interface IDCard {

    String message() default "参数错误";

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

    Class<? extends Payload>[] payload() default {};

}

具体实现逻辑

public class ValidtorImpl implements ConstraintValidator<IDCard,Object> {
    @Override
    public void initialize(IDCard constraintAnnotation) {

    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        //校验逻辑
        return IDCardUtils.check(o.toString());
    }
}

测试

@GetMapping("/t3")
    public String test3(@IDCard(message = "输入不合法") String idCard) {
        return idCard;
    }