如何在Git历史中搜索提交的代码

技术背景

在软件开发过程中，经常需要在Git仓库的历史记录里查找特定的代码内容。例如，你可能想知道某个函数是何时被添加或修改的，或者某个特定字符串在哪些提交中出现过。Git提供了多种方式来进行这类搜索，以满足不同场景的需求。

实现步骤

1. 搜索所有提交内容

要搜索提交内容（即实际的源代码行，而非提交消息等），可以使用以下命令：

git grep <regexp> $(git rev-list --all)

如果遇到“Argument list too long”错误，可以使用：

git rev-list --all | xargs git grep <expression>

若要将搜索范围限制在某个子树（例如“lib/util”），则需要同时将该路径传递给rev-list子命令和grep：

git grep <regexp> $(git rev-list --all -- lib/util) -- lib/util

2. 其他搜索场景

搜索工作树中匹配正则表达式的文本

git grep <regexp>

搜索工作树中匹配正则表达式regexp1或regexp2的文本行

git grep -e <regexp1> [--or] -e <regexp2>

搜索工作树中同时匹配正则表达式regexp1和regexp2的文本行，仅报告文件路径

git grep -l -e <regexp1> --and -e <regexp2>

搜索工作树中同时包含匹配正则表达式regexp1和regexp2文本行的文件

git grep -l --all-match -e <regexp1> -e <regexp2>

搜索工作树中匹配模式的更改行

git diff --unified=0 | grep <pattern>

搜索所有版本中匹配正则表达式的文本

git grep <regexp> $(git rev-list --all)

搜索rev1和rev2之间所有版本中匹配正则表达式的文本

git grep <regexp> $(git rev-list <rev1>..<rev2>)

3. 使用git log的-S和-G选项

-S选项用于查找引入或删除某个字符串实例的差异，通常表示“添加或删除包含特定字符串行的提交”。例如，搜索Foo：

git log -SFoo -- path_containing_change
git log -SFoo --since=2009.1.1 --until=2010.1.1 -- path_containing_change

-G选项用于查找添加、删除或更改的行中匹配给定正则表达式的差异。例如：

git log -p --all -G 'match regular expression'

-S和-G选项在判断提交是否匹配时有细微差别：

• -S选项本质上是计算提交前后文件中搜索字符串的匹配次数，只有前后次数不同时，该提交才会显示在日志中。例如，不会显示仅移动了匹配搜索字符串行的提交。
• -G选项只要搜索匹配了任何添加、删除或更改的行，该提交就会显示在日志中。

4. 搜索特定分支或提交范围

搜索所有本地分支

time git branch | awk '{print $NF}' \
    | xargs -P "$(nproc)" -I {} git --no-pager grep -n 'my regex search' {}

搜索所有远程分支

git fetch --all
time git branch -r | awk '{print $NF}' \
    | xargs -P "$(nproc)" -I {} git --no-pager grep -n 'my regex search' {}

搜索所有本地和远程分支

git fetch --all
time git branch -a | awk '{print $NF}' \
    | xargs -P "$(nproc)" -I {} git --no-pager grep -n 'my regex search' {}

搜索指定范围的提交

time git rev-list commit_start..commit_end \
    | xargs -P "$(nproc)" -I {} git --no-pager grep -n 'my regex search' {}

5. 搜索当前文件系统

可以使用ripgrep（rg）进行快速搜索：

time rg 'my regex search'

也可以使用grep，但速度较慢：

time grep -rn 'my regex search'

6. 查找仅发生更改的字符串

可参考git log的“pickaxe”（-S）选项的使用方法。

7. 查找存在匹配的分支名称或提交哈希

将上述搜索命令的输出通过管道传递给以下命令：

| cut -d ':' -f 1 | sort -u

核心代码

搜索所有提交内容

git grep <regexp> $(git rev-list --all)

使用git log的-G选项

git log -p --all -G 'match regular expression'

搜索所有本地分支

time git branch | awk '{print $NF}' \
    | xargs -P "$(nproc)" -I {} git --no-pager grep -n 'my regex search' {}

搜索当前文件系统（使用ripgrep）

time rg 'my regex search'

最佳实践

• 使用并行处理：在搜索大量分支或提交时，使用xargs -P "$(nproc)"可以并行运行命令，显著提高搜索速度。
• 限制搜索范围：通过指定文件或文件夹路径，缩小搜索范围，减少不必要的搜索时间。
• 使用合适的工具：对于当前文件系统的搜索，ripgrep通常比grep更快。

常见问题

1. “Argument list too long”错误

当搜索范围较大时，可能会遇到此错误。可以使用git rev-list --all | xargs git grep <expression>来解决。

2. git grep和git log -S、git log -G的区别

• git grep主要用于搜索提交内容中的文本。
• git log -S用于查找引入或删除特定字符串实例的提交。
• git log -G用于查找添加、删除或更改的行中匹配正则表达式的提交。

3. 搜索结果包含重复信息

如果git grep的结果重复且冗长，可以考虑只搜索每个提交的差异部分，示例脚本如下：

for commit in $(git rev-list --all); do 
    if  git show "$commit" | grep "^[+|-].*search-string"; then 
        git show --no-patch --pretty=format:'%C(yellow)%h %Cred%ad %Cblue%an%Cgreen%d %Creset%s' --date=short $commit
    fi  
done