全栈开发那些事

全栈开发那些事

SpringBoot参数校验,告别if else

2024-06-24
SpringBoot参数校验,告别if else

1、参数校验简介

在实际工作中,得到数据得到的第一步就是校验数据的正确性,如果存在录入上的问题,一般会通过注解校验,发现错误后返回给用户,但是对于一些逻辑上的错误,比如购买金额=购买数量\times 单价,这样的规则就很难使用注解方式验证了,此时可以使用Spring提供的验证器(Validator)规则去验证。由于Validator框架通过硬编码完成数据校验,在实际开发中会显得比较麻烦,因此现在开发更加推荐使用JSR 303完成服务端的数据校验。

Spring3开始支持JSR 303验证框架,JSR 303是Java为Bean数据合法性校验所提供的标准框架。JSR 303支持XML风格的和注解风格的验证,通过在Bean属性上标注类似于@NotNull@Max等的标准注解指定校验规则,并通过标准的验证接口对Bean进行验证。访问http://jcp.org/en/jsr/detail?id=303可以查看详细内容并下载JSR 303 Bean Validation。JSR 303 不需要编写验证器,它定义了一套可标注在成员变量、属性方法上的校验注解,如下表所示:

约束说明
@Null被注解的元素必须为Null
@NotNull被注解的元素必须部位Null
@AssertTrue被注解的元素必须为true
@AssertFalse被注解的元素必须为false
@Min(value)被注解的元素必须是一个数字,其值必须大于等于最小值
@Max(value)被注解的元素必须是一个数字,其值必须小于等于最大值
@DecimalMin(value)被注解的元素必须是一个数字,其值必须大于等于最小值
@DecimalMax(value)被注解的元素必须是一个数字,其值必须小于等于最大值
@Size(max,min)被注解的元素的大小必须在指定的范围内
@Digits(integer,fraction)被注解的元素必须是一个数字,其值必须在可接受范围内
@Past被注解的元素必须是一个过去的日期
@Future被注解的元素必须是一个将来的日期
@Pattern(value)被直接的元素必须符合指定的正则表达式

Hibernate Validator是JSR 303的一个参考实现,除了支持所有标准的校验注解之外,还扩展了如下表所示的注解。

约束说明
@NotBlank检查被注解的元素是不是Null,以及被去掉前后空格的长度是否大于0
@Email被注解的元素必须是电子邮件格式
@URL被注解的元素必须是合法的URL地址
@length被注解的字符串的字符串的大小必须在指定的范围内
@NotEmpty校验集合元素或数组元素或者字符串是否非空。通常作用于集合字段或数组字段,此时需要集合或者数字的元素个数大于0。也可以作用于字符串,此时校验字符串不能为null或空串(可以是一个空格)。
@Range被注解的元素必须在合适的范围内

2、实战

spring-boot-starter-validation是Spring Boot 框架中的一个模块,它构建在Hibernate Validator的基础之上,并提供了对Bean Validation的集成支持。它可以通过SpringBoot的自动配置机制轻松集成到Spring应用程序中。使用 spring-boot-starter-validation,你可以在SpringBoot应用程序中使用 Hibernate Validator的功能,而不需要显式地配置Hibernate Validator

因此,Hibernate Validator是一个独立的验证框架,而 spring-boot-starter-validation 则是一个为 Spring Boot应用程序提供集成 Hibernate Validator 的模块。

在这里搭建一个简单的SpringBoot项目,并引入如下依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2.1 全局异常处理

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
    //参数校验异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Result error(MethodArgumentNotValidException e){
        log.warn(e.getMessage());
        return Result.fail()
                .code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
                .message(e.getBindingResult().getFieldError().getDefaultMessage());
    }
    //参数校验异常
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public Result error(BindException e){
        log.warn(e.getMessage());
        StringBuilder sb = new StringBuilder();
        for (ObjectError error : e.getBindingResult().getAllErrors()) {
            sb.append(error.getDefaultMessage());
        }
        return Result.fail()
                .code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
                .message(sb.toString());
    }
    //参数校验异常
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public Result error(ConstraintViolationException e){
        log.warn(e.getMessage());
        StringBuilder sb = new StringBuilder();
        for (ConstraintViolation<?> violation : e.getConstraintViolations()) {
            sb.append(violation.getMessage());
        }
        return Result.fail()
                .code(ResultCodeEnum.ARGUMENT_VALID_ERROR.getCode())
                .message(sb.toString());
    }
    //全局异常
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result error(Exception e){
        log.warn(e.getMessage());
        return Result.fail().message("执行了全局异常处理");
    }
}

