摘要:版本升级每个文件方法头标明版本号,每次修改需修改版本号大于原版本号,即为版本升级。
这些天项目有的API出现版本控制问题,着实忙乎了一小阵,因为项目使用TP5的传统方法进行版本控制(api目录下进行版本区分,由请求路径决定使用的版本)
但是问题往往是,项目使用了v2版本,但是后端又新建了v3,而前端不知情,所以也趁着这次机会,探索了较为实用的前后端分离问题与解决方案,并做整理。
较明显的问题1.后端 API 产能不免,供给不上的问题
2.后端 API 出现 BUG,需要等待修复的问题
3.前后端沟通差异导致API实现的偏差
4.后端 API 发生了修改,没有通知到前端,showcase 的时候发现了 bug
1.后端规范功能函数集、功能模块集、统一返回格式与方法、提高代码复用率,从而提高后端API产能问题
问题2解决方案1.API出现BUG,前端提出BUG,并设置修复期限、BUG等级、修复奖励记录
2.API从完成到正式使用有三天使用内测期,内测期内前端发现BUG有奖励记录
3.前端内测期外的API出现BUG次数作限制,超过则惩罚记录
4.后端内测期外的API出现BUG次数作限制,超过则惩罚记录
使用API敏捷原型开发方法:
--前端构造理想IO,即参数,返回数据格式等等(半天)
--后端思考实现可行性,调整IO(半天)
--后端实现API(协商时间),锁定API版本(具体实现参考下面方案)
实现一个简易型的消息系统(我们使用了基于swoole实现的websocket,具体可参考我的开源小框架)
1.后端
--API完成
--与前端确认OK,则API锁定版本V1.0(自动记录锁定情况到日志)
2.需求变化/其他变动
--解锁API(自动通知前端,XXAPI版本解锁了),不解锁则无法提交成功
--修改完成后更新API版本,重复步骤1即可
API版本解锁:每个API文件方法头标明版本号,每次修改需修改版本号,即为解锁。
API版本升级:每个API文件方法头标明版本号,每次修改需修改版本号大于原版本号,即为版本升级。
实现步骤1.所有API按特定模块归类,例如admin后台模块,在API目录里编写相应的各个API文件,或如上图进行区分
2.记录所有模块API目录的路径到脚本,在开发人员提交的时候对这些路径进行检查
3.编写检查API的脚本,工作流程如下:提交时钩子检查API文件里的API方法是否无解锁的情况下被修改,即提交的文件如果是API目录下的API文件,则该文件方法注释里的版本号是否与原函数一致,一致且函数内容不一样,提交失败并提示
4.如果提交的API文件版本大于原版本,短信通知过前端,提交成功
提交代码时共触发两个脚本,一个做检查,一个做记录(记录前端人员的电话,API目录)
以上为粗略说明,若有错误与更好建议,请留言反馈,谢谢。
创作不易,GitHub 右上角点 Star 支持下吧,谢谢^_^
基于swoole的实时消息通信框架
基于Fastadmin整合阿里云OSS,Redis,物流,短信的后台系统
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/29113.html
摘要:前后端分离的开发方式在最近几年突然火起来,松哥认为有两方面的原因前端的发展。不变其实除了前后端交互方式发生变化之外,其他的地方都是不变的。 事情的起因是这样的,有个星球的小伙伴向邀请松哥在知乎上回答一个问题,原题是: 前后端分离的时代,Java后台程序员的技术建议? 松哥认真看了下这个问题,感觉对于初次接触前后端分离的小伙伴来说,可能都会存在这样的疑问,于是决定通过这篇文章和大家聊一...
摘要:前后端的界限是按照浏览器和服务器的划分。前后端彼此互不关联。关于作者本文部分图片段落参考文章实践中的前后端分离。淘宝前后端分离实践本文源码详见服务端代码。 一、起源 (故事纯属虚构,如有雷同,纯属巧合)传说在很久很久以前,我们有志之士有了个创业的想法,于是乎开始了自己的创业之梦,但是人手不足啊,于是乎所有角色老子一个人全包了: Roles: PM, DBA, RD, FED, Des...
摘要:前后端的界限是按照浏览器和服务器的划分。前后端彼此互不关联。关于作者本文部分图片段落参考文章实践中的前后端分离。淘宝前后端分离实践本文源码详见服务端代码。 一、起源 (故事纯属虚构,如有雷同,纯属巧合)传说在很久很久以前,我们有志之士有了个创业的想法,于是乎开始了自己的创业之梦,但是人手不足啊,于是乎所有角色老子一个人全包了: Roles: PM, DBA, RD, FED, Des...
摘要:什么是前后分离前后端分离并不是什么新鲜事,到处都是前后端分离的实践。然而一些历史项目在从一体化设计转向前后端分离的架构时,不可避免的会遇到各种各样的问题。搞了一个前后分离,需要分离部署。 探究 :深入聊聊前后分离架构 前后分离,一直是一个相当泛泛的问题,前后分离到底好不好?没有绝对的对,没有绝对的错,业界就这个问题已经激烈的探讨几年了.出现讨论的点在于:分离当然是好的,但是以什么样的服...
摘要:什么是前后分离前后端分离并不是什么新鲜事,到处都是前后端分离的实践。然而一些历史项目在从一体化设计转向前后端分离的架构时,不可避免的会遇到各种各样的问题。搞了一个前后分离,需要分离部署。 探究 :深入聊聊前后分离架构 前后分离,一直是一个相当泛泛的问题,前后分离到底好不好?没有绝对的对,没有绝对的错,业界就这个问题已经激烈的探讨几年了.出现讨论的点在于:分离当然是好的,但是以什么样的服...
阅读 1609·2023-04-25 16:29
阅读 947·2021-11-15 11:38
阅读 2281·2021-09-23 11:45
阅读 1409·2021-09-22 16:03
阅读 2530·2019-08-30 15:54
阅读 1197·2019-08-30 10:53
阅读 2598·2019-08-29 15:24
阅读 1094·2019-08-26 12:25