【Git】浅克隆、子模块与稀疏克隆全解析

博主： Fivk
发布时间：2024 年 11 月 21 日
1 次浏览
9194字数
分类： Linux

从git上拉取项目时发现内容太多，而我只想拉去部分内容进行修改，于是我通过网上资料查找写下了这篇文章，主要有三种方式可以实现浅克隆、子模块与稀疏克隆。

</div>

## 一、浅克隆（Shallow Clone）介绍

### 原理

浅克隆是一种部分克隆Git仓库的方式。在常规的`git clone`操作中，会完整地复制远程仓库的所有提交历史、分支、标签等信息。而浅克隆通过`--depth`选项，限制了克隆的深度，只获取指定数量的最新提交。例如，`--depth 1`表示只克隆最近的一次提交，`--depth 5`则克隆最近的五次提交。

### 用途

当你只需要处理仓库的最新状态，而不需要完整的历史记录时，浅克隆非常有用。比如，对于大型仓库，完整克隆可能会花费大量的时间和磁盘空间，浅克隆可以显著减少这些开销。这在持续集成/持续交付（CI/CD）环境中，或者当你只是想快速获取最新代码进行测试或简单修改时，优势明显。

### 限制

由于浅克隆没有完整的仓库历史，一些依赖完整历史的操作会受到影响。例如，`git log`命令将只能显示浅克隆所包含的提交记录，无法查看更早的提交。另外，在推送更改时，如果远程仓库的分支已经有了新的提交，而你的浅克隆没有包含这些提交，`git push`可能会被拒绝。此时，需要使用`--force - with - lease`选项来安全地推送更改，这个选项会检查在你克隆之后远程分支是否有更新，只有在没有冲突的情况下才允许推送。

## 浅克隆（Shallow Clone）案例

### 场景设定

假设你正在参与一个大型的开源软件项目，这个项目已经有多年的开发历史，包含了大量的提交记录。你被分配了一个任务，需要在项目的最新版本基础上添加一个小功能，例如在一个网页应用中添加一个新的按钮，并且这个功能不需要参考项目的历史代码版本。

### 操作步骤

#### 1.克隆仓库

- 首先，使用浅克隆来获取项目的最新代码。假设项目的仓库地址是`https://github.com/[project - owner]/[project - name].git`，你可以使用以下命令进行浅克隆，这里我们只获取最近的一次提交：

```bash
git clone --depth 1 https://github.com/[project - owner]/[project - name].git my - project
```

- 这个命令会在本地创建一个名为`my - project`的目录，并将远程仓库的最新代码克隆到这个目录中。因为使用了浅克隆，所以克隆过程会比完整克隆快很多，而且占用的磁盘空间也会少很多。

#### 2.进入项目目录并修改代码

- 进入克隆后的项目目录：
  - `cd my-project`
- 假设这是一个基于HTML、CSS和JavaScript的网页应用，你可以在相关的HTML文件中添加新按钮的代码。例如，在`index.html`文件中添加以下代码：

```html
<button id="new-button">New Button</button>
```

- 然后，在JavaScript文件（假设是`main.js`）中添加按钮的点击事件处理函数：

```javascript
document.getElementById("new-button").addEventListener("click", function() {
    alert("You clicked the new button!");
});
```

#### 3.提交更改

- 将修改后的文件添加到暂存区：
  - `git add index.html main.js`
- 提交更改，并添加一个有意义的提交信息：
  - `git commit -m "Added a new button to the web app"`

#### 4.推送更改（注意事项）

- 当你想要将修改后的代码推送到远程仓库时，由于是浅克隆，可能会遇到一些问题。因为浅克隆没有完整的分支历史，`git push`可能会被拒绝。为了安全地推送更改，你可以使用`--force - with - lease`选项。假设远程仓库的名称是`origin`，主分支是`main`，你可以使用以下命令推送：

```bash
  git push --force - with - lease origin main
  ```
