Git 选择性提交教程

Git选择性提交

掌握交互式暂存技巧，精确控制提交内容，创建清晰有意义的提交记录

开始学习

什么是选择性提交？

交互式暂存

选择性提交（也称为交互式暂存）允许你精确选择要包含在提交中的更改，而不是一次性提交所有更改。

  • 逐个检查每个更改
  • 选择性地暂存相关更改
  • 创建更有意义的提交
  • 分离不相关的更改

为什么需要选择性提交？

在开发过程中，我们经常在一个文件中进行多个不相关的更改。选择性提交帮助我们：

  • 保持提交的原子性
  • 创建更清晰的提交历史
  • 便于代码审查和问题追踪
  • 简化回滚和代码恢复

传统提交 vs 选择性提交

方面 传统提交 选择性提交
提交粒度 文件级别 代码块级别
提交质量 可能包含不相关更改 只包含相关更改
历史清晰度 可能混乱 清晰有序
审查效率 较低 较高
操作复杂度 简单 需要更多操作

选择性提交的优势

  • 原子性提交：每个提交只解决一个问题
  • 清晰的提交信息：可以编写更精确的提交描述
  • 简化代码审查：审查者更容易理解每次更改的目的
  • 更好的问题追踪：可以精确追踪引入bug的提交
  • 灵活的代码管理：可以轻松地回滚特定更改而不影响其他更改

提示： 选择性提交特别适合在单个工作会话中处理多个任务或修复多个bug的情况。

交互式暂存命令

交互式暂存
git add -p

启动交互式暂存模式

特定文件
git add -p <file>

对特定文件使用交互式暂存

交互式添加
git add -i

启动完整的交互式添加界面

暂存所有
git add -A

暂存所有更改（非交互式）

交互式暂存选项

在git add -p模式下可用的命令：

y - 暂存此区块
n - 不暂存此区块
q - 退出；不暂存此区块和其余区块
a - 暂存此区块和此文件中的所有后续区块
d - 不暂存此区块和此文件中的所有后续区块
g - 选择一个区块进行跳转
/ - 搜索与给定正则表达式匹配的区块
j - 暂时跳过此区块
J - 暂时跳过此区块，直到下一个文件
k - 暂时保留此区块
K - 暂时保留此区块，直到下一个文件
s - 将当前区块拆分为更小的区块
e - 手动编辑当前区块
? - 打印帮助

交互式暂存示例

典型的使用流程：

# 1. 检查当前状态
git status

# 2. 启动交互式暂存
git add -p

# 3. Git会显示第一个更改区块：
# diff --git a/file.py b/file.py
# ...
# Stage this hunk [y,n,q,a,d,j,J,g,/,s,e,?]?

# 4. 根据提示选择操作
# 输入 'y' 暂存此区块
# 输入 'n' 跳过此区块
# 输入 's' 拆分区块
# 输入 'e' 手动编辑区块

技巧： 使用s命令将大区块拆分为更小的区块，这样可以更精确地选择要暂存的代码。

选择性提交工作流程

1. 进行更改

在代码中进行多个更改

2. 检查更改

git status 和 git diff

3. 选择性暂存

git add -p

4. 提交更改

git commit -m "描述"

详细工作流程示例

# 场景：在一个文件中进行了多个不相关的更改

# 1. 检查当前状态
git status
# 输出：修改了 user_service.py

# 2. 查看具体更改
git diff user_service.py
# 显示多个不相关的更改

# 3. 启动交互式暂存
git add -p user_service.py

# 4. Git显示第一个更改区块：
# @@ -10,7 +10,7 @@ def get_user(id):
# - return User.query.get(id)
# + return User.query.filter_by(id=id).first()
# Stage this hunk [y,n,q,a,d,j,J,g,/,s,e,?]? y

# 5. Git显示第二个更改区块（不相关）：
# @@ -25,6 +25,10 @@ def create_user(data):
# + # 添加输入验证
# + if not data.get('email'):
# + raise ValueError("Email is required")
# Stage this hunk [y,n,q,a,d,j,J,g,/,s,e,?]? n

# 6. 提交第一个更改
git commit -m "修复用户查询方法"

# 7. 继续处理第二个更改
git add -p user_service.py
# 这次选择第二个更改区块并提交
git commit -m "添加用户创建验证"

区块编辑示例

使用e命令手动编辑区块：

@@ -15,7 +15,7 @@ def calculate_total(items):
total = 0
for item in items:
- total += item.price
+ total += item.price * item.quantity
return total
+ # 添加日志记录
+ logger.info(f"Calculated total: {total}")

使用e命令后，可以手动编辑区块，删除不需要的行：

@@ -15,7 +15,7 @@ def calculate_total(items):
total = 0
for item in items:
- total += item.price
+ total += item.price * item.quantity
return total
# 删除这两行以分离更改
# + # 添加日志记录
# + logger.info(f"Calculated total: {total}")

注意： 手动编辑区块时，以#开头的行会被忽略。这样可以方便地注释掉不想暂存的部分。

常见使用场景

分离bug修复

