新增、更新和刪除 Git 子模組

---

介紹

Git 是一種流行的版本控制系統，用於管理原始碼。Git 的強大功能之一是能夠將外部儲存庫作為子模組合併到專案中。這允許您在自己的專案中重用其他儲存庫中的程式碼，並獨立跟蹤父專案和子模組的變化。

在本文中，我們將探討如何新增、更新和刪除 Git 子模組。我們將介紹每個操作所需的常用命令和選項，以及示例以幫助您更好地理解流程。

新增 Git 子模組

新增 Git 子模組是一個簡單的過程。要將新的子模組新增到您的專案中，可以使用 `git submodule add` 命令。此命令需要兩個引數：子模組儲存庫的 URL，以及子模組應在專案中新增到的路徑。

例如，假設我們想將 "jquery" 儲存庫作為子模組新增到我們的專案中。我們將使用以下命令：

git submodule add https://github.com/jquery/jquery.git path/to/submodule

此命令將克隆 "jquery" 儲存庫到專案中的 "path/to/submodule" 目錄，並將其新增為子模組。

更新 Git 子模組

將子模組新增到專案後，您可能希望更新它以獲取最新的更改。要更新子模組，可以使用 `git submodule update` 命令。

此命令可以使用多個選項來控制更新執行的方式。預設行為是將子模組更新到父專案 `.gitmodules` 檔案中指定的提交。但是，您也可以將子模組更新到最新提交，或更新到特定的分支或提交雜湊值。

例如，假設我們想將 "jquery" 子模組更新到最新提交。我們將使用以下命令：

git submodule update --remote path/to/submodule

此命令將從 "jquery" 儲存庫獲取最新的更改，並將專案中的子模組更新到最新提交。

刪除 Git 子模組

如果專案中不再需要子模組，可以使用 `git submodule deinit` 和 `git rm` 命令將其刪除。

`git submodule deinit` 命令從專案的 `.git/config` 檔案中刪除子模組。這會告訴 Git 停止跟蹤子模組的更改。但是，子模組的檔案仍然存在於專案的目錄中。

要刪除子模組的檔案，可以使用 `git rm` 命令。此命令會從專案的目錄中刪除子模組的檔案，以及從 Git 的索引中刪除。

例如，假設我們想從專案中刪除 "jquery" 子模組。我們將使用以下命令：

git submodule deinit path/to/submodule
git rm path/to/submodule

這些命令將從專案的 `.git/config` 檔案中刪除 "jquery" 子模組，並將其檔案從專案的目錄中刪除。

高階子模組管理

除了新增、更新和刪除 Git 子模組的基本操作外，還可以使用多種高階技術來更有效地管理子模組。

遞迴子模組初始化和更新

如果專案包含多個子模組，單獨初始化和更新它們可能會變得很麻煩。幸運的是，Git 提供了一個遞迴選項，允許您一次初始化和更新所有子模組。

要遞迴初始化專案中的所有子模組，可以使用 `git submodule update --init` 命令。此命令將初始化所有尚未初始化的子模組。

要遞迴更新專案中的所有子模組，可以使用 `git submodule update --recursive` 命令。此命令將所有子模組更新到父專案 `.gitmodules` 檔案中指定的提交。

自定義子模組分支

預設情況下，子模組會更新到父專案 `.gitmodules` 檔案中指定的提交。但是，您也可以為每個子模組指定自定義分支或提交雜湊值。

要為子模組指定自定義分支，可以使用 `git submodule add` 命令的 `--branch` 選項。例如：

git submodule add --branch my-branch https://github.com/my-repo/my-submodule.git path/to/submodule

此命令將新增 "my-submodule" 儲存庫作為子模組，並檢出 "my-branch" 分支。

要將子模組更新到自定義分支或提交雜湊值，可以使用 `git submodule update --remote --merge` 命令，並使用 `--remote` 和 `--merge` 選項。例如：

git submodule update --remote --merge path/to/submodule

此命令將從 "my-submodule" 儲存庫獲取最新的更改，並將它們合併到當前分支。

子模組暫存

更新子模組時，在子模組中所做的任何本地更改都將丟失。為了避免丟失這些更改，可以在更新子模組之前使用 Git 的暫存功能儲存更改。

要暫存子模組中的更改，可以使用 `git submodule foreach` 命令和 `git stash` 命令。例如：

git submodule foreach 'git stash'

此命令將暫存專案中所有子模組的更改。

要更新子模組後應用暫存的更改，可以使用 `git submodule foreach` 命令和 `git stash apply` 命令。例如：

git submodule foreach 'git stash apply'

此命令將應用專案中所有子模組的暫存更改。

Git 子模組問題的故障排除

雖然 Git 子模組是管理程式碼依賴項的強大工具，但當出現問題時，它們也可能成為令人沮喪的來源。以下是一些常見問題及其解決方案：

問題：子模組未初始化

克隆包含子模組的 Git 儲存庫時，預設情況下不會初始化子模組。您需要執行 `git submodule update` 命令來初始化它們。

解決方案 - 執行 `git submodule update --init`

問題：子模組檔案丟失

有時，初始化子模組後，子模組的檔案可能會丟失。如果子模組的檔案未正確包含在初始克隆中，則可能會發生這種情況。

解決方案 - 執行 `git submodule update --init --recursive`

此命令將更新所有子模組，包括在初始克隆期間未正確初始化的子模組。

問題：子模組分支不同步

如果子模組的分支與父儲存庫不同步，則在更新子模組時可能會遇到衝突。

解決方案 - 更新子模組分支

要更新子模組分支，可以使用 `git submodule update --remote` 命令，並使用 `--rebase` 選項。此命令將從子模組儲存庫獲取最新的更改，並將更改重新定位到當前分支。

問題：子模組未更新

有時，使用 `git submodule update` 命令更新子模組可能不會產生預期的更改。

解決方案 - 檢查子模組分支和提交

確保子模組位於正確的分支和提交上。可以使用 `git submodule status` 命令檢查子模組的分支和提交。如果子模組不在預期的分支或提交上，可以使用 `git submodule update --remote` 命令，並使用 `--merge` 選項將子模組更新到最新提交。

結論

在本文中，我們探討了如何新增、更新和刪除 Git 子模組。子模組是 Git 的一項強大功能，允許您在自己的專案中重用其他儲存庫中的程式碼。通過了解如何使用子模組，您可以提高程式碼的組織性和可維護性。

請記住使用 `git submodule add`、`git submodule update`、`git submodule deinit` 和 `git rm` 命令來有效地管理子模組。請記住，子模組可能很複雜，因此務必花時間瞭解它們的工作原理以及如何正確使用它們。