2.2 快速开始

2.2.1 实体类

@Data
public class UserCreateVo {
    @NotBlank(message = "用户名不能为空")
    private String userName;

    @NotBlank(message = "姓名不能为空")
    private String name;

    @Size(min=11,max=11,message = "手机号长度不符合要求")
    private String phone;

    @NotNull(message = "性别不能为空")
    private Integer sex;
}
@Data
public class UserUpdateVo {

    @NotBlank(message = "id不能为空")
    private String id;

    @NotBlank(message = "用户名不能为空")
    private String userName;

    @NotBlank(message = "姓名不能为空")
    private String name;

    @Size(min=11,max=11,message = "手机号长度不符合要求")
    private String phone;

    @NotNull(message = "性别不能为空")
    private Integer sex;
}

2.2.1 定义请求接口

@Validated
@RestController
public class UserController {

    @PostMapping("create")
    public Result createUser(@Validated @RequestBody UserCreateVo userCreateVo){
        return Result.ok("参数校验成功");
    }

    @PostMapping("update")
    public Result updateUser(@Validated @RequestBody UserUpdateVo userUpdateVo){
        return Result.ok("参数校验成功");
    }
}

2.2.2 测试

新增接口测试:

这里故意不写用户名

image-20240427132556773

更新接口测试:

image-20240427132536287

2.3 路径传参校验

有时候我们是通过@Pathvariable注解实现参数传递的,这个时候校验如下:

@GetMapping("getUserById/{id}")
public Result getUserById(@PathVariable @Size(min=2,max=5,message = "id长度不符合要求") String id){
    return Result.ok("参数校验成功");
}

image-20240427134833256

可以看到,校验规则是生效的。

2.4 分组校验

我们前边写了两个Vo类:UserCreateVoUserUpdateVo。如果每个请求都要定制Vo类的话,那我们还不如直接用if else梭哈呢。

比如我们新增的时候一般不需要id,但是修改的时候需要传入id。

2.4.1 定义分组校验接口

//分组校验
public class UserGroup {
    public interface CreateGroup extends Default {
    }
    public interface UpdateGroup extends Default {
    }
}

2.4.2 统一Vo校验类

@Data
public class UserVo {

    @NotBlank(message = "id不能为空",groups = UserGroup.UpdateGroup.class)
    private String id;

