SpringBoot Validator 校验参数

本文由 简悦 SimpRead 转码， 原文地址 lqcoder.com

• 干掉 try catch：https://blog.csdn.net/xcbeyond/article/details/105872632
• Java 统一异常处理（配置文件集中化定义）：https://blog.csdn.net/xcbeyond/article/details/90708873

0. 前言

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

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

1. 什么是 Validator

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

2. 注解介绍

validator 内置注解

Hibernate Validator 附加的 constraint

注意：

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

3. 使用

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

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

例如非空校验：

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

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

参数:

{
    "userName":"luomengsun",
    "mobileNo":"11111111111",
    "sex":1,
    "age":21,
    "email":""
}

返回结果：

后台抛出异常

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

4. 添加全局异常

创建一个GlobalExceptionHandler 类:

import com.tal.analysis.business.model.entity.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    /**
     * 方法参数校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error(e.getMessage(), e);
        return Result.buildFailResult(e.getBindingResult().getFieldError().getDefaultMessage());
    }
}

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

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

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

OK 已经对异常进行处理。

5. 校验格式

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

校验邮箱

@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
}

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

6. 自定义注解

上面的注解只有这么多，如果有特殊校验的参数我们可以使用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 主要进行验证逻辑

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

然后使用

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

7. 分组

就比如上面我们定义的 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 的话可以使用分组校验

8. 校验单个参数

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

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

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

9. service 层校验封装工具类

import com.hwl.tool.exception.ValidateParamException;
import com.tal.analysis.core.constants.Constants;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;
import java.util.stream.Collectors;
/**
 * @description: 参数校验工具类
 * @author: zcq
 * @date: 2020/11/8 10:29 上午
 */
public class ValidatorUtils {
    private static Validator validator;
    static {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }
    /**
     * 校验对象
     *
     * @param object 待校验对象
     * @param groups 待校验的组
     * @throws ValidateParamException 抛出单数校验异常
     */
    public static void validateEntity(Object object, Class<?>... groups) throws ValidateParamException {
        Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, groups);
        if (!constraintViolations.isEmpty()) {
            String msg = constraintViolations.stream().map(constraint -> constraint.getMessage() + Constants.Decollator.VERTICAL_LINE).collect(Collectors.joining());
            throw new ValidateParamException(msg.substring(0, msg.length() - 1));
        }
    }
}