乐趣区

关于java:SpringBoot-中使用-Valid-注解-Exception-全局处理器优雅处理参数验证

jiezi

公众号：MarkerHub，网站：https://markerhub.com

小 Hub 领读：

之前也发过一篇讲参数校验的这么写参数校验 (validator) 就不会被劝退了~, 加上这篇，不懂的都应该懂啦~

  • 作者：超级小豆丁
  • http://www.mydlq.club/article…

目录

一、为什么应用 @Valid 来验证参数

二、@Valid 注解的作用

三、@Valid 的相干注解

四、应用 @Valid 进行参数效验步骤

  • 实体类中增加 @Valid 相干注解
  • 接口类中增加 @Valid 注解
  • 全局异样解决类中解决 @Valid 抛出的异样

五、SpringBoot 中应用 @Valid 示例

  • Maven 引入相干依赖
  • 自定义个异样类
  • 自定义响应枚举类
  • 自定义响应对象类
  • 自定义实体类中增加 @Valid 相干注解
  • Controller 中增加 @Valid 注解
  • 全局异样解决
  • 启动类
  • 示例测试

相干地址：

Spring Servlet 文档：https://docs.spring.io/spring…
示例我的项目 Github：https://github.com/my-dlq/blo…
零碎环境：

Jdk 版本：jdk 8

SpringBoot 版本：2.2.1.RELEASE

一、为什么应用 @Valid 来验证参数

在平时通过 Spring 框架写代码时候，会常常写接口类，置信大家对该类的写法十分相熟。在写接口时常常要写效验申请参数逻辑，这时候咱们会罕用做法是写大量的 if 与 if else 相似这样的代码来做判断，如下：

@RestController
public class TestController {@PostMapping("/user")
    public String addUserInfo(@RequestBody User user) {if (user.getName() == null || "".equals(user.getName()) {......} else if(user.getSex() == null || "".equals(user.getSex())) {......} else if(user.getUsername() == null || "".equals(user.getUsername())) {......} else {......}
        ......
    }

}

这样的代码如果按失常代码逻辑来说，是没有什么问题的，不过按优雅来说，几乎蹩脚透了。不仅不优雅，而且如果存在大量的验证逻辑，这会使代码看起来乱哄哄，大大降低代码可读性，那么有没有更好的办法可能简化这个过程呢？

答案当然是有，举荐的是应用 @Valid 注解来帮忙咱们简化验证逻辑。

二、@Valid 注解的作用

注解 @Valid 的次要作用是用于数据效验，能够在定义的实体中的属性上，增加不同的注解来实现不同的校验规定，而在接口类中的接收数据参数中增加 @valid 注解，这时你的实体将会开启一个校验的性能。

三、@Valid 的相干注解

上面是 @Valid 相干的注解，在实体类中不同的属性上增加不同的注解，就能实现不同数据的效验性能。

四、应用 @Valid 进行参数效验步骤

整个过程如下图所示，用户拜访接口，而后进行参数效验，因为 @Valid 不反对立体的参数效验（间接写在参数中字段的效验）所以基于 GET 申请的参数还是依照原先形式进行效验，而 POST 则能够以实体对象为参数，能够应用 @Valid 形式进行效验。如果效验通过，则进入业务逻辑，否则抛出异样，交由全局异样处理器进行解决。

1、实体类中增加 @Valid 相干注解

应用 @Valid 相干注解非常简单，只须要在参数的实体类中属性下面增加如 @NotBlank、@Max、@Min 等注解来对该字段进限度，如下：

User：

public class User {@NotBlank(message = "姓名不为空")
    private String username;
    @NotBlank(message = "明码不为空")
    private String password;
}

如果是嵌套的实体对象，则须要在最外层属性上增加 @Valid 注解：

User：

public class User {@NotBlank(message = "姓名不为空")
    private String username;
    @NotBlank(message = "明码不为空")
    private String password;
    // 嵌套必须加 @Valid，否则嵌套中的验证不失效
    @Valid
    @NotNull(message = "用户信息不能为空")
    private UserInfo userInfo;
}

UserInfo：

public class User {@NotBlank(message = "年龄不为空")
    @Max(value = 18, message = "不能超过 18 岁")
    private String age;
    @NotBlank(message = "性别不能为空")
    private String gender;
}

2、接口类中增加 @Valid 注解

在 Controller 类中增加接口，POST 办法中接管设置了 @Valid 相干注解的实体对象，而后在参数中增加 @Valid 注解来开启效验性能，须要留神的是，@Valid 对 Get 申请中接管的立体参数申请有效，略微略显遗憾。

@RestController
public class TestController {@PostMapping("/user")
    public String addUserInfo(@Valid @RequestBody User user) {return "调用胜利!";}

}

3、全局异样解决类中解决 @Valid 抛出的异样

最初，咱们写一个全局异样解决类，而后对接口中抛出的异样进行解决，而 @Valid 配合 Spring 会抛出 MethodArgumentNotValidException 异样，这里咱们须要对该异样进行解决即可。

@RestControllerAdvice("club.mydlq.valid")   // 指定异样解决的包名
public class GlobalExceptionHandler {@ResponseStatus(HttpStatus.BAD_REQUEST) // 设置状态码为 400
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public String paramExceptionHandler(MethodArgumentNotValidException e) {BindingResult exceptions = e.getBindingResult();
        // 判断异样中是否有错误信息，如果存在就应用异样中的音讯，否则应用默认音讯
        if (exceptions.hasErrors()) {List<ObjectError> errors = exceptions.getAllErrors();
            if (!errors.isEmpty()) {
                // 这里列出了全副谬误参数，按失常逻辑，只须要第一条谬误即可
                FieldError fieldError = (FieldError) errors.get(0);
                return fieldError.getDefaultMessage();}
        }
        return "申请参数谬误";
    }

}

五、SpringBoot 中应用 @Valid 示例

1、Maven 引入相干依赖

Maven 引入 SpringBoot 相干依赖，这里引入了 Lombok 包来简化开发过程。

<?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.2.1.RELEASE</version>
    </parent>

