瞎琢磨先生教你优雅的进行参数合法性校验

项目整体结构

1 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <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>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2 请求实体类(参数校验★★★★★，核心代码)

UserRequest.java

package com.example.demo.entity;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.*;
import javax.validation.groups.Default;

/**
 * @Date: 2021/5/7 20:35
 * @Description：
 * @Author: 瞎琢磨先生
 */

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserRequest {

    // 新增的校验(默认，以下的校验如未添加 groups 则为 insertCheck)
    public static interface insertCheck extends Default {
    }

    // 更新的校验
    public static interface updateCheck {
    }

    // 登录的校验
    public static interface loginCheck {
    }

    /**
     * 新增、登录的时候，username 不能为空
     */
    @NotBlank(groups = {insertCheck.class, loginCheck.class}, message = "username 不能为空(必填项)")
    @NotEmpty(groups = {insertCheck.class, loginCheck.class}, message = "username 不能为空(必填项)")
    private String username;

    /**
     * 新增、更新、登录的时候，pwd 不能为空
     */
    @Length(groups = {insertCheck.class, updateCheck.class, loginCheck.class}, min = 6, max = 16, message = "密码必须 6-16 位")
    @NotBlank(groups = {insertCheck.class, updateCheck.class, loginCheck.class}, message = "password 不能为空(必填项)")
    @NotEmpty(groups = {insertCheck.class, updateCheck.class, loginCheck.class}, message = "password 不能为空(必填项)")
    private String password;

    @Min(groups = {insertCheck.class, updateCheck.class}, value = 0, message = "age 不能小于 0")
    @Max(groups = {insertCheck.class, updateCheck.class}, value = 8000, message = "age 不能大于 8000 岁")
    private Integer age;

    @Email(groups = {insertCheck.class, updateCheck.class}, message = "email 格式有误")
    private String email;

    @Pattern(groups = {insertCheck.class, updateCheck.class}, regexp = "(^Man$|^Woman$|^UGM$)", message = "sex 值不在可选范围")
    // sex 必须从 *Man* *Woman* *UGM* 中选择。其中：* 表示 0 ~ 任意多个字符。
    private String sex;

    @Length(groups = {insertCheck.class, updateCheck.class}, min = 11, max = 11, message = "手机号码只能 11 位")
    private String phone;

}

3 测试接口

UserController.java

package com.example.demo.controller;

import com.example.demo.entity.UserRequest;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: 瞎琢磨先生
 * @Date: 2021/5/7 20:33
 * @Description：
 */
@Slf4j
@RestController
public class UserController {

    @PostMapping(value = "/insert", produces = {"application/json;charset=UTF-8"})
    public ResponseEntity insert(@RequestBody @Validated UserRequest userRequest) {
        log.info("新增的 userRequest：[{}]", userRequest);
        return ResponseEntity.ok().body(userRequest);
    }

    @PostMapping(value = "/update", produces = {"application/json;charset=UTF-8"})
    public ResponseEntity update(@RequestBody @Validated(UserRequest.updateCheck.class) UserRequest userRequest) {
        log.info("更新的 userRequest：[{}]", userRequest);
        return ResponseEntity.ok().body(userRequest);

    }

    @PostMapping(value = "/login", produces = {"application/json;charset=UTF-8"})
    public ResponseEntity login(@RequestBody @Validated(UserRequest.loginCheck.class) UserRequest userRequest) {
        log.info("登录的 userRequest：[{}]", userRequest);
        return ResponseEntity.ok().body(userRequest);

    }

}

4 设置校验模式

ValidConfig.java

package com.example.demo.config;

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

/**
 * @Date: 2021/5/7 22:18
 * @Description：设置校验模式(遇到参数校验不通过则立即速返回，不需要校验完所有的参数之后再返回)
 * @Author: 瞎琢磨先生
 */
// https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-fail-fast

@Configuration
public class ValidConfig {

    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                .failFast(true) // 报错则快速返回，不需要校验完所有的参数之后再返回
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        return validator;
    }
}

5 设置全局参数校验异常捕获

GlobalExceptionInterceptor.java

package com.example.demo.advice;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@ControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionInterceptor {

    @ExceptionHandler(value = Exception.class)
    public String exceptionHandler(HttpServletRequest request, Exception e) {

        String failMsg = null;
        if (e instanceof MethodArgumentNotValidException) {
            // 拿到参数校验具体异常信息提示
            failMsg = ((MethodArgumentNotValidException) e).getBindingResult().getFieldError().getDefaultMessage();
        }
        log.info("参数校验失败");
        return failMsg; // 直接吐回给前端
    }
}

 

Postman 请求测试

localhost:8080/insert

localhost:8080/update

localhost:8080/login

{

    "username": "zs",
    "password": "123456",
    "age": 996,
    "email": "12345656789@qq.com",
    "sex": "Man",
    "phone": "12345678901"

}