背景
在日常项目开发中,随着项目的迭代,不可避免的是主项目会引入到很多三方库,或者自研的一些模块。有一种场景,就是这些模块,是随着开发而进行迭代,且多个项目公用的,这种情况,在跨平台的场景下,是特别地常见。如安卓ios公用一个flutter模块,所以,就有了这个git子模块管理。
环境
win10
git
关联指令
添加子模块
git submodule add url path
其中,url就是子模块的仓库地址,而path,就是保存到当前电脑上的模块地址。
一般执行这个命令,都是基于主项目的根目录下,打开命令行输入框,然后基于当前的主项目,引入子模块进行操作。
查看子模块
git submodule
更新子模块
git submodule update
删除子模块
git submodule deinit <子模块路径>
git rm <子模块路径>
第一个命令会将子模块从父仓库的配置中移除,第二个命令会从父仓库中删除子模块的目录和文件。
然后再次commit,提交后即可。
ps:对于子模块的管理新增,提交,推送,其实都是和git的日常使用大致一致的,而对于更新,则可以使用上述的git submodule update --remote进行更新。
实践
这里博主新建了两个仓库,一个父类仓库,一个子模块仓库,地址如下:
https://gitee.com/motosheep/git-parent
https://gitee.com/motosheep/git-child1
这里都使用master分支作为演示。
主项目默认文件:
子模块默认文件:
可以看到,上述两个仓库,分别是主项目,和子模块1。其中,主项目有一个文件“我是爸爸”,子模块1有个文件,是“原有文件”,分支皆为master。
开始操作
(1)克隆主项目,且进入主项目的根目录
可以看到,主项目已经复制下来了。
(2)基于主项目,引入子模块
执行指令:
git submodule add https://gitee.com/motosheep/git-child1.git child/
后,可以看到,主项目的目录下,多了一个child文件夹,观察。
可以看到,子模块的结构,和之前子模块仓库的结构,是如出一辙的,这个时候,就成功引入了。
(3)查看子模块状态
git submodule status
同样,也可以看到这个模块的状态。
(4)编辑子模块,并且提交
首先,我们对于子模块的操作,原理上,也是git的基本操作,这里就不在详述了,流程如下图。
可以看到,基于子模块的目录,把新建的文件,添加并且提交了,然后观察远程仓库,这个时候也是提交成功的,然后再去看看主项目的仓库,结构是怎样的,
备注:同样地,在主项目的根目录下,也进行了一次add,commit,push。然后观察远程仓库目录结构,如下图:
可以看到,仓库中多了一个child的目录,点击会发现,是跳去子模块的仓库的地址,至此,已经全部实现了子模块的接入了。
(4)拉取子模块的更新
这里手动在远程仓库,新建一个文件,然后本地执行子模块的拉取指令,看看到底能否拉取成功,远程仓库子模块结构如下:
然后本地切换为主项目的目录,然后执行更新指令:
git submodule update --remote
然后观察目录文件,如下图:
拉取成功!所以这个子模块就完成了拉取。
(5)从0-1拉取整个项目
有人会说,我本地应该如何拉取新的项目呢?操作如下:
首先,主项目的地址,是知道的,也是沿用原来的方法,git clone后观察。
可以看到,虽然主项目是拉完了,但是子模块的文件夹,是没有东西的。
接下来,就是在主项目根目录,运行git submodule update --init --recursive来更新或克隆子模块的最新版本。如果之前没有克隆过该子模块,则需要添加 --init参数;如果想要同时更新所有子模块及其依赖关系,还需要添加 --recursive参数。再次观察:
这里就拉取成功了。
(6)删除模块
可以使用以下指令,删除子模块:
git submodule deinit 子模块名字
git rm 子模块名字
git commit -m “xxx”
git push
具体操作如下图:
可以看到,子模块已经没了。
至此,模块的基本操作已经演示完成。其实注意的点,无非就是那几个:
(1)拉取模块的时候,所对应的目录,需要明确,且是基于主项目的根目录执行指令思路会更清晰。
(2)对于子模块的更新,如果是从0-1拉取项目,则需要额外的参数,如git submodule update --init --recursive来获取子模块全部的数据。
that’s all------------------------------------------------------------------------------------