- 这个选项会检查在你克隆之后远程分支是否有更新，只有在没有冲突的情况下才允许推送，从而避免覆盖其他开发人员的工作成果。

## 二、子模块（Submodule）介绍

### 原理

子模块是一种将一个Git仓库嵌套在另一个Git仓库中的机制。当你将一个仓库作为子模块添加到主仓库时，主仓库实际上只是记录了子模块仓库的引用信息，包括子模块仓库的提交哈希值。这样，主仓库可以明确子模块所对应的具体版本。从本质上讲，子模块允许你把一个复杂的项目分解成多个相对独立的部分，每个部分都有自己独立的版本控制。

### 用途

这种方式在大型项目中非常有用。例如，一个软件项目可能包含前端和后端两个主要部分，后端部分又可以细分为数据库模块、业务逻辑模块等。通过使用子模块，你可以将这些不同的模块分别作为独立的Git仓库进行管理，同时又能将它们整合到一个主项目仓库中。这使得不同模块可以由不同的团队或开发者独立开发、维护和更新，同时保持整个项目结构的完整性。

### 操作流程细节

#### 1.添加子模块

使用`git submodule add [submodule - repository - url] [submodule - directory - path]`命令来添加子模块。其中`[submodule - repository - url]`是子模块仓库的远程地址，`[submodule - directory - path]`是子模块在主仓库中存放的目录路径。

#### 2.初始化和更新子模块

当克隆一个包含子模块的主仓库时，子模块不会自动初始化和更新。需要先使用`git submodule init`命令来初始化子模块，该命令会在主仓库的`.git/config`文件中注册子模块的信息。然后使用`git submodule update`命令来实际拉取子模块仓库的代码。

#### 3.修改子模块

要修改子模块，需要进入子模块所在的目录（使用`cd [submodule - directory - path]`），在子模块仓库中进行常规的`git pull`、`git add`、`git commit`等操作。

#### 4.更新主仓库中的子模块引用

在子模块修改并提交后，需要回到主仓库目录，使用`git add [submodule - directory - path]`将子模块的新状态（新的提交哈希值）添加到主仓库的暂存区，然后通过`git commit`来更新主仓库中关于子模块的引用。

### 子模块（Submodule）案例

#### 场景设定

假设你正在开发一个移动应用，这个应用包含一个用户界面（UI）部分和一个后端服务部分。UI部分主要使用前端技术（如React Native）进行开发，后端服务则是一个独立的基于Node.js的服务器。你希望将这两个部分作为独立的Git仓库进行管理，同时又能方便地将它们整合到一个主项目仓库中，用于整个移动应用的构建和部署。

#### 操作步骤

##### 1.添加子模块

- 首先，创建一个主项目仓库（假设名称为`mobile - app - project`），并进入该仓库目录。
- 然后，将UI部分的仓库作为子模块添加进来。假设UI仓库的远程地址是`https://github.com/[ui - owner]/[ui - repository - name].git`，你希望将子模块放在主仓库的`ui`目录下，使用以下命令添加子模块：

```bash
  git submodule add https://github.com/[ui - owner]/[ui - repository - name].git ui
  ```
- 同样，将后端服务仓库作为子模块添加到主仓库的`backend`目录下。假设后端仓库的远程地址是`https://github.com/[backend - owner]/[backend - repository - name].git`，添加命令如下：

```bash
  git submodule add https://github.com/[backend - owner]/[backend - repository - name].git backend
  ```

##### 2.初始化和更新子模块（当克隆主仓库时）

- 当其他开发人员克隆这个包含子模块的主仓库时，他们需要在主仓库目录下执行以下两个命令来初始化和更新子模块。
- 首先初始化子模块：

```bash
  git submodule init
  ```

然后更新子模块，拉取子模块仓库的代码：

```bash
  git submodule update
  ```

##### 3.修改子模块（以UI部分为例）

