看看人家那后端API接口写得，那叫一个优雅！

╰半夏微凉° 2022-12-20 02:51 145阅读 0赞

# 前言 #

在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了）。

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

![c03fd4357bc1027bfd048ba7d7e1f65c.png][]

> 需要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太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 - 内部服务器错误

![20201110094015932.gif][]

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

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

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

**Message**

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

![4a26bff1fb6583bfe4800b0cf5d8acf0.png][]

再在枚举中定义，状态码

![9ecd0d7cac4d2d0a8d10fc5fa8eda725.png][]

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

**Data**

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

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

![cc8db694b7247df750439af5c0419f17.png][]

# 控制层Controller #

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

![38356ed3be483a84c03b63359f189a3e.png][]

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

# 美观美化 #

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

![6713c516505ea2a80d8dafc55658e9fc.png][]

那我们来改造一下Controller

![fb0406333c8e392d0125f2f6a78a1190.png][]

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

# 优雅优化 #

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

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

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

![3a8d5f3409850e2bbf0aaf269cce63cc.png][]

这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。那实现方案是什么呢？

# 实现方案 #

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

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

**注解类**

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

![6914fe1ebbd347fd40d17b54e4374075.png][]

**拦截器**

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

![a4d1237d5d19ecc97ecf7095c61d485b.png][]

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

**重写返回体**

![941b7fe8856734ce3f5afcce8ee89606.png][]

![20201110094015939.gif][]上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断body是否为异常类。

![1881e707d8d0b2a1399f32d2f13f7eb3.png][]![20201110094015944.gif][]

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

**重写Controller**

![fcd91a83bfcde7c4785dcbcc2bbfd951.png][]

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

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

[c03fd4357bc1027bfd048ba7d7e1f65c.png]: /images/20221120/f926614fb8894819b0daa298beb6b9d7.png
[20201110094015932.gif]: https://img-blog.csdnimg.cn/20201110094015932.gif
[4a26bff1fb6583bfe4800b0cf5d8acf0.png]: https://img-blog.csdnimg.cn/img_convert/4a26bff1fb6583bfe4800b0cf5d8acf0.png
[9ecd0d7cac4d2d0a8d10fc5fa8eda725.png]: https://img-blog.csdnimg.cn/img_convert/9ecd0d7cac4d2d0a8d10fc5fa8eda725.png
[cc8db694b7247df750439af5c0419f17.png]: https://img-blog.csdnimg.cn/img_convert/cc8db694b7247df750439af5c0419f17.png
[38356ed3be483a84c03b63359f189a3e.png]: https://img-blog.csdnimg.cn/img_convert/38356ed3be483a84c03b63359f189a3e.png
[6713c516505ea2a80d8dafc55658e9fc.png]: https://img-blog.csdnimg.cn/img_convert/6713c516505ea2a80d8dafc55658e9fc.png
[fb0406333c8e392d0125f2f6a78a1190.png]: https://img-blog.csdnimg.cn/img_convert/fb0406333c8e392d0125f2f6a78a1190.png
[3a8d5f3409850e2bbf0aaf269cce63cc.png]: https://img-blog.csdnimg.cn/img_convert/3a8d5f3409850e2bbf0aaf269cce63cc.png
[6914fe1ebbd347fd40d17b54e4374075.png]: https://img-blog.csdnimg.cn/img_convert/6914fe1ebbd347fd40d17b54e4374075.png
[a4d1237d5d19ecc97ecf7095c61d485b.png]: https://img-blog.csdnimg.cn/img_convert/a4d1237d5d19ecc97ecf7095c61d485b.png
[941b7fe8856734ce3f5afcce8ee89606.png]: https://img-blog.csdnimg.cn/img_convert/941b7fe8856734ce3f5afcce8ee89606.png
[20201110094015939.gif]: https://img-blog.csdnimg.cn/20201110094015939.gif
[1881e707d8d0b2a1399f32d2f13f7eb3.png]: https://img-blog.csdnimg.cn/img_convert/1881e707d8d0b2a1399f32d2f13f7eb3.png
[20201110094015944.gif]: https://img-blog.csdnimg.cn/20201110094015944.gif
[fcd91a83bfcde7c4785dcbcc2bbfd951.png]: https://img-blog.csdnimg.cn/img_convert/fcd91a83bfcde7c4785dcbcc2bbfd951.png