Java Controller实现参数验证与统一异常处理流程详细讲解
作者：李奈?-?Leemon 发布时间：2022-01-25 18:49:47
最近开发了比较多的接口，因为没有可参考的案例，所以一开始一直按照我的理解进行开发。开发多了发现自己每个结果都写了相同的代码：try() {} catch() {}， 和关于参数判空的：StringUtils.empty(xxx)。开发结束后自然想下次更加优雅的开发。因此，使用了springboot的参数验证和统一异常处理。
一，前期数据及类准备
1.1 统一状态码
对于不同的返回类型，我们应该要有不同对应的状态码。接口的返回类型在统一状态码中必须存在。
package com.lmc.common.enums;
/**
* @Description: TODO 接口API返回状态码枚举
* @version: 1.0
*/
public enum ResultCodeEnum {
SUCCESS(1000, "请求成功"),
FAILURE(1001, "请求失败"),
VALIDATE_PARAMS_ERROR(1002, "参数校验失败");
private int code;
private String msg;
ResultCodeEnum(int code, String msg) {
this.code = code;
this.msg = msg;
}
/**
* 获取code
* @return
*/
public int getCode() {
return code;
}
/**
* 获取信息
* @return
*/
public String getMsg() {
return msg;
}
}
1.2 统一返回格式
统一状态码完成后，还需要定义统一返回格式，为了前端的方便调用
package com.lmc.common.vo;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.lmc.common.enums.ResultCodeEnum;
import lombok.Data;
import java.util.Date;
/**
* @Description: TODO 接口返回结果类型
* @version: 1.0
*/
@Data
public class ResultVo {
/**
* 状态码
*/
private int code;
/**
* 状态码信息
*/
private String msg;
/**
* 返回描述信息（预备为调用失败的情况下提供详细的失败原因）
*/
private String desc;
/**
* 返回数据
*/
private Object data;
/**
* 接口调用结束时间
*/
@JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss")
private Date searchTime;
public ResultVo(int code, String msg, Object data) {
this.code = code;
this.msg = msg;
this.data = data;
this.searchTime = new Date();
}
/**
* 调用成功时返回
* @param data
* @return
*/
public static ResultVo success(Object data) {
return new ResultVo(ResultCodeEnum.SUCCESS.getCode(), ResultCodeEnum.SUCCESS.getMsg(), data);
}
/**
* 调用失败时返回
* @param data
* @return
*/
public static ResultVo fail(Object data) {
return new ResultVo(ResultCodeEnum.FAILURE.getCode(), ResultCodeEnum.FAILURE.getMsg(), data);
}
/**
* 调用时指定状态码
* @param enums
* @param data
* @return
*/
public static ResultVo result(ResultCodeEnum enums, Object data) {
return new ResultVo(enums.getCode(), enums.getMsg(), data);
}
public ResultVo withDesc(String desc) {
this.desc = desc;
return this;
}
}
1.3 自定义接口API异常类
然后再自定义接口的异常类，当然也可以不用，看个人喜好
package pers.lmc.tools2.provider.exception;
import com.lmc.common.enums.ResultCodeEnum;
/**
* @Description: TODO API异常类
* @version: 1.0
*/
public class ApiException extends RuntimeException{
private int code;
private String msg;
public ApiException(String msg) {
super(msg);
this.code = ResultCodeEnum.FAILURE.getCode();
this.msg = ResultCodeEnum.FAILURE.getMsg();
}
public ApiException(ResultCodeEnum enums, String msg) {
super(msg);
this.code = enums.getCode();
this.msg = enums.getMsg();
}
}
1.4 参数封装类
为了调试参数验证，还需要自定义一个参数的封装类
package pers.lmc.tools2.provider.vo;
import lombok.Data;
/**
* @Description: TODO
* @version: 1.0
*/
@Data
public class Param01Vo {
private String name;
private Integer age;
private Short sex;
}
二，参数验证
参数验证需要用到springboot的validation依赖
2.1 pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!-- 关于校验 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>${jackson.version}</version>
</dependency>
2.2 修改参数封装类
package pers.lmc.tools2.provider.vo;
import lombok.Data;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
/**
* @Description: TODO
* @version: 1.0
*/
@Data
public class Param01Vo {
@NotNull(message = "名称不能为空")
@Size(min = 1, max = 50, message = "名称name长度必须是1-50个字符")
private String name;
@NotNull(message = "年龄age不能为空")
@Min(value = 10, message = "年龄age不能低于10岁")
@Max(value = 25, message = "年龄age不能超过25岁")
private Integer age;
@Min(value = 0, message = "性别sex只能是0和1,0=女1=男")
@Max(value = 1, message = "性别sex只能是0和1,0=女1=男")
private Short sex;
}
在这里对该封装类的三个参数都做了限制
2.3 controller
在controller中对参数做验证时，需要在类上使用注解@Validated，同时在接口的该参数也使用注解@Valid
package pers.lmc.tools2.provider.controller;
import com.lmc.common.vo.ResultVo;
import lombok.extern.slf4j.Slf4j;
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.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import pers.lmc.tools2.provider.vo.Param01Vo;
import javax.validation.Valid;
/*
* @Description: TODO
* @version: 1.0
*/
@RestController
@Validated
@RequestMapping("/valicate")
@Slf4j
public class ValicateController {
@PostMapping("/add")
public ResultVo addParam01(@Valid @RequestBody Param01Vo param01Vo) {
log.info("执行add()方法，参数：" + param01Vo.toString());
return ResultVo.success(param01Vo);
}
}
2.4 测试
开发完成，准备测试，到APIPost上 访问 http://localhost:9003/provider/valicate/add，带上参数：
{
"name":"lmc",
"age": 22,
"sex": 1
}
访问成功，返回结果如下：
{
"code": 1000,
"msg": "请求成功",
"desc": null,
"data": {
"name": "lmc",
"age": 22,
"sex": 1
},
"searchTime": "2022-06-26 19:59:55"
}
如果参数输入不正确，例如：
{
"name":"",
"age": 220,
"sex": 2
}
得到结果如下：
{
"timestamp": "2022-06-26T12:02:21.748+00:00",
"status": 400,
"error": "Bad Request",
"message": "",
"path": "/provider/valicate/add"
}
日志是这样的：
2022-06-26 20:02:21 [http-nio-9003-exec-1] WARN o.s.w.s.m.support.DefaultHandlerExceptionResolver - Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.lmc.common.vo.ResultVo pers.lmc.tools2.provider.controller.ValicateController.addParam01(pers.lmc.tools2.provider.vo.Param01Vo) with 3 errors: [Field error in object 'param01Vo' on field 'sex': rejected value [2]; codes [Max.param01Vo.sex,Max.sex,Max.java.lang.Short,Max]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [param01Vo.sex,sex]; arguments []; default message [sex],1]; default message [性别sex只能是0和1,0=女1=男]] [Field error in object 'param01Vo' on field 'age': rejected value [220]; codes [Max.param01Vo.age,Max.age,Max.java.lang.Integer,Max]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [param01Vo.age,age]; arguments []; default message [age],25]; default message [年龄age不能超过25岁]] [Field error in object 'param01Vo' on field 'name': rejected value []; codes [Size.param01Vo.name,Size.name,Size.java.lang.String,Size]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [param01Vo.name,name]; arguments []; default message [name],50,1]; default message [名称name长度必须是1-50个字符]] ]
抛出了MethodArgumentNotValidException异常。
虽然参数错误时确实被拦截了，但格式已经和我们想要返回的不一致了。这个时候，就需要用到统一异常处理了。
三，统一异常处理
3.1 方法参数验证异常处理
通过以上的问题，我们可以设置controller的统一异常处理，当出现参数验证错误时，就捕获MethodArgumentNotValidException异常，然后我们自己做处理。
package pers.lmc.tools2.provider.aop;
import com.lmc.common.enums.ResultCodeEnum;
import com.lmc.common.vo.ResultVo;
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;
import pers.lmc.tools2.provider.exception.ApiException;
import java.util.List;
import java.util.stream.Collectors;
/**
* @Description: TODO
* @version: 1.0
*/
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 处理所有校验失败的异常（MethodArgumentNotValidException异常）
* @param e
* @return
*/
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public ResultVo handleBindGetException(MethodArgumentNotValidException e) {
// 获取所有异常参数
List<String> errors = e.getBindingResult()
.getFieldErrors()
.stream()
.map(x -> x.getDefaultMessage())
.collect(Collectors.toList());
return ResultVo.result(ResultCodeEnum.VALIDATE_PARAMS_ERROR, null).withDesc("参数校验失败:" + errors);
}
/**
* 处理自定义APIException异常
* @param e
* @return
*/
@ExceptionHandler(value = ApiException.class)
public ResultVo handleApiException(ApiException e) {
return ResultVo.fail(null).withDesc(e.getMessage());
}
/**
* 处理其他异常
* @param e
* @return
*/
@ExceptionHandler(value = Exception.class)
public ResultVo handleException(Exception e) {
log.info("执行到统一处理方法...");
return ResultVo.fail(null).withDesc(e.getMessage());
}
}
通过以上配置，再次以非法参数传输时，会报出以下错误：
{
"code": 1002,
"msg": "参数校验失败",
"desc": "参数校验失败:[性别sex只能是0和1,0=女1=男, 名称name长度必须是1-50个字符, 年龄age不能超过25岁]",
"data": null,
"searchTime": "2022-06-26 20:08:22"
}
这个时候格式已经我们想要的返回格式了。
3.2 其他异常处理
刚刚我们尝试的是方法的参数验证异常的处理，对于程序还可能出现的错误，配置统一异常处理后也不需要使用try{} catch() {}，因为我们已经在全局异常处理类中配置了：
/**
* 处理其他异常
* @param e
* @return
*/
@ExceptionHandler(value = Exception.class)
public ResultVo handleException(Exception e) {
log.info("执行到统一处理方法...");
return ResultVo.fail(null).withDesc(e.getMessage());
}
这个时候在程序中抛出其他异常，就会执行到这里的代码，同样返回我们想要的格式。举例如下
修改controller接口：
@PostMapping("/add")
public ResultVo addParam01(@Valid @RequestBody Param01Vo param01Vo) {
log.info("执行add()方法，参数：" + param01Vo.toString());
int k = 1/0; // 调用该接口时执行到这里会抛出异常
return ResultVo.success(param01Vo);
}
调用接口返回结果：
{
"code": 1001,
"msg": "请求失败",
"desc": "/ by zero",
"data": null,
"searchTime": "2022-06-26 20:13:51"
}
来源：https://blog.csdn.net/lmchhh/article/details/125473736?spm=1001.2014.3001.5502
0
投稿猜你喜欢
前言之前我们提到了 CustomPaint er 的 Paint 可以使用渐变（GradientShader）来填充绘制的图形，本篇我们来介- ObjectMapper 忽略字段大小写核心代码：ObjectMapper mapper = new ObjectMapper();mapp
- 在Android中使用SQLite数据库的入门指南，打算分下面几部分与大家一起分享， 1、什么是SQLite 2、Android中使用SQL
- 以下摘自胖哥分享的 2022开工福利教程。在学习Spring Security的时候你有没有下面这两个疑问：Spring Security的
- 一.HashMap 和Hashtable 的区别我们先看2个类的定义 public class Hashtable exten
- 前言目前Flutter三大主流状态管理框架分别是provider、flutter_bloc、getx，三大状态管理框架各有优劣，本篇文章将介
- BitArray的基础可以看菜鸟编程BitArray 类管理一个紧凑型的位值数组，它使用布尔值来表示，其中 true 表示位是开启的（1），
- WCF实例（带步骤） <xmlnamespace prefix ="o" ns ="urn:schema
- 什么是命名查询？ Hibernate允许在映射文件中定义字符串形式的查询语句，这种查询方式成为命名查询 使用命名查询有什么好处？ 由于使用H
- 前几篇主要集中在注册中心eureka的使用上，接下来可以创建服务提供者provider来注册到eureka。demo源码见： https:/
- java联调生成测试数据工具类在日常的联调中，我们经常需要准备一定数量的测试数据，用来配合前端测试。当然对于简单的数据类型完全可以通过 JD
- session对象用于在会话范围内，记录每个客户端的访问状态，以便于跟踪每个客户端的操作状态，在会话存储的信息，在浏览器发出后续请求时可以获
- Android Studio 在引用外部依赖时，发现一直无法引用外部依赖。刚开始以为是墙的问题，尝试修改Gradle配置，未解决问题。最终发
- 一次正常的请求最近别人需要调用我们系统的某一个功能，对方希望提供一个api让其能够更新数据。由于该同学是客户端开发，于是有了类似以下代码。@
- 1.前提已经配置Sleuth，可参考2.什么是Zipkin?官网:https://zipkin.io/大规模分布式系统的APM工具( App
- 问题在使用 Abp 框架的后台作业时，当后台作业抛出异常，会导致整个程序崩溃。在 Abp 框架的底层执行后台作业的时候，有 try/catc
- springboot开启事务很简单，只需要一个注解@Transactional 就可以了。因为在springboot中已经默认对jpa、jd
- Google 发布的Material Design支持库，对我们的APP设计有很大的影响，如果重新设计APP，支持库应该直接用V4提升到V7
- 本节了解一下 SpringBoot 中 Web 开发的静态资源导入和首页设置，对应 SpringBoot-03-Web 项目。1. 静态资源
- 前提在日常使用SpringMVC进行开发的时候，有可能遇到前端各种类型的请求参数，这里做一次相对全面的总结。SpringMVC中处理控制器参
