SpringBoot 返回统一格式

在前后端分离的项目中后端返回的格式一定要友好，不然会对前端的开发人员带来很多的工作量。那么SpringBoot如何做到统一的后端返回格式呢？今天我们一起来看看。

为什么要对SpringBoot返回统一的标准格式

在默认情况下，SpringBoot的返回格式常见的有三种：

返回String

  1. @GetMapping("/hello")
  2. public String hello() {
  3. return "hello";
  4. }

此时调用接口获取到的返回值是这样：

hello

返回自定义对象

  1. @GetMapping("/student")
  2. public Student getStudent() {
  3. Student student = new Student();
  4. student.setId(1);
  5. student.setName("didiplus");
  6. return student;
  7. }
  9. //student的类
  10. @Data
  11. public class Student {
  12. private Integer id;
  13. private String name;
  14. }

此时调用接口获取到的返回值是这样：

{"id":1,"name":"didiplus"}

接口异常

  1. @GetMapping("/error")
  2. public int error(){
  3. int i = 9/0;
  4. return i;
  5. }

此时调用接口获取到的返回值是这样：

SpringBoot的版本是v2.6.7，

定义返回对象

  1. package com.didiplus.common.web.response;
  3. import lombok.Data;
  5. import java.io.Serializable;
  7. /**
  8. * Author: didiplus
  9. * Email: 972479352@qq.com
  10. * CreateTime: 2022/4/24
  11. * Desc: Ajax 返 回 JSON 结 果 封 装 数 据
  12. */
  14. @Data
  15. public class Result<T> implements Serializable {
  17. /**
  18. * 是否返回成功
  19. */
  20. private boolean success;
  22. /**
  23. * 错误状态
  24. */
  25. private int code;
  27. /***
  28. * 错误信息
  29. */
  30. private String msg;
  32. /**
  33. * 返回数据
  34. */
  35. private T data;
  37. /**
  38. * 时间戳
  39. */
  40. private long timestamp ;
  42. public Result (){
  43. this.timestamp = System.currentTimeMillis();
  44. }
  45. /**
  46. * 成功的操作
  47. */
  48. public static <T> Result<T> success() {
  49. return success(null);
  50. }
  52. /**
  53. * 成 功 操 作 , 携 带 数 据
  54. */
  55. public static <T> Result<T> success(T data){
  56. return success(ResultCode.RC100.getMessage(),data);
  57. }
  59. /**
  60. * 成 功 操 作, 携 带 消 息
  61. */
  62. public static <T> Result<T> success(String message) {
  63. return success(message, null);
  64. }
  66. /**
  67. * 成 功 操 作, 携 带 消 息 和 携 带 数 据
  68. */
  69. public static <T> Result<T> success(String message, T data) {
  70. return success(ResultCode.RC100.getCode(), message, data);
  71. }
  73. /**
  74. * 成 功 操 作, 携 带 自 定 义 状 态 码 和 消 息
  75. */
  76. public static <T> Result<T> success(int code, String message) {
  77. return success(code, message, null);
  78. }
  80. public static <T> Result<T> success(int code,String message,T data) {
  81. Result<T> result = new Result<T>();
  82. result.setCode(code);
  83. result.setMsg(message);
  84. result.setSuccess(true);
  85. result.setData(data);
  86. return result;
  87. }
  89. /**
  90. * 失 败 操 作, 默 认 数 据
  91. */
  92. public static <T> Result<T> failure() {
  93. return failure(ResultCode.RC100.getMessage());
  94. }
  96. /**
  97. * 失 败 操 作, 携 带 自 定 义 消 息
  98. */
  99. public static <T> Result<T> failure(String message) {
  100. return failure(message, null);
  101. }
  103. /**
  104. * 失 败 操 作, 携 带 自 定 义 消 息 和 数 据
  105. */
  106. public static <T> Result<T> failure(String message, T data) {
  107. return failure(ResultCode.RC999.getCode(), message, data);
  108. }
  110. /**
  111. * 失 败 操 作, 携 带 自 定 义 状 态 码 和 自 定 义 消 息
  112. */
  113. public static <T> Result<T> failure(int code, String message) {
  114. return failure(ResultCode.RC999.getCode(), message, null);
  115. }
  117. /**
  118. * 失 败 操 作, 携 带 自 定 义 状 态 码 , 消 息 和 数 据
  119. */
  120. public static <T> Result<T> failure(int code, String message, T data) {
  121. Result<T> result = new Result<T>();
  122. result.setCode(code);
  123. result.setMsg(message);
  124. result.setSuccess(false);
  125. result.setData(data);
  126. return result;
  127. }
  129. /**
  130. * Boolean 返 回 操 作, 携 带 默 认 返 回 值
  131. */
  132. public static <T> Result<T> decide(boolean b) {
  133. return decide(b, ResultCode.RC100.getMessage(), ResultCode.RC999.getMessage());
  134. }
  136. /**
  137. * Boolean 返 回 操 作, 携 带 自 定 义 消 息
  138. */
  139. public static <T> Result<T> decide(boolean b, String success, String failure) {
  140. if (b) {
  141. return success(success);
  142. } else {
  143. return failure(failure);
  144. }
  145. }
  146. }

