SpringBoot统一返回结果问题
更新时间：2023年07月21日 14:31:27 作者：阿信爸
这篇文章主要介绍了SpringBoot统一返回结果问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
目前很多项目都是前后端分离，前后端会事先约定好返回格式，前端如果使用axios的话，会在全局过滤器里进行校验，那么后端如何做，才能优雅的返回固定的统一格式呢，接下来我会带着你一步步实现。
1. 直接返回结果
先看一下最基本的例子，直接将结果原封不动返回：
@Data
@AllArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class TestVo {
private static final long serialVersionUID = 1L;
@Schema(name = "姓名")
private String name;
@Schema(name = "年龄")
private Integer age;
}@RestController
@RequestMapping(value = "/test")
public class TestApi {
@GetMapping("/simple")
public TestVo simple() {
TestVo testVo = new TestVo("张三", 30);
return testVo;
}
}返回结果：
{
"name": "张三",
"age": 30
}2. 约定返回格式
假如与前端开发妹子约定好了格式，比如：
{
"code": 0,
"msg": "错误信息",
"data": 实际返回结果
}那么我们首先需要编写一个封装结果类Result，为了方便封装，我们再提供一个success方法：
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Result<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 返回编码
*/
private Integer code;
/**
* 编码描述
*/
private String msg;
/**
* 业务数据
*/
private T data;
/**
* 返回成功结果对象
*
* @param data
* @param <T>
* @return
*/
public static <T> Result<T> success(T data) {
Result result = new Result();
result.setCode(0);
result.setMsg("success");
result.setData(data);
return result;
}
}3. 返回统一格式结果
后台接口代码微调一下即可，返回值改为Result，泛型为原返回值的类型：
@RestController
@RequestMapping(value = "/test")
public class TestApi {
@GetMapping("/withResult")
public Result<TestVo> withResult() {
TestVo testVo = new TestVo("张三", 30);
return Result.success(testVo);
}
}返回结果：
{
"code": 0,
"msg": "success",
"data": {
"name": "张三",
"age": 30
}
}至此，后端返回结果完美符合格式，但是每个接口的返回值都是Result<>，并且return的时候都要用success方法封装一下，不够优雅，怎么办？我们继续看：
4. 切片封装统一格式
编写注解
实际使用场景中，并不是所有接口都能完美的统一格式，使用注解可以按需控制接口返回格式。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ApiResult {
String value() default "";
int successCode() default 0;
String successMsg() default "success";
Class<? extends IResult> resultClass() default Result.class;
}编写ControllerAdvice
@Order(0)
@ControllerAdvice
public class MyResponseBodyAdvice implements ResponseBodyAdvice {
protected boolean isStringConverter(Class converterType) {
return converterType.equals(StringHttpMessageConverter.class);
}
protected boolean isApiResult(MethodParameter returnType) {
return returnType.hasMethodAnnotation(ApiResult.class);
}
@Override
public boolean supports(MethodParameter returnType, Class converterType) {
return !isStringConverter(converterType) && isApiResult(returnType);
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
//关键
return Result.success(body);
}
}这里有一点要注意，这个advice中supports方法中判断返回结果类型必须为非String类型。如果返回结果为String类型，那么result要转为json字符串后再返回，需要再写一个advice。
接下来见证奇迹的时刻到了
@ApiResult
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("张三", 30);
return testVo;
}这段代码与直接返回结果的一样，仅仅加上了@ApiResult注解，我们看返回结果：
{
"code": 0,
"msg": "success",
"data": {
"name": "张三",
"age": 30
}
}大功告成！
以上只是最精简的例子，实际使用中还结合了 统一异常封装、自定义返回格式 等功能。
我们注意到@ApiResult注解中，有三个参数：successCode、successMsg、resultClass，就是为了自定义返回格式预留的，
下面看个例子：
5. 自定义返回格式
返回成功时code为200
如果个别接口的返回格式与默认格式相同，但是要求code等于200代表成功，那么修改下successCode参数即可：
@ApiResult(successCode = 200, successMsg = "ok")
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("张三", 30);
return testVo;
}我们发现，返回成功时，结果中的code和msg都变为设置的值：
{
"code": 200,
"msg": "ok",
"data": {
"name": "张三",
"age": 30
}
}自定义返回格式
如果个别的接口返回格式不是默认的返回格式，那么我们需要新增一个返回结果类，比如ReturnResult，里面包含returnCode、returnDesc、data三个属性：
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ReturnResult<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 返回编码
*/
private String returnCode;
/**
* 编码描述
*/
private String returnDesc;
/**
* 业务数据
*/
private T data;
/**
* 返回成功结果对象
*
* @param data
* @param <T>
* @return
*/
public static <T> ReturnResult<T> success(T data) {
ReturnResult result = new ReturnResult();
result.setReturnCode(0);
result.setReturnDesc("success");
result.setData(data);
return result;
}
}然后修改接口上的@ApiResult注解中的resultClass属性
@ApiResult(resultClass = ReturnResult.class)
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("张三", 30);
return testVo;
}这时，返回结果变为如下：
{
"returnCode": "0",
"returnDesc": "success",
"data": {
"name": "张三",
"age": 30
}
}注意：以上自定义返回结果的例子需要自行根据实际情况添加，文章中的例子并不能实现
总结
只要按照上面一步步改造，即可实现统一返回结果，既规范、又优雅，也可根据自己所需添加对应的属性和数据。还等什么，搞起来吧~
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了springcloud pom.xml完整配置，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-12-12
Spring-IOC容器-Bean管理-基于XML方式超详解
这篇文章主要介绍了Spring为IOC容器Bean的管理,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2021-08-08
今天小编就为大家分享一篇Java判断List中有无重复元素的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2018-07-07
最简单的MyBatis Plus的多表联接、分页查询实现方法
这篇文章主要介绍了最简单的MyBatis Plus的多表联接、分页查询实现方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-11-11
这篇文章主要介绍了浅谈一下Java中的几种JVM级别的锁,当存在安全漏洞时，也必须有相应的防护措施。顺应这种趋势，虚拟"锁"被发明出来，以解决线程的安全问题。在这篇文章中，我们将研究多年来出现的 Java 中几种典型的 JVM 级锁,需要的朋友可以参考下2023-08-08
这篇文章主要介绍了Java反射的应用之动态代理深入理解，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-09-09
深度解析Java中的国际化底层类ResourceBundle
做项目应该都会实现国际化，那么大家知道Java底层是如何实现国际化的吗？这篇文章就来和大家深度解析一下Java中的国际化底层类ResourceBundle，希望对大家有所帮助2023-03-03
本文主要介绍了Springboot自带线程池的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-05-05
使用Spring初始化加载InitializingBean()方法
这篇文章主要介绍了使用Spring初始化加载InitializingBean()方法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-01-01
今天给大家带来的知识是关于Java的,文章围绕Java是如何通过接口来创建代理并进行http请求展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下2021-06-06
最新评论