使用magic-api开发时多人协作问题

前言

前面有讲过对于小型简易项目可以使用 magic-api 快速发布 http 接口实现功能,简单使用可参考 SpringBoot整合magic-api快速发布http接口 - 掘金 (juejin.cn), 这篇文章只是给出一个示例代码,实际对于数据库, redis 等操作都是可以通过 magic-api 完成,详细的功能可以参考 简介 | magic-api (ssssssss.org), 接下来这一篇主要是对多人使用 magic-api 协作开发的个人思考梳理

低代码平台多人开发协作的难点

低代码开发平台一般都是通过页面拖拽或者在页面编写部分代码通过平台生成元数据,和源码编写还是有很大区别的,重点是元数据合并有冲突不易解决,对于低代码开发平台多人协作问题有参考了如下文章

低代码多分支协同开发的建设与实践 - 掘金 (juejin.cn)

低代码实践 | CodeWave如何支持多人协作开发应用_低代码_网易数帆_InfoQ写作社区

这些都是比较大型的低代码开发平台解决多人协作问题的思路,总结起来基本是

  • 细化任务,减少冲突的概率
  • 项目的多版本管理(对于后端同学来说基本都是使用 git 了)
  • 任务合并,若有冲突则基于可视化界面解决冲突

对于大型低代码开发平台来说,任务合并后冲突解决还是比较麻烦的,但是 magic-api 这种后端代码开发平台来说多人协作就要简单很多了,下面使用不同分支来模拟多人协作场景看看是如何基于 git 来进行版本管理

magic-api 多人协作场景模拟

生产分支代码

如下图所示,目前是 master 分支,可以认为是生产环境的代码,此时在 application.properties 中配置的 magic-api 资源地址是 magic-api.resource.location=classpath:magic-api, 这是为了保证线上代码 magic-api 接口资源的不可编辑性, 目前 resource 目录下已经有了一些接口

两个开发者创建本地分支

dev1 分支创建

现在有第一个开发者基于该项目的 master 分支开发, 基于 master 分支创建 dev1 分支,如下图所示

dev2 分支创建

新加入一个开发者,同样的还是基于 master 分支创建 dev2

dev1分支开发接口

看一下 dev1 分支 magic-api 资源目录的变化

可以看到因为包不同,所以元数据生成的目录也不同,也就是说 dev1 分支和 master 分支其实并没有冲突

dev2分支开发接口

上面 dev1 分支是创建了新的目录,接口都是在新目录中,接下来 dev2 则将接口创建在原来的目录中 此时 magic-api 资源目录结构

合并 dev1 dev2master

接下来的合并其实除了 application.propertiesmagic-api.resource.location=D:/code/test-web/src/main/resources/magic-api 这部分有冲突外,其他的都不会有任务冲突,而这部分的冲突只要合并一次后续合并也不会有冲突

总结

使用 magic-api 开发多人协作和源码开发多人协作其实差别不大,git 操作流程原来的开发模式都是一样的,只需要注意一点,即多个尽量不要开发同一个接口,因为多人开发同一个接口时,magic-api 生成的元数据就会有冲突,其他情况下基本不会有冲突,因为不同接口元数据文件不同

相关推荐
我爱挣钱我也要早睡!7 小时前
Java 复习笔记
java·开发语言·笔记
AD钙奶-lalala9 小时前
Mac OS上搭建 http server
java
皮皮林55113 小时前
SpringBoot 全局/局部双模式 Gzip 压缩实战:14MB GeoJSON 秒变 3MB
java·spring boot
weixin_4569042713 小时前
Spring Boot 用户管理系统
java·spring boot·后端
趁你还年轻_13 小时前
异步编程CompletionService
java
DKPT14 小时前
Java内存区域与内存溢出
java·开发语言·jvm·笔记·学习
sibylyue14 小时前
Guava中常用的工具类
java·guava
奔跑吧邓邓子14 小时前
【Java实战㉞】从0到1:Spring Boot Web开发与接口设计实战
java·spring boot·实战·web开发·接口设计
专注API从业者14 小时前
Python/Java 代码示例:手把手教程调用 1688 API 获取商品详情实时数据
java·linux·数据库·python
奔跑吧邓邓子14 小时前
【Java实战㉝】Spring Boot实战:从入门到自动配置的进阶之路
java·spring boot·实战·自动配置