- 假设你是负责UI部分开发的人员，你进入UI子模块目录：

```bash
  cd ui
  ```

拉取UI仓库的最新代码（如果有更新）：

```bash
  git pull
  ```
- 对UI代码进行修改，例如修改一个组件的样式。假设在一个React Native组件文件`MyComponent.js`中修改样式代码如下：

```javascript
  import React from 'react';
  import { StyleSheet, Text, View } from 'react - native';
  // 修改前的样式
  const styles = StyleSheet.create({
      container: {
          backgroundColor: 'white',
          alignItems: 'center',
          justifyContent: 'center',
          padding: 20
      }
  });
  // 修改后的样式
  const styles = StyleSheet.create({
      container: {
          backgroundColor: 'lightgray',
          alignItems: 'flex - start',
          justifyContent: 'space - around',
          padding: 30
      }
  });
  const MyComponent = () => {
      return (
          <View style = {styles.container}>
              <Text>Hello, World!</Text>
          </View>
      );
  };
  export default MyComponent;
  ```

将修改后的文件添加到暂存区并提交：

```bash
  git add MyComponent.js
  git commit -m "Updated the style of MyComponent"
  ```

##### 4.更新主仓库中的子模块引用（UI部分）

- 回到主仓库目录：

```bash
  cd..
  ```
- 更新主仓库中关于UI子模块的引用：

```bash
  git add ui
  git commit -m "Updated UI submodule"
  ```

##### 5.构建和部署整个移动应用（涉及子模块更新）

当需要构建和部署整个移动应用时，由于主仓库记录了子模块的最新引用（通过提交哈希值），构建系统可以根据这些引用拉取正确版本的子模块代码，然后将UI部分和后端部分整合在一起进行应用的构建和部署。例如，在持续集成/持续交付（CI/CD）系统中，可以设置脚本，先更新子模块，然后执行构建和部署步骤，确保每次部署的应用都包含了最新且正确版本的各个子模块。

## 三、稀疏克隆（Sparse Clone）介绍

### 原理

稀疏克隆是一种在Git中用于只克隆仓库特定部分内容的机制。它允许开发者在克隆远程仓库时，通过特定的配置选项，不下载整个仓库的所有文件和目录，而是仅获取指定的部分。在进行稀疏克隆时，使用`--filter=blob:none`等相关选项（具体取决于需求和Git版本），可以控制克隆过程，使得初始克隆操作主要获取仓库的目录结构、提交历史等元数据信息，而暂不下载大量的文件内容。之后再通过`git sparse-checkout`命令来精确指定要实际检出（下载并可操作）的文件或目录。这样一来，就能够实现根据项目需求，灵活且有针对性地获取仓库的部分内容进行开发工作，避免了因克隆整个大型仓库而带来的大量磁盘空间占用和长时间的下载等待等问题。

### 用途

在大型项目仓库场景下非常实用。例如，一个大型企业级项目可能包含众多不同功能模块、大量的文档资料、测试数据等，而开发人员可能只负责其中某一个或几个特定功能模块的开发工作。通过稀疏克隆，开发人员可以只获取与自己所负责模块相关的文件和目录，无需下载那些与当前任务无关的大量其他内容，从而节省磁盘空间、加快克隆速度，提高开发效率。另外，在多人协作开发的项目中，如果不同团队或开发者关注的重点不同，也可以各自通过稀疏克隆获取自己所需的部分，减少不必要的数据传输和存储。

### 操作流程细节

#### 1. 进行稀疏克隆操作

从Git 2.25版本开始支持稀疏克隆相关功能。首先，使用`git clone --filter=blob:none [repository-url]`命令进行稀疏克隆。这里的`--filter=blob:none`选项表示在克隆时不下载文件内容（仅获取目录结构和提交历史等元数据）。例如，如果远程仓库的地址是`https://github.com/[username]/[repository-name].git`，则执行命令如下：

