前言
在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,(题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)。
一般系统的大致整体架构图如下:![图片](https://i-blog.csdnimg.cn/blog_migrate/50bc13a3da18ee8dc464065445040ee6.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 - 内部服务器错误
![图片](https://i-blog.csdnimg.cn/blog_migrate/a98f7e854283c19cfe65fdbabb3c800e.png)
#1000~1999 区间表示参数错误
#2000~2999 区间表示用户错误
#3000~3999 区间表示接口异常
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。
Message
这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如
![图片](https://i-blog.csdnimg.cn/blog_migrate/fe89e80395bc5603fa29570567375d09.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/70243734423928338aa0ec70bc88f211.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/0155fe1f1a3d50079f545612c2fe7f10.png)
控制层Controller
我们会在controller层处理业务请求,并返回给前端,以order订单为例
![图片](https://i-blog.csdnimg.cn/blog_migrate/a7c9996736503913468fcc334c5163dc.png)
我们看到在获得order对象之后,我们是用的Result构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。
美观优化
我们可以在Result类中,加入静态方法,一看就懂
![图片](https://i-blog.csdnimg.cn/blog_migrate/4d9fa6445d11a3f78682ce475c00eba1.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/c31b5fd980522dac77b9f7813d1d6b80.png)
优雅优化
上面我们看到在 Result类中增加了静态方法 ,使得业务处理 代码简洁 了。但小伙伴们有没有发现这样有 几个问题: 1、每个方法的返回都是Result封装对象,没有业务含义2、在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
3、上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。 我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图
![图片](https://i-blog.csdnimg.cn/blog_migrate/edf45d7da8d438aeb8c7ba38c29121f3.png)
这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢?
实现方案
小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情
1、定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下2、拦截请求,判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。 注解类 用来标记方法的返回值,是否需要包装
![图片](https://i-blog.csdnimg.cn/blog_migrate/287825fdead97d547dd9af5836d54e81.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/e527c74b9d1f647747918cc517dbfb96.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/5f544e6a309175bb2defc45fd14178e7.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/6499ace08244eacb6eb76599b621b0a7.png)
![图片](https://i-blog.csdnimg.cn/blog_migrate/f783e18eda577e14956c7bf0aa01f39c.jpeg)
在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。
总结
这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。谢谢!!!![图片](https://i-blog.csdnimg.cn/blog_migrate/a6e94f1f9d3de2313f5c1a3ae2b266de.jpeg)