背景
在实际工作中,我们经?;嵊龅接行└丛拥南钅?,根据功能拆分成很多子??椋蛘咄桓鲎幽?樵诓煌南钅恐斜灰览凳褂谩R坏┳幽?橛懈?,所有工程里的相关代码都要更新,重复工作而且可能出错。
为了解决这个问题,我们可以使用Git的submodule功能。子??? submodule )是一个内嵌在 git 仓库(父工程)中的 git 仓库,有点儿拗口。通过子???,可以将外部的仓库作为子目录放到自己的仓库中,既能方便的管理依赖,又可以保持依赖本身的独立性。
使用
在git管理平台上新建两个项目,主项目TestMain和子模块项目TestSub,在TestMain中添加TestSub,同时TestSub有其独立的版本控制。
1. 将主项目clone到本地
git clone [主项目远程仓库地址]
2. 添加子???/h4>
进入主项目TestMain目录,使用以下命令创建一个子???/p>
git submodule add [子??樵冻滩挚獾刂穄
此时项目仓库中会多出两个文件
- .gitmodules:保存子模块的相关信息
-
testsub:子??榇?br> 这时候可以通过git status查看当前状态
git submodule 查看子??榘姹拘畔?/p>
然后git commit,push,成功后在主项目的远程仓库里可以看到子模块文件夹,并带上其仓库的版本号
3. 使用带有子??榈南钅?/h4>
后续使用者clone主项目后,子模块默认是空的,需要我们在项目根目录下执行如下命令完成子??榈南略?/p>
git submodule init
git submodule update
或
git submodule update --init --recursive
还有一种更简单的办法,在clone主项目的时候带参数,这样会递归地将项目中所有子??榈拇肜 ?/p>
git clone --recurse-submodules [主项目url]
对于已经clone过存在的项目,用git pull 命令同样如此
git pull --recurse-submodules
拉取子模块代码后,子??槟舷允驹诹偈狈种?,如果要进行开发,记得进入子??榍谢坏街付ǚ种?,如果子模块太多且分支一样,可以执行以下命令批量切换。
git submodule foreach git checkout xxx
如果不小心在临时分支上做了修改,要记得合并到主分支,否则修改可能会丢失。
4. 更新子???/h4>
子??槭遣欢显谖じ碌?,在我们自己的项目里,一般不会去改动子模块。
第一种情况,子??樵冻逃懈拢绻氡3直镜刈酉钅坑朐冻滩挚獍姹疽恢?,就需要用以下命令更新子模块至远程仓库的最新版。
git submodule update --remote
注意:命令 git submodule update 是更新主项目内子模块到最新版本,即与主项目远程仓库记录的子??榘姹疽恢?/code>
当然也可以进入到子模块目录下,用传统的git pull获取最新代码。如果主项目的子项目特别多,此时可以用以下命令执行
git submodule foreach git pull
第二种情况,如果本地主项目的子??橛懈?,按以下步骤
a. 进入到子项目中对更新的代码进行一次提交操作,并推送到远程
b. 再回退到主项目中,对主项目进行一次提交,推送
注意:不管主项目是否有更新,只要子项目修改过代码并提交过,主项目就需要再提交一次,因为子项目的修改是会同步到主项目中的,这样才能保证开发的一致性!
5. 删除子???/h4>
a. 执行 git submodule deinit testsub,自动在 .git/config 中删除了子??橄喙匦畔ⅰU飧雒钊绻砑由喜问?--force,则子??楣ぷ髑诩词褂斜镜氐男薷模不岜灰瞥?。
b. 执行 git rm testsub,移除了 testsub 文件夹,并自动在 .gitmodules 中相关信息。
此时,主项目中关于子模块的信息基本已经删除(可能.git/modules 目录下还有残余),但是不影响,继续commit,push,完成对子??榈纳境?/p>