在开发新功能时发现并修复了一个bug。

# 修复bug的更改和功能开发混在一起
git add -p
# 只选择bug修复相关的更改
git commit -m "修复用户登录bug"
# 然后提交功能开发更改
重构与功能开发

在重构代码的同时添加了新功能。

# 重构更改和新功能混在一起
git add -p
# 先提交重构更改
git commit -m "重构用户验证逻辑"
# 然后提交新功能
代码格式化

在修改代码时进行了格式化调整。

# 实际更改和格式化混在一起
git add -p
# 只选择实际的功能更改
git commit -m "添加新API端点"
# 单独提交格式化更改（如果需要）
调试代码

在调试时添加了临时日志或调试代码。

# 功能更改和调试代码混在一起
git add -p
# 排除调试相关的更改
git commit -m "实现核心功能"
# 调试代码保留在工作区继续使用
多任务开发

在一个工作会话中处理了多个任务。

# 多个任务的更改混在一起
git add -p
# 分别选择每个任务的更改
git commit -m "任务A: 实现功能X"
git commit -m "任务B: 修复问题Y"
撤销部分更改

只想提交部分更改，保留其他更改继续工作。

# 只想提交已完成的部分
git add -p
# 只选择准备好的更改
git commit -m "完成功能第一部分"
# 其他更改保留在工作区继续开发

交互式暂存技巧

  • 使用拆分命令：对于大区块，使用s拆分为小块
  • 手动编辑：使用e命令精确控制要暂存的内容
  • 跳过文件：使用d跳过当前文件的所有剩余区块
  • 搜索模式：使用/搜索特定模式的更改
  • 暂存相似区块：使用a暂存当前文件的所有剩余区块

注意： 交互式暂存只处理已跟踪文件的更改。对于新文件，需要先使用git add <file>将其添加到Git跟踪中。

高级技巧： 结合使用git stash -p可以进行交互式储藏，选择性地储藏部分更改，这在需要临时清理工作区时非常有用。

最佳实践与工作流

选择性提交最佳实践

原子性提交

每个提交应该只解决一个问题或实现一个功能：

  • 避免在一个提交中混合多个不相关的更改
  • 每个提交应该有明确的单一目的
  • 提交信息应该准确描述所做的更改
清晰的提交信息

编写有意义的提交信息：

  • 使用命令式语气（如"修复"而不是"修复了"）
  • 第一行简短描述（50字符以内）
  • 详细描述在第二段（解释为什么而不是什么）
  • 引用相关的问题或任务编号
频繁提交

小而频繁的提交：

  • 更小的提交更容易理解和审查
  • 减少合并冲突的可能性
  • 便于回滚到特定状态
  • 提供更细粒度的项目历史

完整工作流示例

# 1. 开始新功能开发
git checkout -b feature/user-profile

# 2. 进行多个相关和不相关的更改
# ... 编写代码 ...

# 3. 检查更改状态
git status
git diff

# 4. 使用交互式暂存分离更改
git add -p

# 5. 首先提交核心功能
# 选择与用户资料显示相关的更改
git commit -m "实现用户资料基本信息显示"

# 6. 提交次要功能
# 继续使用 git add -p
git commit -m "添加用户资料编辑功能"

# 7. 提交样式改进
git commit -m "改进用户资料页面样式"

# 8. 推送分支并创建Pull Request
git push -u origin feature/user-profile

工具和别名

创建Git别名简化操作：

# 添加到 ~/.gitconfig
[alias]
ap = add -p
ci = commit
co = checkout
st = status
br = branch
df = diff
lg = log --oneline --graph --decorate

提示： 使用git config --global alias.ap 'add -p'可以创建git ap作为git add -p的快捷方式。

常见问题与解决

可以使用git reset HEAD <file>取消暂存整个文件，或者使用git reset -p进行交互式取消暂存。

# 交互式取消暂存
git reset -p

# 或者取消暂存整个文件
git reset HEAD filename.txt

新文件需要先使用git add <file>添加到Git跟踪中，然后才能使用交互式暂存。

# 添加新文件到Git跟踪
git add newfile.py

# 然后可以使用交互式暂存
git add -p newfile.py

  • 使用git ap别名（如果设置了）
  • 熟悉常用命令（y, n, s, e, q）
  • 使用a和d快速处理整个文件
  • 使用/搜索特定模式的更改
  • 定期提交，避免一次处理太多更改

与其他Git功能的结合

与储藏结合

选择性储藏部分更改：

git stash -p
# 交互式选择要储藏的更改
与重置结合

选择性取消暂存：

git reset -p
# 交互式选择要取消暂存的更改
与检出结合

选择性丢弃工作区更改：

git checkout -p
# 交互式选择要丢弃的更改
与交互式变基结合

整理提交历史：

git rebase -i HEAD~5
# 交互式编辑最近5个提交

专业工作流： 结合使用交互式暂存和交互式变基可以创建非常清晰和有条理的提交历史，这对于长期项目维护和团队协作非常有价值。

上一章: Git 变基操作 下一章: Git 钩子