```bash
git clone --filter=blob:none https://github.com/[username]/[repository-name].git my-project
```

此操作会在本地创建一个名为`my-project`的目录，并将远程仓库的相关元数据克隆到该目录下，但此时并没有实际下载大量的文件内容。

#### 2. 指定要检出的内容

在完成上述稀疏克隆后，需要使用`git sparse-checkout`命令来指定要实际检出（下载并可操作）的文件或目录。

例如，若只想获取远程仓库中的`src`目录进行开发工作，可以执行以下命令：

```bash
git sparse-checkout add src
```

这就使得只有`src`目录及其包含的文件会被实际下载到本地，可供后续的修改、提交等操作。

如果之后想要再添加其他目录进行检出，比如还想获取`docs`目录，同样可以使用`git sparse-checkout add docs`命令，只对`src/java`目录下的代码进行开发或修改，就可以使用`git sparse - checkout add src/java`来仅获取这部分内容。。

若要查看当前已经设置的稀疏检出的内容，可以使用`git sparse-checkout list`命令，它会列出所有已被指定要检出的文件或目录。

#### 3. 修改并提交稀疏克隆获取的内容

在通过`git sparse-checkout`指定并下载了所需的文件或目录后，就可以像操作普通Git仓库一样在这些检出的内容中进行修改。

假设在上述检出的`src`目录下有一个`main.py`文件（这里以Python项目为例），对其进行修改，比如添加一个新函数：

```python
def new_function():
    print("This is a new function added after sparse cloning.")
```

然后将修改后的文件添加到暂存区并提交。首先添加到暂存区：

```bash
git add main.py
```

再进行提交操作，并添加合适的提交信息：

```bash
git commit -m "Added a new function in the sparse cloned src directory"
```

#### 稀疏克隆（Sparse Clone）案例

#### 场景设定

假设你所在的团队正在开发一个大型的综合性软件项目，该项目包含多个不同的子项目，如前端界面开发（包含多个页面模块）、后端服务器开发（包含不同的业务逻辑模块和数据库交互模块）、各种项目文档编写等。你主要负责前端界面开发中的某个特定页面模块，比如登录页面模块的开发工作。整个项目仓库非常庞大，包含了大量与其他模块相关的文件和资料，若完整克隆会耗费大量磁盘空间和下载时间。

#### 操作步骤

##### 1. 进行稀疏克隆

- 首先，确定远程仓库的地址，假设为`https://github.com/[project-owner]/[project-name].git`。
- 然后，使用稀疏克隆命令进行克隆操作，由于你只需要获取与前端界面开发相关的部分内容（暂时先不考虑具体某个页面模块，先获取前端整体相关部分的目录结构等元数据）：

```bash
git clone --filter=blob:none https://github.com/[project-owner]/[project-name].git my-frontend-project
```

此操作会在本地创建`my-frontend-project`目录，并克隆相关元数据到该目录下，此时尚未下载大量文件内容。

##### 2. 指定要检出的内容（针对前端界面开发相关部分）

- 由于你主要负责前端界面开发，知道前端相关的文件大多存放在远程仓库的`frontend`目录下，所以使用`git sparse-checkout`命令来指定要检出的内容：

```bash
git sparse-checkout add frontend
```

这样，`frontend`目录及其包含的文件就会被实际下载到本地，可供后续操作。

##### 3. 进一步指定要检出的登录页面模块内容

- 进入已检出的`frontend`目录：

```bash
cd my-frontend-project/frontend
```

- 发现登录页面模块相关文件存放在`login-page`子目录下，为了只获取该子目录下的文件进行开发，再次使用`git sparse-checkout`命令：

```bash
git sparse-checkout add login-page
```

此时，只有`login-page`子目录及其包含的文件会被进一步下载到本地（如果之前未下载过），方便你对登录页面模块进行开发。

##### 4. 修改并提交登录页面模块相关内容

