1,前提
使用git submodule的前提是有两个git项目一个主项目,一个module项目,而且主项目需要依赖于module项目。实际使用情况大致如此,当然这个module可能会被几个不同的项目依赖,但是也是也都是 主项目-module项目 模式。
2,使用的优点
- 项目结构更加清晰,项目模块化
- 当存在多个项目需要依赖同一个module的时候,只需要维护一份module
3,git使用有命令行和图形界面,此处介绍sourcetree和命令行
命令行
在主项目的某一个目录下面,例如下面目录
- 此处有一个项目DFSubModuleTest,项目下面有一个目录Android,在此处执行:
git submodule add --force git@git.corp.hanlz.com:hanlz/DFSubModule.git ./module
git submodule add --force <url> <path>
其中 git@git.corp.hanlz.com:hanlz/DFSubModule.git 是module项目的url地址,后面module使用的相对路径 ./module
- 执行结果
出现了子目录module,这个目录就是module项目DFSubModule,
此时module项目完成,然后主项目和module项目都是单独使用git维护,比如切换分支
添加module之后主项目需要提交代码,git status查看修改记录(后面删除submodule会使用)
以后每次module项目有跟新之后,需要在module项目中git pull拉取最新的代码。
删除module项目
- rm -rf 子模块目录 删除子模块目录及源码
- 打开 .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
- 打开 .git/config 删除配置项中子模块相关条目
- rm .git/module/* 删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可
4,拉取代码之后,拉取module
- git submodule init 初始化子模块
- git submodule update 更新子模块
- git submodule foreach git pull 拉取所有子模块
sourcetree
1,此处有一个项目DFSubModuleTest,项目下面有一个目录Android,sourcetree如下
然后有一个子模块:git@git.corp.hanlz.com:hanlz/DFSubModule.git
点击仓库,然后点击添加子模块,出现添加子模块的clone路径,和本地存放路径,
源路径/URL写入子模块路径,本地相对路径写入想将字模块放入的位置,加入放入capi,则如下:
点击确定,可以看到子模块已经成功依赖,子模块依赖的配置也已经自动完成,如下所示即为成功:
提交一次commit即可
此时子模块和普通的git项目并无区别,提交commit,reset,分支等完全一致,双击对应的子模块就能进入子模块管理界面