看看人家那后端API接口写得,那叫一个牛逼,再看看我的,像坨屎!
来自:老顾聊技术
链接:toutiao.com/i6694404645827117572
前言
在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,(题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)。
一般系统的大致整体架构图如下:
需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。
接口交互
前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。
针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。
老顾注重介绍一下后端服务器如何实现把数据返回给前端?
返回格式
后端返回给前端我们一般用JSON体方式,定义如下:
搜索互联网架构师公众号回复“2T”,送你一份惊喜礼包。
{ #返回状态码 code:integer, #返回信息描述 message:string, #返回值 data:object}
CODE状态码
code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。
如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
:下面是常见的HTTP状态码:200 - 请求成功301 - 资源(网页等)被永久转移到其它URL404 - 请求的资源(网页等)不存在500 - 内部服务器错误
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。
#1000~1999 区间表示参数错误 #2000~2999 区间表示用户错误#3000~3999 区间表示接口异常
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。
Message
这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如
再在枚举中定义,状态码
状态码和信息就会一一对应,比较好维护。
Data
返回数据体,JSON格式,根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result
控制层Controller
我们会在controller层处理业务请求,并返回给前端,以order订单为例
我们看到在获得order对象之后,我们是用的Result构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。
美观优化
我们可以在Result类中,加入静态方法,一看就懂
那我们来改造一下Controller
代码是不是比较简洁了,也美观了。
优雅优化
上面我们看到在Result类中增加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:
1、每个方法的返回都是Result封装对象,没有业务含义
2、在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
3、上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。
我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图
这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢?
搜索公众号互联网架构师回复关键字“2T”,获取Java架构全套视频。
实现方案
小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情
1、定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下
2、拦截请求,判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。
注解类
用来标记方法的返回值,是否需要包装
拦截器
拦截请求,是否此请求返回的值需要包装,其实就是运行的时候,解析@ResponseResult注解
此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。
重写返回体
上面代码就是判断是否需要返回值包装,如果需要就直接包装。这里我们只处理了正常成功的包装,如果方法体报异常怎么办?处理异常也比较简单,只要判断body是否为异常类。
怎么做全局的异常处理,篇幅原因,老顾这里就不做介绍了,只要思路理清楚了,自行改造就行。
重写Controller
在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。
总结
这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。谢谢!!!
看看人家那后端API接口写得,那叫一个牛逼,再看看我的,像坨屎!相关推荐
- symfony api 错误响应_如何设计一个牛逼的 API 接口
在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护.这篇文章重点讨论一下提 ...
- python后端接口怎么写_看看人家那后端API接口写得,那叫一个优雅!
程序员的成长之路 互联网/程序员/技术/资料共享 阅读本文大概需要 4 分钟. 来自:今日头条,作者:老顾聊技术 链接:https://www.toutiao.com/i669440464582711 ...
- 看看人家那后端API接口写得,那叫一个优雅!
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 来源:r6d.cn/tEvn 在移动互联网,分布式.微服务 ...
- 计算机前后端接口,看看别人后端API接口写得,那叫一个优雅!
在分布式.微服务盛行的今天,绝大部分项目都采用的微服务框架,前后端分离方式.题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟:以前后端人员瞧不起前端人员,那 ...
- 看看人家那后端API接口写得,那叫一个巴适~,再看看我的,像坨屎!
点击上方 好好学java ,选择 星标 公众号 重磅资讯.干货,第一时间送达 今日推荐:腾讯推出高性能 RPC 开发框架 个人原创100W+访问量博客:点击前往,查看更多 作者:老顾聊技术 来源:to ...
- 调用枚举接口重写方法提示找不到符号_看看人家那后端API接口写得,那叫一个巴适~...
前言 在目前应用发达的场景下,我们往往需要接入客户端(win).APP程序.网站程序.以及目前热火朝天的微信应用等,这些数据应该可以由同一个服务或者同事由多个提供, Web API作为整个纽带的核心, ...
- Java编写优雅接口,看看别人后端API接口写得,那叫一个优雅!
在分布式.微服务盛行的今天,绝大部分项目都采用的微服务框架,前后端分离方式.题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟:以前后端人员瞧不起前端人员,那 ...
- java写接口给前端_看看人家那后端API接口写得,那叫一个优雅!
来源: r6d.cn/tEvn 在移动互联网,分布式.微服务盛行的今天,现在 项目绝大部分都采用的微服务框架,前后端分离方式 ,(题外话: 前后端的工作职责越来越明确 ,现在的前端都称之为 大前端 , ...
- 前后端API接口安全问题,防止抓包恶意请求
哈喽,你们好,这是我第一次发帖子,最近遇到了一些关于后端api接口的安全问题,相信很多刚开始接触前后端的人都会遇到这样的问题,如果后端写了一个数据库操作的接口供前端使用,而这些接口无论是GET请求还是 ...
- nginx学习笔记002---Nginx代理配置_案例1_实现了对前端代码的方向代理_并且配置了后端api接口的访问地址
做个记录,以后做简单的nginx的时候拿过来就用 这个配置实现了,对前端html的方向代理,并且,配置了对后端api接口的方向代理 E:\nginx-1.14.0\conf\nginx.conf #u ...
最新文章
- java 整合solr_SpringBoot整合Spring Data Solr
- mac os x常用快捷键及用法
- Oracle 查询当前日期
- OpenCV注视估计Gaze Estimation的实例(附完整代码)
- 程序员减压方法100%有效
- 1218 溢出设置 overflow
- 【BZOJ4197】寿司晚宴,状态压缩DP
- EFK6.3+kafka+logstash日志分析平台集群
- [20170203]克隆schema.txt
- redhat 5.4 搭建本地YUM源
- WIN10系统 screencap截图屏幕会自动放大怎么办
- php设置excel列宽,excel列宽在哪里设置
- Excel如何复制一摸一样的表格或建立副本
- 原生对象、内置对象、宿主对象的区别
- mysql数据库管理工具 h_几款桌面MYSQL管理工具
- java deprecated 注释_Java注释中的@deprecated与源代码中的@Deprecated
- 四、线段_同级别分解
- 慕课软件质量保证与测试(第九章.程序中隐藏错误数量估计)
- Redis数据库 专题
- 最简单的无线充电传输电路
热门文章
- 除了数据恢复,EasyRecovery还有这样的功能!
- Android开发技巧:给Button的点击上色
- R语言数据挖掘实战系列(2)
- Mac OS X Tips
- C#3.0 语言基础扩充
- 黑马程序员---java基础-----------------图形化界面(GUI)
- 刷leetcode不知道从哪里刷起?? 来看看,我把刷题题目顺序都排好了,每道题还带详细题解!
- Linux IPC(Inter-Process Communication,进程间通信)之管道学习
- poj 4451 Dressing 一个小模拟 金华regional
- hdu 4323 Magic Number dp 多校联合赛(三)第四题