如何设计API接口,实现统一格式返回?
副标题[/!--empirenews.page--]
前言 在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,(题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)。 一般系统的大致整体架构图如下:
接口交互 前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。
后端服务器如何实现把数据返回给前端? 返回格式 后端返回给前端我们一般用JSON体方式,定义如下:
CODE状态码 code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。 如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了 我们应该可以参考HTTP请求返回的状态码
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。关注微信公众号 Java后端 获取更多推送。 Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如 再在枚举中定义,状态码 状态码和信息就会一一对应,比较好维护。 Data 返回数据体,JSON格式,根据不同的业务又不同的JSON体。 我们要设计一个返回体类Result 控制层Controller 我们会在controller层处理业务请求,并返回给前端,以order订单为例 我们看到在获得order对象之后,我们是用的Result构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。关注微信公众号 Java后端 获取更多推送。 美观美化 我们可以在Result类中,加入静态方法,一看就懂 (编辑:通化站长网) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |