如何使用 .gitignore：含示例的实用入门

.gitignore 的语法

如前所述，.gitignore 文件包含与仓库中文件名进行匹配的模式，以确定是否应忽略它们。

基础语法

.gitignore 文件的核心是由多行组成，每一行代表一个要忽略的模式。模式可以匹配：

• 特定文件
• 文件类型
• 目录

该文件也支持注释，行首以 # 开头即可；另外可以使用空行来提升可读性。

下面是基本结构概览：

• 忽略特定文件： 可直接列出文件名来忽略它。

secrets.txt技术支持

• 忽略整个目录： 在目录名末尾添加 /，即可忽略该目录中的所有内容。

logs/技术支持

• 忽略某一类文件： 可使用通配符（*）忽略具有特定扩展名的所有文件。

*.py技术支持

• 取反：可以使用 ! 来对某个模式取反，显式跟踪原本会被忽略的特定文件或目录。

*.txt  # 忽略所有 .txt 文件
!readme.txt  # 但不忽略 readme.txt技术支持

如何创建并使用 .gitignore 文件

创建并使用 .gitignore 相当直接。本节将带您逐步完成。

创建 .gitignore 文件

步骤 1：进入仓库根目录。.gitignore 文件通常放在 Git 项目的根目录。打开终端或命令行，进入您的 Git 仓库根目录：

cd /path/to/your/repo技术支持

步骤 2：创建 .gitignore 文件。进入根目录后，使用任意文本编辑器创建 .gitignore 文件，或在终端运行如下命令：

touch .gitignore技术支持

步骤 3：向文件添加模式。在文本编辑器中打开 .gitignore，添加需要忽略的文件或目录模式。每一行代表一个模式。

下面是一个基础项目中常用的 .gitignore 示例：

# 忽略 node_modules 与依赖目录
node_modules/
vendor/

# 忽略构建产物
dist/
build/
*.log

# 忽略系统生成文件
.DS_Store
Thumbs.db

# 忽略环境与机密文件
.env
config.json技术支持

添加完必要的模式后，保存文件。此后在暂存或提交变更时，Git 将自动忽略这些文件。

步骤 4：将文件提交到仓库。务必将 .gitignore 提交到仓库，以便所有协作者使用相同的忽略规则，确保整个项目的一致性。

git add .gitignore
git commit -m "Add .gitignore file"
git push技术支持

一旦提交了 .gitignore 文件，您就为整个团队建立了共享的忽略规则。

想熟练掌握 Git 的 push 与 pull？了解如何与远程仓库同步工作，请查看这篇 Git 推送与拉取教程。

使用 .gitignore 的最佳实践

虽然创建 .gitignore 是维护干净 Git 仓库的基础操作，但为了长期有效地管理它，还应遵循若干最佳实践。

使用全局 .gitignore

对于在多个项目间工作的开发者，有些文件您可能希望在任何仓库中都排除，无论项目类型如何。

与其在每个项目的 .gitignore 中重复添加，不如配置一个全局 .gitignore，使其适用于系统中的所有仓库。

配置全局 .gitignore 文件的方法：

• 创建 .gitignore_global 文件：

touch ~/.gitignore_global技术支持

• 添加希望全局忽略的模式，例如：

.DS_Store
*.log
/.vscode/
/.idea/技术支持

• 设置 Git 使用全局 .gitignore：

git config --global core.excludesfile ~/.gitignore_global技术支持

利用现成模板

无需每个新项目都从零编写 .gitignore，您可以使用针对特定语言、框架或环境的预配置模板。

其中一个最佳资源是GitHub 官方 .gitignore 仓库，您可以在其中找到覆盖数百种编程语言与框架的 .gitignore 文件。

定期审查 .gitignore

随着项目演进，可能会出现需要加入到 .gitignore 的新文件与目录。请定期审查并更新该文件，以反映项目的当前状态。

以下场景可能需要更新 .gitignore：

• 采用会生成额外文件的新工具或库（如切换到新构建系统）。
• 重构或调整目录结构，导致出现应排除的新文件。
• 移除已废弃、不再属于项目的文件或目录。

.gitignore 故障排查

即使已设置好 .gitignore，您仍可能遇到特定文件被跟踪，或某些模式未按预期生效的情况。本节将涵盖两个常见排查方向及其解决方案。

已提交文件仍被跟踪

.gitignore 不会对已提交的文件追溯生效。

如果在某些文件已提交后才将其模式加入 .gitignore，即使它们匹配该模式，Git 仍会继续跟踪它们。

要停止跟踪已提交的文件，请按以下步骤操作：

• 从 Git 跟踪中移除文件： 使用 git rm 命令将其从仓库中移除，但保留在工作区。

git rm --cached <file_or_directory_name>技术支持

• 提交更改： 从 Git 跟踪中移除这些文件后，提交更改，确保它们不再属于版本控制历史的一部分。

git commit -m "Stop tracking ignored files"技术支持

• 将更改推送到远程仓库：最后，将更改推送到远程仓库，确保这些文件不再被跟踪。

git push技术支持

完成以上步骤后，Git 将停止跟踪这些文件。工作区中仍会保留该文件，但基于您的 .gitignore 模式，后续提交会忽略它。

确保模式生效

有时，您可能会发现预期应被忽略的文件仍出现在 Git 状态中，或被跟踪。

请按以下步骤确认 .gitignore 模式是否正确生效：

• 检查文件状态： 使用 git status 查看哪些文件被 Git 跟踪，以验证被忽略的文件是否仍被列出。

git status技术支持

• 确认模式是否正确： 仔细检查 .gitignore 模式语法是否正确。例如：
• 确保使用正确的目录路径（相对于仓库根目录）。
• 为目标目录添加 /，以避免误将同名文件全部忽略。

• 刷新缓存： 如果您刚更新了 .gitignore 但变更尚未生效，可能是 Git 仍在使用旧的缓存。可运行以下命令刷新缓存：

git rm -r --cached .
git add .
git commit -m "Refresh .gitignore"技术支持

• 检查例外： 有时，.gitignore 中的某个模式可能被文件中更具体的规则覆盖。请检查规则，确保不存在冲突的模式。

想要快速查阅 Git？随时掌握常用命令，请查看这份 Git 速查表。

结语

.gitignore 文件虽小，却在保持 Git 仓库整洁可控方面发挥着巨大作用。通过忽略诸如依赖、构建产物以及系统生成文件等不必要内容，您可以确保项目结构清晰、远离杂乱。

在本教程中，您学习了如何创建 .gitignore 文件、添加模式并应用最佳实践以保持仓库高效。有了这些技能，您将避免版本控制方面的麻烦，也能让团队协作更加顺畅。

如果您希望进一步提升 Git 技能，请查看 Git Fundamentals 学习路径。您还可以探索实践课程，如 Foundations of Git 和 Introduction to GitHub Concepts，以系统掌握版本控制与协作工作流！