看看人家那后端API接口写得,那叫一个优雅!
共 2286字,需浏览 5分钟
·
2020-11-27 21:36
![](https://filescdn.proginn.com/82b6ae9099cc6f4a4263dc05e155be35/6bde8db6a35c280f4ba479bd67a2ff68.webp)
需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。
接口交互
前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。
针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。
着重介绍一下后端服务器如何实现把数据返回给前端?
返回格式
{
#返回状态码
code:integer,
#返回信息描述
message:string,
#返回值
data:object
}
CODE状态码
:下面是常见的HTTP状态码:
200 - 请求成功
301 - 资源(网页等)被永久转移到其它URL
404 - 请求的资源(网页等)不存在
500 - 内部服务器错误
![](https://filescdn.proginn.com/4ab5a8537ac22630c81a3d43aaba50f6/61e0c80a058c62d7022262db5ba07fba.webp)
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。
#1000~1999 区间表示参数错误
#2000~2999 区间表示用户错误
#3000~3999 区间表示接口异常
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。
![](https://filescdn.proginn.com/6451ec4f0d0a382f9ae69480b7159a9e/827361b280073791dd6461a30a5731f9.webp)
再在枚举中定义,状态码
![](https://filescdn.proginn.com/eabefa517236ed61887766def5623022/5766673fa164df40a174cbc1a7effb5a.webp)
状态码和信息就会一一对应,比较好维护。
Data
![](https://filescdn.proginn.com/e35095f6b52d63b475ea03c8537ce199/74366c49c38618fbda37d035c111bc1f.webp)
控制层Controller
![](https://filescdn.proginn.com/f7e039a20cb07d17bc234540c4eeb7f5/388aa47802be86bfca9b77507cf84e56.webp)
美观优化
![](https://filescdn.proginn.com/5e38cb526f5b16f698624d4b6806629b/991d8f656f56f1dc0de6346af519e3f9.webp)
那我们来改造一下Controller
![](https://filescdn.proginn.com/12046a85040527dfff10ef476fda35be/5d34f4d220bbced27e0cb0af4c3ea036.webp)
代码是不是比较简洁了,也美观了。
优雅优化
上面我们看到在Result类中增加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:
1、每个方法的返回都是Result封装对象,没有业务含义
2、在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
3、上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。
![](https://filescdn.proginn.com/5e15e32f0ff2b120f13198cf3615718a/c6fb61eba3757cef0c57700d0ad317f5.webp)
这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢?
实现方案
小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情
1、定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下
2、拦截请求,判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。
注解类
![](https://filescdn.proginn.com/2146a1ad8fde49d7eb3734048c64280d/87965f66e01509d0015be584a3cf4517.webp)
此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。
![](https://filescdn.proginn.com/02292a8ea718b4f1643ba53313e86c14/271b8914bb9cb679811d8ea4c80dd365.webp)
上面代码就是判断是否需要返回值包装,如果需要就直接包装。这里我们只处理了正常成功的包装,如果方法体报异常怎么办?处理异常也比较简单,只要判断body是否为异常类。
![](https://filescdn.proginn.com/0b2a5b6434d2a65aae79be1662cb003b/25f4ff53acf9a1a52b233953b6b78d4d.webp)
怎么做全局的异常处理,篇幅原因,老顾这里就不做介绍了,只要思路理清楚了,自行改造就行。
![](https://filescdn.proginn.com/4258e4e71d744a20db4627d8de4aac9b/21dde834597dbb5437aa18716f83b8f5.webp)
在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。
总结
这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。谢谢!!!