专栏名称: 51CTO技术栈
有趣 | 有料 | 有内涵,为您提供最优质的内容,愿我们一起悦享技术,成就人生。
目录
相关文章推荐
51好读  ›  专栏  ›  51CTO技术栈

瞧瞧,人家那后端API接口写得多优雅!

51CTO技术栈  · 公众号  · 程序员  · 2020-11-16 18:08

正文

在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式。


图片来自 Pexels


题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了。


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

需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太 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 状态码一起设计,如
再在枚举中定义,状态码

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


③Data


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


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

控制层 Controller


我们会在 Controller 层处理业务请求,并返回给前端,以 Order 订单为例

我们看到在获得 Order 对象之后,我们是用的 Result 构造方法进行包装赋值,然后进行返回。


小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。


美观优化


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

那我们来改造一下 Controller

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


优雅优化







请到「今天看啥」查看全文