转载

SpringBoot如何优雅的校验参数

前言

做web开发有一点很烦人就是要校验参数，基本上每个接口都要对参数进行校验，比如一些格式校验非空校验都是必不可少的。如果参数比较少的话还是容易处理的一但参数比较多了的话代码中就会出现大量的 IF ELSE 就比如下面这样：

SpringBoot如何优雅的校验参数

这个例子只是校验了一下空参数。如果需要验证邮箱格式和手机号格式校验的话代码会更多，所以介绍一下 validator 通过注解的方式进行校验参数。

什么是Validator

Bean Validation是Java定义的一套基于注解的数据校验规范，目前已经从JSR 303的1.0版本升级到JSR 349的1.1版本，再到JSR 380的2.0版本（2.0完成于2017.08），已经经历了三个版本。在 SpringBoot 中已经集成在 starter-web 中，所以无需在添加其他依赖。

SpringBoot如何优雅的校验参数

注解介绍

validator内置注解

注解	详细信息
`@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 附加的 constraint

注解	详细信息
`@Email`	被注释的元素必须是电子邮箱地址
`@Length`	被注释的字符串的大小必须在指定的范围内
`@NotEmpty`	被注释的字符串的必须非空
`@Range`	被注释的元素必须在合适的范围内
`@NotBlank`	验证字符串非null，且长度必须大于0

注意：

@NotNull 适用于任何类型被注解的元素必须不能与NULL
@NotEmpty 适用于String Map或者数组不能为Null且长度必须大于0
@NotBlank 只能用于String上面不能为null,调用trim()后，长度必须大于0

使用

使用起来也非常简单，下面略过创建项目

GITHUB地址:

模拟用户注册封装了一个 UserDTO

当提交数据的时候如果使用以前的做法就是 IF ELSE 判断参数使用 validator 则是需要增加注解即可。

例如非空校验：

SpringBoot如何优雅的校验参数

然后需要在 controller 方法体添加 @Validated 不加 @Validated 校验会不起作用

SpringBoot如何优雅的校验参数

然后请求一下请求接口,把Email参数设置为空

参数:

{
    "userName":"luomengsun",
    "mobileNo":"11111111111",
    "sex":1,
    "age":21,
    "email":""
}复制代码

返回结果：

SpringBoot如何优雅的校验参数

后台抛出异常

SpringBoot如何优雅的校验参数

这样是能校验成功，但是有个问题就是返回参数并不理想，前端也并不容易处理返回参数，所以我们添加一下全局异常处理，然后添加一下全局统一返回参数这样比较规范。

添加全局异常

创建一个 GlobalExceptionHandler 类，在类上方添加 @RestControllerAdvice 注解然后添加以下代码：

/**
     * 方法参数校验
     */
@ExceptionHandler(MethodArgumentNotValidException.class)
public ReturnVO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error(e.getMessage(), e);
        return new ReturnVO().error(e.getBindingResult().getFieldError().getDefaultMessage());
    }复制代码

此方法主要捕捉 MethodArgumentNotValidException 异常然后对异常结果进行封装，如果需要在自行添加其他异常处理。

添加完之后我们在看一下运行结果，调用接口返回:

{
    "code": "9999",
    "desc": "邮箱不能为空",
    "data": null
}复制代码

OK 已经对异常进行处理。

校验格式

如果想要校验邮箱格式或者手机号的话也非常简单。

校验邮箱

/**
     * 邮箱
     */
    @NotBlank(message = "邮箱不能为空")
    @NotNull(message = "邮箱不能为空")
    @Email(message = "邮箱格式错误")
    private String email;复制代码

使用正则校验手机号

校验手机号使用正则进行校验，然后限制了一下位数

/**
     * 手机号
     */
    @NotNull(message = "手机号不能为空")
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp ="^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
    @Max(value = 11,message = "手机号只能为{max}位")
    @Min(value = 11,message = "手机号只能为{min}位")
    private String mobileNo;复制代码

查看一下运行结果

传入参数：

{
    "userName":"luomengsun",
    "mobileNo":"111111a",
    "sex":1,
    "age":21,
    "email":"1212121"
}复制代码

返回结果：

{
    "code": "9999",
    "desc": "邮箱格式错误",
    "data": null
}复制代码

这里不再验证手机号的例子

自定义注解

上面的注解只有这么多，如果有特殊校验的参数我们可以使用 Validator 自定义注解进行校验

首先创建一个 IdCard 注解类

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

    String message() default "身份证号码不合法";

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

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

}复制代码

在UserDTO中添加 @IdCard 注解即可验证，在运行时触发，本文不对自定义注解做过多的解释，下篇文章介绍自定义注解

message 提示信息
groups 分组
payload 针对于Bean

然后添加 IdCardValidator 主要进行验证逻辑

SpringBoot如何优雅的校验参数

上面调用了 is18ByteIdCardComplex 方法，传入参数就是手机号，验证身份证规则自行百度:see no evil:

然后使用

@NotNull(message = "身份证号不能为空")
    @IdCard(message = "身份证不合法")
    private String IdCardNumber;复制代码

分组

就比如上面我们定义的UserDTO中的参数如果要服用的话怎么办？

在重新定义一个类然后里面的参数要重新添加注解？

Validator 提供了分组方法完美了解决DTO服用问题

现在我们注册的接口修改一下规则，只有用户名不能为空其他参数都不进行校验

先创建分组的接口

public interface Create  extends Default {
}复制代码

我们只需要在注解加入分组参数即可例如：

/**
     * 用户名
     */
    @NotBlank(message = "用户姓名不能为空",groups = Create.class)
    @NotNull(message = "用户姓名不能为空",groups = Create.class)
    private String userName;

    @NotBlank(message = "邮箱不能为空",groups = Update.class)
    @NotNull(message = "邮箱不能为空",groups = Update.class)
    @Email(message = "邮箱格式错误",groups = Update.class)
    private String email;复制代码

然后在修改Controller在 @Validated 中传入 Create.class

@PostMapping("/user")
    public ReturnVO userRegistra(@RequestBody @Validated(Create.class) UserDTO userDTO){
        ReturnVO returnVO = userService.userRegistra(userDTO);
        return returnVO ;
    }复制代码

然后调用传入参数：

{
    "userName":"",
}复制代码

返回参数：

{
    "code": "9999",
    "desc": "用户姓名不能为空",
    "data": null
}复制代码

OK 现在只对Create的进行校验，而Updata组的不校验，如果需要复用DTO的话可以使用分组校验

校验单个参数

在开发的时候一定遇到过单个参数的情况,在参数前面加上注解即可

@PostMapping("/get")
    public ReturnVO getUserInfo(@RequestParam("userId") @NotNull(message = "用户ID不能为空") String userId){
        return new ReturnVO().success();
    }复制代码

然后在Controller类上面增加 @Validated 注解,注意不是增加在参数前面。

SpringBoot如何优雅的校验参数