Spring Boot接口返回同一格式

同一的标准数据格式好处

SpringBoot返回同一的标准数据格式主要有以下几点好处：

• 加强接口的可读性和可维护性，使得前端开辟职员可以或许更加清楚地明白接口返回的数据结构，从而提高开辟服从。
  
• 降低前后端耦合度，当后端需要修改返回数据结构时，只需要调整同一的数据格式，而不用修改大量的前端代码。
  
• 有利于同一异常处理，对于堕落时的返回数据格式也是同等的，便于前端同一处理错误信息。
  
• 当接口版本的升级和兼容时，可以通过同一的数据格式进行向下兼容大概向上兼容，减少接口变更带来的影响
  

格式不同的痛楚

一般情况下，SpringBoot服务的返回格式有如下几种：
第一种：返回String

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

复制代码

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

1. hello

复制代码

第二种：返回自界说对象

1. @GetMapping("/aniaml")
2. public Aniaml getAniaml(){
3.   Aniaml aniaml = new Aniaml(1,"pig");
4.   return aniaml;
5. }

复制代码

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

1. {
2.   "id": 1,
3.   "name": "pig"
4. }

复制代码

第三种：接口异常

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

复制代码

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

1. {
2.   "timestamp": "2021-07-08T08:05:15.423+00:00",
3.   "status": 500,
4.   "error": "Internal Server Error",
5.   "path": "/error"
6. }

复制代码

看了上边的几种情况，不难发现，一个接口在不同情况下，返回的数据格式竟然截然不同？那作为API的使用方估计就要骂娘了。此时，返回同一的标准数据格式就显得很有必要。
标准格式

一个标准的返回格式应包含以下三部分：

• Status（状态）：由后端同一界说各种返回结果的状态码。
  
• Message（描述）：描述本次接口调用的结果信息。
  
• Data（数据）：包含本次返回的详细数据内容。
  

1. {  "status":"100",  "message":"操作乐成",  "data":"hello
2. "}

复制代码

当然了这并不是绝对的，在有了主要的字段后，可以按需加入其他扩展值，比如我们就在返回对象中添加了接口调用时间timestamp等。
界说返回对象

1. @Data
2. public class ResultData<T> {
5. private int status;
6.   private String message;
7.   private T data;
8.   private long timestamp ;
13.   public ResultData (){
14.     this.timestamp = System.currentTimeMillis();
15.   }
20.   public static <T> ResultData<T> success(T data) {
21.     ResultData<T> resultData = new ResultData<>();
22.     resultData.setStatus(ReturnCode.RC100.getCode());
23.     resultData.setMessage(ReturnCode.RC100.getMessage());
24.     resultData.setData(data);
25.     return resultData;
26.   }
29.   public static <T> ResultData<T> fail(int code, String message) {
30.     ResultData<T> resultData = new ResultData<>();
31.     resultData.setStatus(code);
32.     resultData.setMessage(message);
33.     return resultData;
34.   }
37. }

复制代码

界说状态码

1. public enum ReturnCode {
2.     /**操作成功**/
3.     RC100(100,"操作成功"),
4.     /**操作失败**/
5.     RC999(999,"操作失败"),
6.     /**服务限流**/
7.     RC200(200,"服务开启限流保护,请稍后再试!"),
8.     /**服务降级**/
9.     RC201(201,"服务开启降级保护,请稍后再试!"),
10.     /**热点参数限流**/
11.     RC202(202,"热点参数限流,请稍后再试!"),
12.     /**系统规则不满足**/
13.     RC203(203,"系统规则不满足要求,请稍后再试!"),
14.     /**授权规则不通过**/
15.     RC204(204,"授权规则不通过,请稍后再试!"),
16.     /**access_denied**/
17.     RC403(403,"无访问权限,请联系管理员授予权限"),
18.     /**access_denied**/
19.     RC401(401,"匿名用户访问无权限资源时的异常"),
20.     /**服务异常**/
21.     RC500(500,"系统异常，请稍后重试"),
24.     CLIENT_AUTHENTICATION_FAILED(1001,"客户端认证失败"),
25.     USERNAME_OR_PASSWORD_ERROR(1002,"用户名或密码错误"),
26.     UNSUPPORTED_GRANT_TYPE(1003, "不支持的认证模式");
29.     /**自定义状态码**/
30.     private final int code;
31.     /**自定义描述**/
32.     private final String message;
35.     ReturnCode(int code, String message){
36.         this.code = code;
37.         this.message = message;
38.     }
43.     public int getCode() {
44.         return code;
45.     }
48.     public String getMessage() {
49.         return message;
50.     }
51. }

复制代码

同一返回格式

经过上边我们界说的数据格式，再次调用API，在Controller层通过ResultData.success()对返回结果进行包装后返回给前端。

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

复制代码

此时调用接口获取到的返回值已经是标准的格式，符合我们预期的效果。

1. {  "status": 100,  "message": "hello
2. ",  "data": null,  "timestamp": 1625736481648}

复制代码

最大的毛病就是我们后面每写一个接口都需要调用ResultData.success()这行代码对结果进行包装，重复劳动，浪费体力；而且还很容易被其他老鸟给嘲笑。所以呢我们需要对代码进行优化，目的就是不要每个接口都手工制定ResultData返回值。
高级实现方式

要优化这段代码很简单，我们只需要借助SpringBoot提供的ResponseBodyAdvice即可。
   “
ResponseBodyAdvice的作用：拦截Controller方法的返回值，同一处理返回值/响应体，一般用来同一返回格式，加解密，署名等等。
”
先来看下ResponseBodyAdvice的源码：

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

复制代码

我们只需要编写一个详细实现类即可

1. /**
2.  * @author jam
3.  * @date 2021/7/8 10:10 上午
4.  */
5. @RestControllerAdvice
6. public class ResponseAdvice implements ResponseBodyAdvice<Object> {
7.     @Autowired
8.     private ObjectMapper objectMapper;
11.     @Override
12.     public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
13.         return true;
14.     }
17.     @SneakyThrows
18.     @Override
19.     public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
20.         if(o instanceof String){
21.             return objectMapper.writeValueAsString(ResultData.success(o));
22.         }        
23.         return ResultData.success(o);
24.     }
25. }

复制代码

需要注意两个地方：
@RestControllerAdvice注解

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

• 全局异常处理
  
• 全局数据绑定
  
• 全局数据预处理
  

• String范例判定
  

1. if(o instanceof String){
2.   return objectMapper.writeValueAsString(ResultData.success(o));
3. } 

复制代码

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

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

复制代码

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

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

复制代码

是不是感觉很完美，别急，还有个问题在等着你呢。
接口异常问题
此时有个问题，由于我们没对Controller的异常进行处理，当我们调用的方法一旦出现异常，就会出现问题，比如下面这个接口：

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

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。