git submodule 管理子工程

git submodule 管理子工程

摘要：當(dāng)多人共同維護(hù)一個(gè)項(xiàng)目時(shí)，必然需要進(jìn)行模塊化開(kāi)發(fā)，所以使用submodule來(lái)管理子工程很有必要。本文以圖文并貌的形勢(shì)進(jìn)行一步步搭建主工程及綁定子工程。
1、在Github上分別建立主工程HDMasterProject和兩個(gè)子工程（動(dòng)態(tài)／靜態(tài)庫(kù)）HDSubProjectOne、HDSubProjectTwo.
SZ-denglibing:~ fangdd$ cd /Harry/Projects/HDMaster-SubProject/HDMasterProject
SZ-denglibing:HDMasterProject fangdd$ git init
Initialized empty Git repository in /Harry/Projects/HDMaster-SubProject/HDMasterProject/.git/
SZ-denglibing:HDMasterProject fangdd$ git add .
SZ-denglibing:HDMasterProject fangdd$ git commit -m '初始化工程'
[master (root-commit) 10f33c6] 初始化工程
 12 files changed, 639 insertions(+)
 create mode 100644 HDMasterProject.xcodeproj/project.pbxproj
 create mode 100644 HDMasterProject.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 create mode 100644 HDMasterProject.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/HDMasterProject.xcscheme
 create mode 100644 HDMasterProject.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/xcschememanagement.plist
 create mode 100644 HDMasterProject/AppDelegate.h
 create mode 100644 HDMasterProject/AppDelegate.m
 create mode 100644 HDMasterProject/Base.lproj/LaunchScreen.storyboard
 create mode 100644 HDMasterProject/Base.lproj/Main.storyboard
 create mode 100644 HDMasterProject/Info.plist
 create mode 100644 HDMasterProject/ViewController.h
 create mode 100644 HDMasterProject/ViewController.m
 create mode 100644 HDMasterProject/main.m
SZ-denglibing:HDMasterProject fangdd$ git remote add origin https://github.com/erduoniba/HDMasterProject.git
SZ-denglibing:HDMasterProject fangdd$ git push origin master
Counting objects: 21, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (19/19), done.
Writing objects: 100% (21/21), 7.45 KiB | 0 bytes/s, done.
Total 21 (delta 2), reused 0 (delta 0)
To https://github.com/erduoniba/HDMasterProject.git
 * [new branch]      master -> master

SZ-denglibing:HDMasterProject fangdd$ cd ./HD
HDMasterProject/           HDMasterProject.xcodeproj/
SZ-denglibing:HDMasterProject fangdd$ cd ../
HDMasterProject/ HDSubProjectOne/ HDSubProjectTwo/
SZ-denglibing:HDMasterProject fangdd$ cd ../HDSubProjectOne/
SZ-denglibing:HDSubProjectOne fangdd$ git init
Initialized empty Git repository in /Harry/Projects/HDMaster-SubProject/HDSubProjectOne/.git/
SZ-denglibing:HDSubProjectOne fangdd$ git add .
SZ-denglibing:HDSubProjectOne fangdd$ git commit -m '初始化子工程1'
[master (root-commit) 9c5c421] 初始化子工程1
 6 files changed, 438 insertions(+)
 create mode 100644 HDSubProjectOne.xcodeproj/project.pbxproj
 create mode 100644 HDSubProjectOne.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 create mode 100644 HDSubProjectOne.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/HDSubProjectOne.xcscheme
 create mode 100644 HDSubProjectOne.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/xcschememanagement.plist
 create mode 100644 HDSubProjectOne/HDSubProjectOne.h
 create mode 100644 HDSubProjectOne/Info.plist
SZ-denglibing:HDSubProjectOne fangdd$ git remote add origin https://github.com/erduoniba/HDSubProjectOne.git
SZ-denglibing:HDSubProjectOne fangdd$ git push origin master
Counting objects: 14, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (12/12), done.
Writing objects: 100% (14/14), 4.56 KiB | 0 bytes/s, done.
Total 14 (delta 0), reused 0 (delta 0)
To https://github.com/erduoniba/HDSubProjectOne.git
 * [new branch]      master -> master

SZ-denglibing:HDSubProjectOne fangdd$ cd ../HDSubProjectTwo/
SZ-denglibing:HDSubProjectTwo fangdd$ git init
Initialized empty Git repository in /Harry/Projects/HDMaster-SubProject/HDSubProjectTwo/.git/
SZ-denglibing:HDSubProjectTwo fangdd$ git add .
SZ-denglibing:HDSubProjectTwo fangdd$ git commit -m '初始化子工程2'
[master (root-commit) 9be396f] 初始化子工程2
 6 files changed, 438 insertions(+)
 create mode 100644 HDSubProjectTwo.xcodeproj/project.pbxproj
 create mode 100644 HDSubProjectTwo.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 create mode 100644 HDSubProjectTwo.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/HDSubProjectTwo.xcscheme
 create mode 100644 HDSubProjectTwo.xcodeproj/xcuserdata/fangdd.xcuserdatad/xcschemes/xcschememanagement.plist
 create mode 100644 HDSubProjectTwo/HDSubProjectTwo.h
 create mode 100644 HDSubProjectTwo/Info.plist
SZ-denglibing:HDSubProjectTwo fangdd$ git remote add origin https://github.com/erduoniba/HDSubProjectTwo.git
SZ-denglibing:HDSubProjectTwo fangdd$ git push origin master
Counting objects: 14, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (12/12), done.
Writing objects: 100% (14/14), 4.55 KiB | 0 bytes/s, done.
Total 14 (delta 0), reused 0 (delta 0)
To https://github.com/erduoniba/HDSubProjectTwo.git
 * [new branch]      master -> master
SZ-denglibing:HDSubProjectTwo fangdd$
2、分別在兩個(gè)子工程添加代碼進(jìn)行測(cè)試：
@implementation HDSubProjectMethodOne
+ (void)hdSubProjectMethodOne{
    NSLog(@"hdSubProjectMethodOne");
}
@end

@implementation HDSubProjectMethodTwo
+ (void)hdSubProjectMethodTwo{
    NSLog(@"hdSubProjectMethodTwo");
}
@end

然后在各自的HDSubProjectOne.h和HDSubProjectTwo.h添加對(duì)測(cè)試代碼頭文件

3、添加子工程到主工程中（單純的添加，而不是子模塊綁定）

打開(kāi)主工程，建立2個(gè)工程文件夾，分別將 HDSubProjectOne.xcodeproj 和 HDSubProjectTwo.xcodeproj 拖到文件夾中，如下：

在主工程的AppDelegate中調(diào)用2個(gè)子工程的代碼：

嗯哼，找不到文件，看看HDSubProject下面，發(fā)現(xiàn)什么都沒(méi)有，這個(gè)是因?yàn)橹苯油蟿?dòng).xcodeproj只是引用，而沒(méi)有將代碼拷貝：

該問(wèn)題解決：杜甲同學(xué)的專欄 iOS 創(chuàng)建多個(gè)子工程的方法

字段說(shuō)明：

$(SRCROOT)表示工程.xcodeproj所在的相對(duì)路徑，比如我的電腦可能是harry/project/HDMasterProject/ 也可能是hhh/xcodeProject/HDMasterProject/

"$(SRCROOT)/當(dāng)前工程名字/需要包含頭文件所在文件夾" 將上面的雙引號(hào)里面的字符串拷貝之后，你會(huì)發(fā)現(xiàn)這個(gè)“$(SRCROOT)”，會(huì)自動(dòng)變成當(dāng)前工程所以的目錄。這樣就可以了，發(fā)給別人，別人也不用在去修改路徑了。

運(yùn)行還是有問(wèn)題，這個(gè)時(shí)候需要對(duì)子工程進(jìn)行配置：

然后將子工程的動(dòng)態(tài)庫(kù)加入到主工程中：

運(yùn)行：

搞定！

4、添加子工程到主工程中（子模塊綁定）

相關(guān)Git Submodule學(xué)習(xí)資料：咖啡兔 Git Submodule使用完整教程

使用

git submodule add https://github.com/erduoniba/HDSubProjectOne.git

和

git submodule add https://github.com/erduoniba/HDSubProjectTwo.git

將子工程綁定到主工程中。

這個(gè)時(shí)候你會(huì)發(fā)現(xiàn)在HDMasterProject會(huì)多出2個(gè)文件夾，這里的代碼其實(shí)就是對(duì)HDSubProjectOne，HDSubProjectTwo2個(gè)子工程的clone，以后的代碼修改就是在這里修改。

打開(kāi).gitmodules

可以看到.gitmodules記錄了每個(gè)submodule的引用信息，知道在當(dāng)前工程的位置以及倉(cāng)庫(kù)的所在。現(xiàn)在提交主及子工程工程的代碼，通知你的小伙伴clone代碼吧。

5、他人拉取代碼：

現(xiàn)在因?yàn)橹挥幸慌_(tái)電腦，所以我將主工程clone到另外一個(gè)目錄(Desktop)下來(lái) 模擬他人操作:

發(fā)現(xiàn)我們的子工程并沒(méi)有clone下來(lái)，莫急：

在HDMasterProject中clone 2個(gè)子工程

git clone https://github.com/erduoniba/HDSubProjectOne.git
git clone https://github.com/erduoniba/HDSubProjectTwo.git

打開(kāi)clone下來(lái)的主工程，會(huì)出現(xiàn)這樣的問(wèn)題：

這個(gè)是因?yàn)樵谶@里：

是因?yàn)榈?步的 “打開(kāi)主工程，建立2個(gè)工程文件夾，分別將 HDSubProjectOne.xcodeproj 和 HDSubProjectTwo.xcodeproj 拖到文件夾中” 有問(wèn)題，原因是 在建立工程時(shí)，我們是將下圖 1 中的子模塊的.xcodeproj拖入到主工程的，但是HDMasterProject并沒(méi)有包含他們，解決方式：重新將2中的.xcodeproj拖入主工程，提交即可，相應(yīng)的Destop下的主工程更新代碼就OK了。

運(yùn)行：

6、子工程提交代碼，他人更新：

甲同學(xué)提交子工程代碼：

SZ-denglibing:HDMasterProject fangdd$ cd HDSubProjectOne/
SZ-denglibing:HDSubProjectOne fangdd$ git add .
SZ-denglibing:HDSubProjectOne fangdd$ git commit -m '添加測(cè)試代碼'
[master 6bdc6eb] 添加測(cè)試代碼
 2 files changed, 6 insertions(+)
SZ-denglibing:HDSubProjectOne fangdd$ git push origin master
Counting objects: 5, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 542 bytes | 0 bytes/s, done.
Total 5 (delta 3), reused 0 (delta 0)
To https://github.com/erduoniba/HDSubProjectOne.git
   364abed..6bdc6eb  master -> master

i. 乙同學(xué)更新甲同學(xué)的子工程代碼 方式1 （到子工程直接更新）

SZ-denglibing:HDMasterProject fangdd$ cd HDSubProjectOne/
SZ-denglibing:HDSubProjectOne fangdd$ git pull
remote: Counting objects: 5, done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 5 (delta 3), reused 5 (delta 3), pack-reused 0
Unpacking objects: 100% (5/5), done.
From https://github.com/erduoniba/HDSubProjectOne
   364abed..6bdc6eb  master     -> origin/master
Updating 364abed..6bdc6eb
Fast-forward
 HDSubProjectOne/HDSubProjectMethodOne.h | 2 ++
 HDSubProjectOne/HDSubProjectMethodOne.m | 4 ++++
 2 files changed, 6 insertions(+)

ii.乙同學(xué)更新甲同學(xué)的子工程代碼 方式2 （到主工程使用git submodule update更新）

cd 主工程路徑
git submodule update --remote --merge

但是意外的是改方式一直失敗，解決辦法：咖啡兔 Git Submodule使用完整教程

SZ-denglibing:HDMasterProject fangdd$ cat .git/config
[core]
    repositoryformatversion = 0
    filemode = true
    bare = false
    logallrefupdates = true
    ignorecase = true
    precomposeunicode = true
[remote "origin"]
    url = https://github.com/erduoniba/HDMasterProject.git
    fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
    remote = origin
    merge = refs/heads/master

可以看到git的config中并沒(méi)有任何關(guān)于子工程的信息,解決辦法：

SZ-denglibing:HDMasterProject fangdd$ git submodule init
Submodule 'HDSubProjectOne' (https://github.com/erduoniba/HDSubProjectOne.git) registered for path 'HDSubProjectOne'
Submodule 'HDSubProjectTwo' (https://github.com/erduoniba/HDSubProjectTwo.git) registered for path 'HDSubProjectTwo'
SZ-denglibing:HDMasterProject fangdd$ cat .git/config
[core]
    repositoryformatversion = 0
    filemode = true
    bare = false
    logallrefupdates = true
    ignorecase = true
    precomposeunicode = true
[remote "origin"]
    url = https://github.com/erduoniba/HDMasterProject.git
    fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
    remote = origin
    merge = refs/heads/master
[submodule "HDSubProjectOne"]
    url = https://github.com/erduoniba/HDSubProjectOne.git
[submodule "HDSubProjectTwo"]
    url = https://github.com/erduoniba/HDSubProjectTwo.git

現(xiàn)在趕緊試試吧 (大功告成??！)

7、git submodule 管理子工程相關(guān)命令：

在主工程更新子工程代碼：

1、cd 主工程目錄
2、 git submodule update --remote --merge

在主工程提交子工程的代碼：

1、cd 子工程目錄
2、git checkout master （將子目錄checkout到master分支上）
3、
git pull
git add .
git commit
git push
8、代碼下載地址：

HDMasterProject地址

HDSubProjectOne地址

HDSubProjectTwo地址

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容