- 假设在`login-page`目录下有一个`login.js`文件（这里以JavaScript项目为例），对其进行修改，比如优化登录按钮的点击事件处理函数：

```javascript
// 修改前
document.getElementById('login-button').addEventListener('click', function() {
    // 原始登录处理逻辑
});

// 修改后
document.getElementById('login-button').addEventListener('click', function() {
    // 优化后的登录处理逻辑
    console.log('Login button clicked, performing optimized login process.');
});
```

- 将修改后的文件添加到暂存区：

```bash
git add login.js
```

- 进行提交操作，并添加合适的提交信息：

```bash
git commit -m "Optimized the click event handler of the login button in the login-page module"
```

最后修改：2024 年 11 月 21 日

如果觉得我的文章对你有用，请随意赞赏

【Git】浅克隆、子模块与稀疏克隆全解析

Fivk • 2024 年 11 月 21 日

</div>

## 一、浅克隆（Shallow Clone）介绍

### 原理

### 用途

### 限制

## 浅克隆（Shallow Clone）案例

### 场景设定

### 操作步骤

#### 1.克隆仓库

```bash
git clone --depth 1 https://github.com/[project - owner]/[project - name].git my - project
```

#### 2.进入项目目录并修改代码

```html
<button id="new-button">New Button</button>
```

- 然后，在JavaScript文件（假设是`main.js`）中添加按钮的点击事件处理函数：

```javascript
document.getElementById("new-button").addEventListener("click", function() {
    alert("You clicked the new button!");
});
```

#### 3.提交更改

- 将修改后的文件添加到暂存区：
  - `git add index.html main.js`
- 提交更改，并添加一个有意义的提交信息：
  - `git commit -m "Added a new button to the web app"`

#### 4.推送更改（注意事项）

## 二、子模块（Submodule）介绍

### 原理

### 用途

### 操作流程细节

#### 1.添加子模块

#### 2.初始化和更新子模块

#### 3.修改子模块

要修改子模块，需要进入子模块所在的目录（使用`cd [submodule - directory - path]`），在子模块仓库中进行常规的`git pull`、`git add`、`git commit`等操作。

#### 4.更新主仓库中的子模块引用

### 子模块（Submodule）案例

#### 场景设定

#### 操作步骤

##### 1.添加子模块

```bash
  git submodule add https://github.com/[backend - owner]/[backend - repository - name].git backend
  ```

##### 2.初始化和更新子模块（当克隆主仓库时）

- 当其他开发人员克隆这个包含子模块的主仓库时，他们需要在主仓库目录下执行以下两个命令来初始化和更新子模块。
- 首先初始化子模块：

```bash
  git submodule init
  ```

然后更新子模块，拉取子模块仓库的代码：

```bash
  git submodule update
  ```

##### 3.修改子模块（以UI部分为例）

- 假设你是负责UI部分开发的人员，你进入UI子模块目录：

```bash
  cd ui
  ```

拉取UI仓库的最新代码（如果有更新）：

```bash
  git pull
  ```
- 对UI代码进行修改，例如修改一个组件的样式。假设在一个React Native组件文件`MyComponent.js`中修改样式代码如下：

将修改后的文件添加到暂存区并提交：

```bash
  git add MyComponent.js
  git commit -m "Updated the style of MyComponent"
  ```

##### 4.更新主仓库中的子模块引用（UI部分）

- 回到主仓库目录：

```bash
  cd..
  ```
- 更新主仓库中关于UI子模块的引用：

```bash
  git add ui
  git commit -m "Updated UI submodule"
  ```

##### 5.构建和部署整个移动应用（涉及子模块更新）

## 三、稀疏克隆（Sparse Clone）介绍

### 原理

### 用途

### 操作流程细节

#### 1. 进行稀疏克隆操作

```bash
git clone --filter=blob:none https://github.com/[username]/[repository-name].git my-project
```