    @NotBlank(message = "用户名不能为空",groups = 
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String userName;

    @NotBlank(message = "姓名不能为空",groups = 
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String name;

    @Size(min=11,max=11,message = "手机号长度不符合要求",groups = 
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String phone;

    @NotNull(message = "性别不能为空",groups = 
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private Integer sex;
}

2.4.3 修改接口

参数上边添加@Validated接口,并指定分组名称,并统一使用UserVo类接收参数。

@Validated
@RequestMapping("/user")
@RestController
public class UserController {

    @PostMapping("create")
    public Result createUser(@Validated(UserGroup.CreateGroup.class) @RequestBody UserVo userVo){
        return Result.ok("参数校验成功");
    }

    @PutMapping("update")
    public Result updateUser(@Validated(UserGroup.UpdateGroup.class) @RequestBody UserVo userVo){
        return Result.ok("参数校验成功");
    }

    @GetMapping("getUserById/{id}")
    public Result getUserById(@PathVariable @Size(min=2,max=5,message = "id长度不符合要求") String id){
        return Result.ok("参数校验成功");
    }

}

2.4.4 测试

新增接口:

image-20240427141457483

修改接口:

image-20240427141527013

2.5 嵌套对象校验

存在嵌套对象校验的时候,使用@Valid注解解决。

2.5.1 添加一个角色实体

@Data
public class Role {
    @NotBlank(message = "角色名称不能为空")
    private String roleName;
}

2.5.2 修改VO类

在User类中引入角色实体,并加入@Valid注解。

@Data
public class UserVo {

    @NotBlank(message = "id不能为空",groups = UserGroup.UpdateGroup.class)
    private String id;

    @NotBlank(message = "用户名不能为空",groups =
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String userName;

    @NotBlank(message = "姓名不能为空",groups =
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String name;

    @Size(min=11,max=11,message = "手机号长度不符合要求",groups =
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private String phone;

    @NotNull(message = "性别不能为空",groups =
            {UserGroup.CreateGroup.class,UserGroup.UpdateGroup.class})
    private Integer sex;

    @Valid
    @NotNull(message = "角色信息不能为空")
    private Role role;
}

2.5.3 测试

测试新增接口,故意不传角色信息:

image-20240427142412322

测试修改接口,故意不传角色信息:

image-20240427142442930

2.6 快速失败配置

默认validation的校验规则默认会检查所有属性的校验规则,在每一条规则都校验完成后才抛出异常,这样子难免效率会很低,我们希望在发现错误后就不再向后检查,可以通过“快速失败”配置解决,参考代码如下:

/**
 * 参数校验相关配置
 */
@Configuration
public class ValidConfig {
    /**
     * 快速返回校验器
     * @return
     */
    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                //快速失败模式
                .failFast(true)
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }

    /**
     * 设置快速校验,返回方法校验处理器
     * 使用MethodValidationPostProcessor注入后,会启动自定义校验器
     * @return
     */
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor(){
        MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
        methodValidationPostProcessor.setValidator(validator());
        return methodValidationPostProcessor;
    }
}

2.7 自定义校验规则

有时候框架自带的校验无法满足我们业务的需求,这个时候可以根据自己的需求定制校验规则。

这里我们自定义一个手机号校验的注解,仅作示例使用,因为官方已经提供了手机号的校验注解。

2.7.1 定义注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Constraint(validatedBy = PhoneValidator.class)
public @interface PhoneValid {
    String message() default "请填写正确的手机号";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

@Constraint注解是Hibernate Validator的注解,用于实现自定义校验规则,通过validatedBy参数指定进行参数校验的实现类。

2.7.2 校验实现类

实现ConstraintValidator接口。

image-20240427150139491

ConstraintValidator<A extends Annotation, T>中,第一个参数为注解,即Annotation,第二个参数是泛型。

public class PhoneValidator implements ConstraintValidator<PhoneValid,Object> {
    /**
     * 11位手机号的正则表达式,以13、14、15、17、18头
     * ^:匹配字符串的开头
     * 13\d:匹配以13开头的手机号码
     * 14[579]:匹配以145、147、149开头的手机号
     * 15[^4\D]:匹配以15开头且第3位数字不为4的手机号码
     * 17[^49\D]:匹配以17开头且第3位数字部位4或9的手机号码
     * 18\d :匹配以18开头的手机号码
     * \d{8}:匹配手机号码的后8位,即剩余的8个数字
     * $:匹配字符串的结尾
     */
    public static final String REGEX_PHONE="^(13\\d|14[579]|15[^4\\D]|17[^49\\D]|18\\d)\\d{8}$";


    //初始化注解
    @Override
    public void initialize(PhoneValid constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }

    //校验参数,true表示校验通过,false表示校验失败
    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        String phone = String.valueOf(o);
        if(phone.length()!=11){
            return false;
        }
        //正则校验
        return phone.matches(REGEX_PHONE);
    }
}

2.7.3 在实体中添加自定义注解

image-20240427150302579

2.7.4 测试自定义校验规则

先使用一个正确的手机号测试,校验成功。

image-20240427150332029

再用一个错误的手机号测试,校验失败。

image-20240427150400589

就介绍到这里,其实参数校验的用法很多,这里只是介绍下常用的功能。

参考

https://hibernate.org/validator/documentation/

SpringBoot + validator优雅参数校验,消除if-else

新来的一个同事,把SpringBoot参数校验玩的那叫一个优雅

快速失败(Fail Fast) Spring Validation