SpringBoot 中使用 @Valid 注解 + Exception 全局处理器优雅处理参数验证

2401_84009679

于 2024-04-18 08:26:57 发布

阅读量763

点赞数 14

本文链接：https://blog.csdn.net/2401_84009679/article/details/137902358

版权

程序员专栏收录该内容

260 篇文章 0 订阅

订阅专栏

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 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”>

4.0.0

org.springframework.boot

spring-boot-starter-parent

2.2.1.RELEASE

com.aspire

springboot-valid-demo

0.0.1-SNAPSHOT

springboot-valid-demo

@valid demo

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

org.springframework.boot

spring-boot-starter-web

org.projectlombok

lombok

true

org.springframework.boot

spring-boot-maven-plugin

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 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不能为空”

}

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

写在最后

还有一份JAVA核心知识点整理（PDF）：JVM，JAVA集合，JAVA多线程并发，JAVA基础，Spring原理，微服务，Netty与RPC，网络，日志，Zookeeper，Kafka，RabbitMQ，Hbase，MongoDB，Cassandra，设计模式，负载均衡，数据库，一致性哈希，JAVA算法，数据结构，加密算法，分布式缓存，Hadoop，Spark，Storm，YARN，机器学习，云计算…

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！**

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。[外链图片转存中…(img-oSi3Rk1l-1713400005565)]

[外链图片转存中…(img-u5E20F7c-1713400005565)]

[外链图片转存中…(img-pgO0gsAN-1713400005566)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

写在最后

[外链图片转存中…(img-3T87LXJ9-1713400005566)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

2401_84009679

关注

14
点赞
踩
27

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot 中使用 @Valid 注解 + Exception 全局处理器优雅处理参数验证

自定义个异常类，方便我们处理 GET 请求（GET 请求参数中一般是没有实体对象的，所以不能使用 @Valid），当请求验证失败时，手动抛出自定义异常，交由全局异常处理。定义一个返回信息的枚举类，方便我们快速响应信息，不必每次都写返回消息和响应码。SUCCESS(1000, “请求成功”),PARAMETER_ERROR(1001, “请求参数有误!”),UNKNOWN_ERROR(9999, “未知的错误!”);创建用于返回调用方的响应信息的实体类。@Data。
复制链接

扫一扫