    <groupId>com.aspire</groupId>
    <artifactId>springboot-valid-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-valid-demo</name>
    <description>@valid demo</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <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>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2、自定义个异样类

自定义个异样类，不便咱们解决 GET 申请（GET 申请参数中个别是没有实体对象的，所以不能应用 @Valid），当申请验证失败时，手动抛出自定义异样，交由全局异样解决。

public class ParamaErrorException extends RuntimeException {public ParamaErrorException() { }

    public ParamaErrorException(String message) {super(message);
    }

}

3、自定义响应枚举类

定义一个返回信息的枚举类，不便咱们疾速响应信息，不用每次都写返回音讯和响应码。

public enum ResultEnum {SUCCESS(1000, "申请胜利"),
    PARAMETER_ERROR(1001, "申请参数有误!"),
    UNKNOWN_ERROR(9999, "未知的谬误!");

    private Integer code;
    private String message;

    ResultEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer getCode() {return code;}

    public String getMessage() {return message;}
}

4、自定义响应对象类

创立用于返回调用方的响应信息的实体类。

import com.aspire.parameter.enums.ResultEnum;
import lombok.Data;

@Data
public class ResponseResult {
    private Integer code;
    private String msg;

    public ResponseResult(){}

    public ResponseResult(ResultEnum resultEnum){this.code = resultEnum.getCode();
        this.msg = resultEnum.getMessage();}

