脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot统一返回结果

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

注意：以上自定义返回结果的例子需要自行根据实际情况添加，文章中的例子并不能实现

总结

只要按照上面一步步改造，即可实现统一返回结果，既规范、又优雅，也可根据自己所需添加对应的属性和数据。还等什么，搞起来吧~

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Java编程利用socket多线程访问服务器文件代码示例

    Java编程利用socket多线程访问服务器文件代码示例

    这篇文章主要介绍了Java编程利用socket多线程访问服务器文件代码示例，具有一定参考价值，需要的朋友可以了解下。
    2017-10-10
  • mybatis注入Date日期值为null的解决方法

    mybatis注入Date日期值为null的解决方法

    这篇文章主要给大家介绍了关于mybatis注入Date日期值为null的解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • SpringMVC实现自定义类型转换器

    SpringMVC实现自定义类型转换器

    本篇文章主要介绍了SpringMVC实现自定义类型转换器 ，详细的介绍了自定义类型转换器的用法和好处，有兴趣的可以了解一下。
    2017-04-04
  • java实现遍历树形菜单两种实现代码分享

    java实现遍历树形菜单两种实现代码分享

    这篇文章主要介绍了java实现遍历树形菜单两种实现代码分享，两种实现：OpenSessionView实现、TreeAction实现。具有一定参考价值，需要的朋友可以了解下。
    2017-11-11
  • Java结构型设计模式之享元模式示例详解

    Java结构型设计模式之享元模式示例详解

    享元模式（FlyWeight Pattern），也叫蝇量模式，运用共享技术，有效的支持大量细粒度的对象，享元模式就是池技术的重要实现方式。本文将通过示例详细讲解享元模式，感兴趣的可以了解一下
    2022-09-09
  • Java使用反射生成JDK代理示例

    Java使用反射生成JDK代理示例

    这篇文章主要介绍了Java使用反射生成JDK代理,结合实例形式分析了java基于反射实现jdk动态代理相关操作技巧,需要的朋友可以参考下
    2019-07-07
  • Java实现微信发红包

    Java实现微信发红包

    这篇文章主要为大家详细介绍了Java实现微信发红包，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-12-12
  • Java 程序设计总复习题(java基础代码)

    Java 程序设计总复习题(java基础代码)

    这篇文章主要介绍了Java 程序设计总复习题，主要是java基础代码，方便学习java的同学
    2021-05-05
  • Java螺旋矩阵处理方法详解

    Java螺旋矩阵处理方法详解

    螺旋矩阵是指一个呈螺旋状的矩阵，它的数字由第一行开始到右边不断变大，向下变大，向左变大，向上变大，如此循环。利用java实现的螺旋矩阵，当输入N之后，会自动打印出螺旋矩阵
    2022-09-09
  • JAVA解析XML字符串简单方法代码案例

    JAVA解析XML字符串简单方法代码案例

    这篇文章主要介绍了JAVA解析XML字符串简单方法代码案例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09

最新评论