干货 | 看看人家那后端API接口写得，那叫一个得劲

╰半夏微凉° 2022-12-28 08:29 88阅读 0赞

点击上方“程序猿技术大咖”，关注加群讨论

一般系统大致架构如下：

![format_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 - 内部服务器错误

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

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

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

**Message**

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

![format_png 1][]

再在枚举中定义，状态码：

![format_png 2][]

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

**Data**

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

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

![format_png 3][]

**控制层Controller**

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

![format_png 4][]

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

# **美观美化** #

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

![format_png 5][]

那我们来改造一下Controller：

![format_png 6][]

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

# **优雅优化** #

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

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

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

![format_png 7][]

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

# **实现方案** #

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

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

**注解类**

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

![format_png 8][]

**拦截器**

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

![format_png 9][]

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

**重写返回体**

![format_png 10][]

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

![format_png 11][]

**重写Controller**

![format_png 12][]

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

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

![format_png 13][]

*  [JDK1.8新特性(四)：函数式接口][JDK1.8]
 *  [金融科技 | 建设中台能力，助力开放生态][Link 1]
 *  [Kubernetes决定弃用Docker，到底会影响到谁？][Kubernetes_Docker]  
    
 *  [MySQL性能优化(七)：MySQL执行计划，真的很重要，来一起学习吧][MySQL_MySQL]
 *  [微服务架构下的核心话题 (三)：微服务架构的技术选型][Link 2]

![format_png 14][]

喜欢就点个"在看"呗，留言、转发朋友圈

[format_png]: /images/20221120/2680ac3b8c66493691008b04e1419e2b.png
[format_png 1]: /images/20221120/4192c95196b646959d5eb7285b44d503.png
[format_png 2]: /images/20221120/40fe2a2e82384d9c8358b4be2b4fba5d.png
[format_png 3]: /images/20221120/45b66085008c4deab2759b3241772bbf.png
[format_png 4]: /images/20221120/d60b2312c98245e1b2a8e371ef2b9ab1.png
[format_png 5]: /images/20221120/cede8fd428a24a8aa969489491802f11.png
[format_png 6]: /images/20221120/52b7dc5c0f8c45c0b59db4bb50ee1157.png
[format_png 7]: /images/20221120/22aa297827e74f89a52eb1c4713fe122.png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L2hVekV6NkJtY2FwMk4yS1c3MVVBMzZnMUxheTNiYlhLaWF4MFNjcUxwalpvM2JRVVNpY1RyVERSRDhXdmJTUURBYURXWHgwT2VEQWdwVGVGdWJ2c2dyYmcvNjQw?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L2hVekV6NkJtY2FwMk4yS1c3MVVBMzZnMUxheTNiYlhLU2QwN1R0ZzNEeHc0ZFFWN1EwOGFKT1ZZT3Awc0ZGaWJ4NUpJOEh6ZkE2UXpTeWljSEtWMGRHaWFRLzY0MA?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L2hVekV6NkJtY2FwMk4yS1c3MVVBMzZnMUxheTNiYlhLeFFQbTVzNlFvak5RaE1wZzhvaE1wUllwOGhid1hMZHRnUEtNTWNrNUtOcHdmNklhWG92aWJYZy82NDA?x-oss-process=image/format,png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L2hVekV6NkJtY2FwMk4yS1c3MVVBMzZnMUxheTNiYlhLeTJpYkZLVXJNb05qOVFlaWMzYkJhaG5NYktDWU1vZGg5ZU9WMXF2cUV2cnA3RDRTOWljQXlCR21RLzY0MA?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L2hVekV6NkJtY2FwMk4yS1c3MVVBMzZnMUxheTNiYlhLYzIyMnVqZjk4YlVpYUs2blpWelFKa3BSZ1gwbHYxQ1JPaWJvWEkwa3drVFpIYmRqOGZxVXplY0EvNjQw?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9MaWFoaWNudEoyV0RxOE5qWmdoNU1xdmtHdlA4ektLaWNLZnJmMEhpYU1wSEJJN0p4T3dScUVsV0Eya0ppYzFsWURPZkxSUDlnRUtpYk1iSlh6a2NMQkhPMnVvZy82NDA?x-oss-process=image/format,png
[JDK1.8]: http://mp.weixin.qq.com/s?__biz=MzA5MzUwOTY4NQ%3D%3D&chksm=905d88fba72a01ed52ba7e5403ba39bbb4386bd23a7906db45d831311c7216ecbd5a7efeff8d&idx=1&mid=2247485857&scene=21&sn=be80b248bcc6c080755953219a1f2b78#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzA5MzUwOTY4NQ%3D%3D&chksm=905d9384a72a1a92a3eff2b667d103dcb62fc65a6ce52345113a5d92204f93eba5f634a05f03&idx=1&mid=2247488222&scene=21&sn=f017f254e40d5816fde3fa16be81e2c7#wechat_redirect
[Kubernetes_Docker]: http://mp.weixin.qq.com/s?__biz=MzA5MzUwOTY4NQ%3D%3D&chksm=905d93fda72a1aeb03677c7c9cb386b816104fa8634e0a438a82191d235eb9fa2434e2fa309d&idx=1&mid=2247488167&scene=21&sn=927691314c829db3df375c73ed00aee4#wechat_redirect
[MySQL_MySQL]: http://mp.weixin.qq.com/s?__biz=MzA5MzUwOTY4NQ%3D%3D&chksm=905d8838a72a012e057b5671b8a429c1dacbfcd15bc480ee020c59a1f636e906fcd5edca659d&idx=1&mid=2247485794&scene=21&sn=cef01641815309e84aa2fbbd692bf5b4#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzA5MzUwOTY4NQ%3D%3D&chksm=905d8970a72a00662feffcea58c746fa0098b98a6a92af9dfd9490b7a84cab6b432c9f4ec831&idx=1&mid=2247485482&scene=21&sn=e6385ef8cc1cf13c8f17a6e29de238b6#wechat_redirect
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi91ZndmMmRONDh6UWhmVThyQ2IyaWJ2VWliVWVSMGxFQVcwS3VKYVFXVkZpY1NxR0cwWjlJTTdxc2dJOWNpYkFnVGZwOFRIUFltaWNaOUdrMnduUWlhZzFrQ0w3US82NDA?x-oss-process=image/format,png