专栏名称: Java专栏
一个Java、Python、数据库、中间件、业内资讯、面试、学习资源等干货的知识分享社区。
51好读  ›  专栏  ›  Java专栏

看看人家接口写得,那叫一个优雅!

Java专栏  · 公众号  ·  · 2020-11-15 12:20

正文

点击上方 Java专栏 ”, 选择“置顶或者星标”


第一时间阅读精彩文章!


点击这段文字获取: 5个可以写到简历的项目实战视频教程(含源码)


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

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

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

再在枚举中定义,状态码
状态码和信息就会一一对应,比较好维护。






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


推荐文章
互联网聚焦  ·  华为最厉害的女人
8 年前
奔波儿灞与灞波儿奔  ·  前男友送我一套房,我该还给他吗?
8 年前