定义状态码

  1. package com.didiplus.common.web.response;
  3. import lombok.Getter;
  5. /**
  6. * Author: didiplus
  7. * Email: 972479352@qq.com
  8. * CreateTime: 2022/4/24
  9. * Desc: 统 一 返 回 状 态 码
  10. */
  11. public enum ResultCode {
  12. /**操作成功**/
  13. RC100(100,"操作成功"),
  14. /**操作失败**/
  15. RC999(999,"操作失败"),
  16. /**服务限流**/
  17. RC200(200,"服务开启限流保护,请稍后再试!"),
  18. /**服务降级**/
  19. RC201(201,"服务开启降级保护,请稍后再试!"),
  20. /**热点参数限流**/
  21. RC202(202,"热点参数限流,请稍后再试!"),
  22. /**系统规则不满足**/
  23. RC203(203,"系统规则不满足要求,请稍后再试!"),
  24. /**授权规则不通过**/
  25. RC204(204,"授权规则不通过,请稍后再试!"),
  26. /**access_denied**/
  27. RC403(403,"无访问权限,请联系管理员授予权限"),
  28. /**access_denied**/
  29. RC401(401,"匿名用户访问无权限资源时的异常"),
  30. /**服务异常**/
  31. RC500(500,"系统异常，请稍后重试"),
  33. INVALID_TOKEN(2001,"访问令牌不合法"),
  34. ACCESS_DENIED(2003,"没有权限访问该资源"),
  35. CLIENT_AUTHENTICATION_FAILED(1001,"客户端认证失败"),
  36. USERNAME_OR_PASSWORD_ERROR(1002,"用户名或密码错误"),
  37. UNSUPPORTED_GRANT_TYPE(1003, "不支持的认证模式");
  39. /**自定义状态码**/
  40. @Getter
  41. private final int code;
  43. /**
  44. * 携 带 消 息
  45. */
  46. @Getter
  47. private final String message;
  48. /**
  49. * 构 造 方 法
  50. */
  51. ResultCode(int code, String message) {
  53. this.code = code;
  55. this.message = message;
  56. }
  57. }

统一返回格式

  1. @GetMapping("/hello")
  2. public Result<String> hello() {
  3. return Result.success("操作成功","hello");
  4. }

此时调用接口获取到的返回值是这样：

  1. {"success":true,"code":100,"msg":"操作成功","data":"hello","timestamp":1650785058049}

这样确实已经实现了我们想要的结果，我在很多项目中看到的都是这种写法，在Controller层通过Result.success()对返回结果进行包装后返回给前端。这样显得不够专业而且不够优雅。 所以呢我们需要对代码进行优化，目标就是不要每个接口都手工制定Result返回值。

高级实现方式

要优化这段代码很简单，我们只需要借助SpringBoot提供的ResponseBodyAdvice即可。

ResponseBodyAdvice的源码：

  1. public interface ResponseBodyAdvice<T> {
  2. /**
  3. * 是否支持advice功能
  4. * true 支持，false 不支持
  5. */
  6. boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);
  8. /**
  9. * 对返回的数据进行处理
  10. */
  11. @Nullable
  12. T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
  13. }

只需要编写一个具体实现类即可

  1. @RestControllerAdvice
  2. public class ResponseAdvice implements ResponseBodyAdvice<Object> {
  4. @Autowired
  5. ObjectMapper objectMapper;
  7. @Override
  8. public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
  9. return true;
  10. }
  12. @SneakyThrows
  13. @Override
  14. public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
  15. if (body instanceof String){
  16. return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body));
  17. }
  18. return Result.success(ResultCode.RC100.getMessage(),body);
  19. }
  20. }

需要注意两个地方：

@RestControllerAdvice注解 @RestControllerAdvice是@RestController注解的增强，可以实现三个方面的功能：

  1. 全局异常处理
  2. 全局数据绑定
  3. 全局数据预处理

String类型判断

  1. if (body instanceof String){
  2. return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body));
  3. }

这段代码一定要加，如果Controller直接返回String的话，SpringBoot是直接返回，故我们需要手动转换成json。 经过上面的处理我们就再也不需要通过ResultData.success()来进行转换了，直接返回原始数据格式，SpringBoot自动帮我们实现包装类的封装。

  1. @GetMapping("/hello")
  2. public String hello() {
  3. return "hello,didiplus";
  4. }
  6. @GetMapping("/student")
  7. public Student getStudent() {
  8. Student student = new Student();
  9. student.setId(1);
  10. student.setName("didiplus");
  11. return student;
  12. }

此时我们调用接口返回的数据结果为：

  1. {
  2. "success": true,
  3. "code": 100,
  4. "msg": "操作成功",
  5. "data": "hello,didiplus",
  6. "timestamp": 1650786993454
  7. }
 
posted @ 2023-02-24 17:00  甜菜波波  阅读(504)  评论(0)    收藏  举报