SpringBoot参数校验，消除if else

1、参数校验简介

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

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

2、实战

spring-boot-starter-validation 是Spring Boot 框架中的一个模块，它构建在 Hibernate validator 的基础之上，并提供了对BearValidation的集成支持。它可以通过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新增接口测试

2.3路径传参校验

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

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

2.4 分组校验我们前边写了两个V0类: usercreatev 和 userupdatevo 。如果每个请求都要定制V0类的话，那我们还不如直接用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新增接口

修改接口