    public ResponseResult(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

5、自定义实体类中增加 @Valid 相干注解

上面将创立用于 POST 办法接管参数的实体对象，外面增加 @Valid 相干验证注解，并在注解中增加出错时的响应音讯。

User

import lombok.Data;
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

/**
 * user 实体类
 */
@Data
public class User {@NotBlank(message = "姓名不为空")
    private String username;
    @NotBlank(message = "明码不为空")
    private String password;
    // 嵌套必须加 @Valid，否则嵌套中的验证不失效
    @Valid
    @NotNull(message = "userinfo 不能为空")
    private UserInfo userInfo;
}

UserInfo

import lombok.Data;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;

@Data
public class UserInfo {@NotBlank(message = "年龄不为空")
    @Max(value = 18, message = "不能超过 18 岁")
    private String age;
    @NotBlank(message = "性别不能为空")
    private String gender;
}

6、Controller 中增加 @Valid 注解

接口类中增加 GET 和 POST 办法的两个接口用于测试，其中 POST 办法以下面创立的 Uer 实体对象接管参数，并应用 @Valid，而 GET 申请个别接管参数较少，所以应用失常判断逻辑进行参数效验。

import club.mydlq.valid.entity.ResponseResult;
import club.mydlq.valid.entity.User;
import club.mydlq.valid.enums.ResultEnum;
import club.mydlq.valid.exception.ParamaErrorException;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;

@RestController
public class TestController {

    /**
     * 获取用户信息
     *
     * @param username 姓名
     * @return ResponseResult
     */
    @Validated
    @GetMapping("/user/{username}")
    public ResponseResult findUserInfo(@PathVariable String username) {if (username == null || "".equals(username)) {throw new ParamaErrorException("username 不能为空");
        }
        return new ResponseResult(ResultEnum.SUCCESS);
    }


    /**
     * 新增用户
     *
     * @param user 用户信息
     * @return ResponseResult
     */
    @PostMapping("/user")
    public ResponseResult addUserInfo(@Valid @RequestBody User user) {return new ResponseResult(ResultEnum.SUCCESS);
    }

}

7、全局异样解决

这里创立一个全局异样解决类，不便对立解决异样错误信息。外面增加了不同异样解决的办法，专门用于解决接口中抛出的异样信。

import club.mydlq.valid.entity.ResponseResult;
import club.mydlq.valid.enums.ResultEnum;
import club.mydlq.valid.exception.ParamaErrorException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.List;

@Slf4j
@RestControllerAdvice("club.mydlq.valid")
public class GlobalExceptionHandler {

    /**
     * 疏忽参数异样处理器
     *
     * @param e 疏忽参数异样
     * @return ResponseResult
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MissingServletRequestParameterException.class)
    public ResponseResult parameterMissingExceptionHandler(MissingServletRequestParameterException e) {log.error("", e);
        return new ResponseResult(ResultEnum.PARAMETER_ERROR.getCode(), "申请参数" + e.getParameterName() + "不能为空");
    }

    /**
     * 短少申请体异样处理器
     *
     * @param e 短少申请体异样
     * @return ResponseResult
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseResult parameterBodyMissingExceptionHandler(HttpMessageNotReadableException e) {log.error("", e);
        return new ResponseResult(ResultEnum.PARAMETER_ERROR.getCode(), "参数体不能为空");
    }

    /**
     * 参数效验异样处理器
     *
     * @param e 参数验证异样
     * @return ResponseInfo
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseResult parameterExceptionHandler(MethodArgumentNotValidException e) {log.error("", e);
        // 获取异样信息
        BindingResult exceptions = e.getBindingResult();
        // 判断异样中是否有错误信息，如果存在就应用异样中的音讯，否则应用默认音讯
        if (exceptions.hasErrors()) {List<ObjectError> errors = exceptions.getAllErrors();
            if (!errors.isEmpty()) {
                // 这里列出了全副谬误参数，按失常逻辑，只须要第一条谬误即可
                FieldError fieldError = (FieldError) errors.get(0);
                return new ResponseResult(ResultEnum.PARAMETER_ERROR.getCode(), fieldError.getDefaultMessage());
            }
        }
        return new ResponseResult(ResultEnum.PARAMETER_ERROR);
    }

    /**
     * 自定义参数谬误异样处理器
     *
     * @param e 自定义参数
     * @return ResponseInfo
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({ParamaErrorException.class})
    public ResponseResult paramExceptionHandler(ParamaErrorException e) {log.error("", e);
        // 判断异样中是否有错误信息，如果存在就应用异样中的音讯，否则应用默认音讯
        if (!StringUtils.isEmpty(e.getMessage())) {return new ResponseResult(ResultEnum.PARAMETER_ERROR.getCode(), e.getMessage());
        }
        return new ResponseResult(ResultEnum.PARAMETER_ERROR);
    }

}

8、启动类

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);
    }

}

9、示例测试

上面将针对下面示例中设置的两种接口进行测试，别离来验证参数效验性能。

|| – 测试接口 /user/{username}

应用 GET 办法申请地址 http://localhost:8080/user?username=test 时，返回信息：

{
    "code": 1000,
    "msg": "申请胜利"
}

当不输出参数，输出地址 http://localhost:8080/user 时，返回信息：

{
    "code": 1001,
    "msg": "申请参数 username 不能为空"
}

能够看到在执行 GET 申请，可能失常按咱们全局异样处理器中的设置解决异样信息。

|| – 测试接口 /user

(1)、应用 POST 办法发动申请，首先进行不加 JSON 申请体来对 http://localhost:8080/user 地址进行申请，返回信息：

{
    "code": 1001,
    "msg": "参数体不能为空"
}

(2)、输出局部参数进行测试。

申请内容：

{
 "username":"test",
 "password":"123"
}

返回信息：

{
    "code": 1001,
    "msg": "userinfo 不能为空"
}

(3)、输出残缺参数，且设置 age > 18 时，进行测试。

{
 "username":"111",
 "password":"sa",
  "userInfo":{
    "age":19,
    "gender":"男"
  }
}

返回信息：

{
    "code": 1001,
    "msg": "不能超过 18 岁"
}

能够看到在执行 POST 申请，也能失常按咱们全局异样处理器中的设置解决异样信息，且提示信息为咱们设置在实体类中的 Message。

举荐浏览

太赞了，这个 Java 网站，什么我的项目都有！https://markerhub.com

这个 B 站的 UP 主，讲的 java 真不错！

太赞了！最新版 Java 编程思维能够在线看了！

退出移动版