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

心已赠人 2022-12-21 15:56 146阅读 0赞

点击上方“java大数据修炼之道”,选择“设为星标”

# 优质文章和精品资源, 第一时间送达 #

![format_png][]

关注公众号后台回复**资源**获取实战教学资料+视频

> **来自：今日头条，作者：老顾聊技术**
> 
> **链接：https://www.toutiao.com/i6694404645827117572**

![format_png 1][]

### 前言 ###

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

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

![format_png 2][]

> 需要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太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 3][]

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

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

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

Message

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

![format_png 4][]

再在枚举中定义，状态码

![format_png 5][]

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

Data

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

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

![format_png 6][]

# #

### 控制层Controller ###

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

![format_png 7][]

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

### 美观优化 ###

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

![format_png 8][]

那我们来改造一下Controller

![format_png 9][]

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

### 优雅优化 ###

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

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

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

![format_png 10][]

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

### 实现方案 ###

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

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

注解类

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

![format_png 11][]

拦截器

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

![format_png 12][]

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

重写返回体

![format_png 13][]

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

![format_png 14][]

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

重写Controller

![format_png 15][]

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

### 总结 ###

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

**推荐阅读：**

1、[垃圾代码和优质代码的区别？][Link 1]

[2][][、][2][项目中常用的19条MySQL优化][2]

3、[最新SQL数据库面试题以及答案！][SQL]

[4、][4][老板要求用java将word转为PDF,这么搞 ?][4]

5、[面试官：来说说单点登录的三种实现方式][Link 2]

[6、][6][卧槽，为啥volatile关键字保证不了线程安全啊][6]

7、[单怼60道][60][多线程][60][面试题，你能答上几个?(附答案)][60]

[8、][8][Spring和SpringBoot最核心的3大区别，详解！][8]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx_size_16_color_FFFFFF_t_70][]

[format_png]: /images/20221120/f36fb13c73da45cd917954e159113900.png
[format_png 1]: /images/20221120/ea68ae71c8ae47618faa74f3017060dd.png
[format_png 2]: /images/20221120/bdb3cc66e3d14badae48d29f568017d8.png
[format_png 3]: /images/20221120/e859a8c8e7e841c684de4a824fa4ced7.png
[format_png 4]: /images/20221120/78b6321f6fb8493387664aa65b990f29.png
[format_png 5]: /images/20221120/7f62ea49c8e24e8d988297c2f8556659.png
[format_png 6]: /images/20221120/2b1922e2822b4009bec6d5315b18bc4e.png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVVR0cxY0tOZXltcDJURHFBd1VlVWVMZmQ2NFdTaWJ2QnZ3ZGppY2ZMU2ljWnl0aWNpYnkxc2FjNzBLZy82NDA?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVUNUM4dDNYa2E1STV4OTFzWVJMMWQ5UkJBWFk4dzNhZGNqMnA2a3laZ0lkanVkU3VEWThVeHcvNjQw?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVNOVc4eFN2RUprWWtWcU03SlZjZ0NzazdyQkc0UXcxSVRaQnhXajVPS1kyT3dBaEtzYm5NWEEvNjQw?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVLTlhQaWJ1b05QaGliSTZNMHJhOXBMUGN1VHNIck5GUFRuRVJ6MEk1RXdha3pjSWliZUREUGt2eWcvNjQw?x-oss-process=image/format,png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVtSUprd3NPYU9PQmJjWnMyQk9mQnhvVU5MR1h5RUs0aEpkOTJEclNnV2liRGxReVJ1WFRIaWFldy82NDA?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzV1ZnBqa0ZLTVFuWEdEaWFveWZ4WXY0UDBGblFTQzJCNU8zcURTYVU3Wkw3TDF3QURYak1UdVVnLzY0MA?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVwNE8xb2dFRnMwcXlhVm1OTjFLaFVyaDlham9TVkNpYUpUSWpzaG1BcE43Tkg0NWliMXZ4bHBWZy82NDA?x-oss-process=image/format,png
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVnTHVpY05HOVdGTHN4QmhDTXBBVXBaQnNTSjE4TE5zaWFFN1FsRTViM2lhblRRUHVyWnFHc2ZodVEvNjQw?x-oss-process=image/format,png
[format_png 15]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9vR3AzSW1RcURvYkQ4Sk9yWTdodHdGanNZeDdmTkhpYzVSOG5mVVVOTFpVMHFObjJ4Mkt5aWJiZG1hdU5vVkI0NXBjcmhoM2EyMXFpYmtDUTdPWFZLZWljb2cvNjQw?x-oss-process=image/format,png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493966&idx=1&sn=1b2b15081f13432f08335510ac290dd6&chksm=fbc22782ccb5ae9406b12659a74d6951355a533a1bb1d41ebd8532fc9961141b60c228d7e0d2&scene=21#wechat_redirect
[2]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492315&idx=1&sn=37c6888e30892c7fae56d0769c35a571&chksm=fbc22c17ccb5a501df41ddeaecf0f7e85e292b45d6c7522e4d6a4d9c4a93a389338ee175eae8&scene=21#wechat_redirect
[SQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493386&idx=1&sn=6014e7fb6c2a43ca8df3b011754fa4e1&chksm=fbc229c6ccb5a0d068fdce76d8e457510c9c43e866952a917ae63ee0f1da8c5c25bd5d3879a2&scene=21#wechat_redirect
[4]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492363&idx=1&sn=6975a1a5de92dc49d04654f21ffa7c21&chksm=fbc22dc7ccb5a4d1b94f2a9bbce26082c9f845fbbf7d588a5540d072bcef39b2281d0b705f91&scene=21#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493492&idx=1&sn=cd0a9b65387d5107fe9d0e1ded268d22&chksm=fbc229b8ccb5a0ae5f433e40aeb031d462bc825b837ca9e09720b6b58439dada694eeb54bbaf&scene=21#wechat_redirect
[6]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492809&idx=1&sn=47c50b227f8063129ed09edc91449100&chksm=fbc22a05ccb5a31383ee13bb6c58f8c12dada691c16624e028f23f24c32d1e4201b4ebd1a354&scene=21#wechat_redirect
[60]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247490459&idx=1&sn=66bc23ae41a8abcb9a6f00be754b2e47&chksm=fbc1d557ccb65c41ec5d3b7dedd6c7a22949ddcb5de1406de482c3b702a1a4768c66b730b219&scene=21#wechat_redirect
[8]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493965&idx=1&sn=30d1df5f2358eb119c55cf2d746bf063&chksm=fbc22781ccb5ae971ba5cd9dd0ebd8399be84b86ec356faea457591e7d35aa783b6a0341d55b&scene=21#wechat_redirect
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201117112309601.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx,size_16,color_FFFFFF,t_70