此操作会在本地创建一个名为`my-project`的目录，并将远程仓库的相关元数据克隆到该目录下，但此时并没有实际下载大量的文件内容。

#### 2. 指定要检出的内容

在完成上述稀疏克隆后，需要使用`git sparse-checkout`命令来指定要实际检出（下载并可操作）的文件或目录。

例如，若只想获取远程仓库中的`src`目录进行开发工作，可以执行以下命令：

```bash
git sparse-checkout add src
```

这就使得只有`src`目录及其包含的文件会被实际下载到本地，可供后续的修改、提交等操作。

若要查看当前已经设置的稀疏检出的内容，可以使用`git sparse-checkout list`命令，它会列出所有已被指定要检出的文件或目录。

#### 3. 修改并提交稀疏克隆获取的内容

在通过`git sparse-checkout`指定并下载了所需的文件或目录后，就可以像操作普通Git仓库一样在这些检出的内容中进行修改。

假设在上述检出的`src`目录下有一个`main.py`文件（这里以Python项目为例），对其进行修改，比如添加一个新函数：

```python
def new_function():
    print("This is a new function added after sparse cloning.")
```

然后将修改后的文件添加到暂存区并提交。首先添加到暂存区：

```bash
git add main.py
```

再进行提交操作，并添加合适的提交信息：

```bash
git commit -m "Added a new function in the sparse cloned src directory"
```

#### 稀疏克隆（Sparse Clone）案例

#### 场景设定

#### 操作步骤

##### 1. 进行稀疏克隆

```bash
git clone --filter=blob:none https://github.com/[project-owner]/[project-name].git my-frontend-project
```

此操作会在本地创建`my-frontend-project`目录，并克隆相关元数据到该目录下，此时尚未下载大量文件内容。

##### 2. 指定要检出的内容（针对前端界面开发相关部分）

- 由于你主要负责前端界面开发，知道前端相关的文件大多存放在远程仓库的`frontend`目录下，所以使用`git sparse-checkout`命令来指定要检出的内容：

```bash
git sparse-checkout add frontend
```

这样，`frontend`目录及其包含的文件就会被实际下载到本地，可供后续操作。

##### 3. 进一步指定要检出的登录页面模块内容

- 进入已检出的`frontend`目录：

```bash
cd my-frontend-project/frontend
```

- 发现登录页面模块相关文件存放在`login-page`子目录下，为了只获取该子目录下的文件进行开发，再次使用`git sparse-checkout`命令：

```bash
git sparse-checkout add login-page
```

此时，只有`login-page`子目录及其包含的文件会被进一步下载到本地（如果之前未下载过），方便你对登录页面模块进行开发。

##### 4. 修改并提交登录页面模块相关内容

- 假设在`login-page`目录下有一个`login.js`文件（这里以JavaScript项目为例），对其进行修改，比如优化登录按钮的点击事件处理函数：

```javascript
// 修改前
document.getElementById('login-button').addEventListener('click', function() {
    // 原始登录处理逻辑
});

- 将修改后的文件添加到暂存区：

```bash
git add login.js
```

- 进行提交操作，并添加合适的提交信息：

```bash
git commit -m "Optimized the click event handler of the login button in the login-page module"
```

【Git】浅克隆、子模块与稀疏克隆全解析

【踩坑日志】SpringBoot项目启动提示This primary key of "id" is primitive !不建议如此请使用包装类 in Class:

【C】极域电子教室学生端解除控制

【开发技巧】@CrossOrigin注解解决跨域问题

这是好东西

【Fivk】文章归档

【Git】基础使用与在IDEA中使用GIt

【C】链表_回顾一下

此内容被密码保护

【C】文件_文件结束检测函数(feof)

【Java】多线程

【Git】浅克隆、子模块与稀疏克隆全解析

【Git】 浅克隆、子模块与稀疏克隆全解析

【Git】浅克隆、子模块与稀疏克隆全解析