如何优雅设计 API 接口，实现统一格式返回？

谁借莪１个温暖的怀抱￠ 2023-07-23 11:55 23阅读 0赞

前言

在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，

（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了）

一般系统的大致整体架构图如下：

![format_png][]

image

> 需要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太low了，什么网关啊，缓存啊，消息中间件啊，都没有。
> 
> 因为老顾这篇主要介绍的是API接口，所以我们聚焦点，其他的模块小伙伴们自行去补充。

# 接口交互 #

前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。

> 针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app\_version,api\_version,device等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。

后端服务器如何实现把数据返回给前端？

# 返回格式 #

后端返回给前端我们一般用JSON体方式，定义如下：

{
      #返回状态码
      code:integer,
      #返回信息描述
      message:string,
      #返回值
      data:object
    }

**CODE状态码**

code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。

如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了

我们应该可以参考HTTP请求返回的状态码

：下面是常见的HTTP状态码：
    200 - 请求成功
    301 - 资源（网页等）被永久转移到其它URL
    404 - 请求的资源（网页等）不存在
    500 - 内部服务器错误

![format_png 1][]

image

我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成4位数。

#1000～1999 区间表示参数错误
    #2000～2999 区间表示用户错误
    #3000～3999 区间表示接口异常

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。

**Message**

这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和code状态码一起设计，如：

![format_png 2][]

image

再在枚举中定义，状态码

![format_png 3][]

image

状态码和信息就会一一对应，比较好维护。

**Data**

返回数据体，JSON格式，根据不同的业务又不同的JSON体。

我们要设计一个返回体类Result

![format_png 4][]

image

# 控制层Controller #

我们会在controller层处理业务请求，并返回给前端，以order订单为例

![format_png 5][]

image

我们看到在获得order对象之后，我们是用的Result构造方法进行包装赋值，然后进行返回。小伙伴们有没有发现，构造方法这样的包装是不是很麻烦，我们可以优化一下。

# 美观美化 #

我们可以在Result类中，加入静态方法，一看就懂

![format_png 6][]

image

那我们来改造一下Controller

![format_png 7][]

image

代码是不是比较简洁了，也美观了。

# 优雅优化 #

上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：

> 1.  每个方法的返回都是Result封装对象，没有业务含义
> 
> 1.  在业务代码中，成功的时候我们调用Result.success，异常错误调用Result.failure。是不是很多余
> 
> 1.  上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图：

![format_png 8][]

image

这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。

那实现方案是什么呢？

# 实现方案 #

小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情

> 1.  定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下
> 
> 1.  拦截请求，判断此请求是否需要被@ResponseResult注解
> 
> 1.  核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。

**注解类**

用来标记方法的返回值，是否需要包装

![format_png 9][]

image

**拦截器**

拦截请求，是否此请求返回的值需要包装，其实就是运行的时候，解析@ResponseResult注解

![format_png 10][]

image

此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。

**重写返回体**

![format_png 11][]

image

上面代码就是判断是否需要返回值包装，如果需要就直接包装。

这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断body是否为异常类。

![format_png 12][]

image

怎么做全局的异常处理，篇幅原因，老顾这里就不做介绍了，只要思路理清楚了，自行改造就行。

**重写Controller**

![format_png 13][]

image

在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了，简单吧。到此返回的设计思路完成，是不是又简洁，又优雅。

这个方案还有没有别的优化空间，当然是有的。

如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。

[format_png]: /images/20230528/60ad4cdc350046ee97658d8224752c79.png
[format_png 1]: /images/20230528/28f82298f5b74499b377432a1d11f003.png
[format_png 2]: /images/20230528/baf9fa4bab284af5b98e3fff3c757f03.png
[format_png 3]: /images/20230528/ddfd3c1b44ae48789cb5737870c88bb2.png
[format_png 4]: /images/20230528/f8d723befe154ab2ae8d5152c43f4e24.png
[format_png 5]: /images/20230528/8edacaefadb047b6acf3a44440b26f75.png
[format_png 6]: /images/20230528/cdd75684134f4184ac4bf578d1d4077e.png
[format_png 7]: /images/20230528/5ff3bad49cd845dcb28c27118f553932.png
[format_png 8]: /images/20230528/79b0bf6732e043cf9aea87f9e1cb2145.png
[format_png 9]: /images/20230528/1fa052b767df4ad9b7f20d39845578d9.png
[format_png 10]: /images/20230528/a6a131a9bbef4f53bb38e13a447ee124.png
[format_png 11]: /images/20230528/846c93885b94451796a686eb34335d4c.png
[format_png 12]: /images/20230528/876879b76a394bed8cb631b9a5775e5a.png
[format_png 13]: /images/20230528/ad052a17e41f4b5287f3346c6eba32be.png