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

ゝ一世哀愁。 2021-09-02 09:48 267阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

--------------------

来源：https://zhuanlan.zhihu.com/p/265318078

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

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

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

![format_png 1][]

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

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

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

Message

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

![format_png 2][]

再在枚举中定义，状态码

![format_png 3][]

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

Data

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

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

![format_png 4][]

## 控制层Controller ##

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

![format_png 5][]

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

## **美观优化** ##

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

![format_png 6][]

那我们来改造一下Controller

![format_png 7][]

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

## **优雅优化** ##

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

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

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

![format_png 8][]

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

## **实现方案** ##

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

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

注解类

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

![format_png 9][]

拦截器

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

![format_png 10][]

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

重写返回体

![format_png 11][]

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

![format_png 12][]

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

重写Controller

![format_png 13][]

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

## **总结** ##

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

**- END -**

最近整理一份面试资料《Java技术栈学习手册》，覆盖了Java技术、面试题精选、Spring全家桶、Nginx、SSM、微服务、数据库、数据结构、架构等等。获取方式：点“ 在看，关注公众号 Java后端 并回复 777 领取，更多内容陆续奉上。推荐阅读 1. 5W 字详解分库分表之 Sharding-JDBC 中间件2. 网传一些著名互联网公司的实习工资3. TCP/IP 基础知识总结4. GET 和 POST 两种基本请求方法有什么区别5. 讨论：Service层需要接口吗？喜欢文章，点个在看

[Java]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da17bf97a286df119047a25b7de51621fe542816673bb4aa3ebd8ab97b09a86ed7db2e2ee&idx=3&mid=2247489272&scene=21&sn=ce74938072fc73a808d83ccb474db46d#wechat_redirect
[format_png]: /images/20210730/39a9ab03b44e4376948bc1b1a8fc14c8.png
[format_png 1]: /images/20210730/b61df441e2b84080a97c527d62a39838.png
[format_png 2]: /images/20210730/fba9005830234a788f626280b1a31d1e.png
[format_png 3]: /images/20210730/087bde7ac6b84a51ad5e771541246164.png
[format_png 4]: /images/20210730/433b79a2432146009d5c243716a593bc.png
[format_png 5]: /images/20210730/9dfebd303fe34baeac7d95ba7f9e9842.png
[format_png 6]: /images/20210730/c3d55862f96648dca7cab42435c3bdd2.png
[format_png 7]: /images/20210730/67de3d8066ea4cd287d0a1968a293f6a.png
[format_png 8]: /images/20210730/28f30c57a80449f087920ef320fa29b5.png
[format_png 9]: /images/20210730/e860400cd7f647d28ddaa3d8ed2a9000.png
[format_png 10]: /images/20210730/745b07130288482db53b94bbd8664681.png
[format_png 11]: /images/20210730/a6b6b9cebd7745e698b4514b5bc8aee1.png
[format_png 12]: /images/20210730/b12df9412b1740b89bfb34b74f603e52.png
[format_png 13]: /images/20210730/e94dfb08543f4c94afab4b01cd4b47dd.png