云行 AI 开发日记 - 13. .gitignore 使用指南
在使用Git进行版本控制时，.gitignore文件是一个非常重要且实用的配置文件。它的作用是告诉Git哪些文件或文件夹不需要被提交到版本库中，从而避免将一些不必要或敏感的文件上传，保持仓库的整洁和安全。本文将详细介绍.gitignore的作用、配置方法、常用语法及使用中的注意事项，帮助你高效管理Git项目。
一、什么是.gitignore文件？
.gitignore是Git项目根目录下的一个文本文件，用于定义需要被Git忽略的文件和目录。凡是写在该文件中的规则，Git在执行git add时会自动忽略这些文件，不会将它们纳入版本控制。
为什么需要.gitignore？
• 编译生成的中间文件（如Java的.class文件、C/C++的.o文件）不需要提交，因为它们可以由源代码重新生成。
• 操作系统自动生成的文件（如Windows的Thumbs.db、macOS的.DS_Store）无意义且杂乱。
• 包含敏感信息的配置文件（如密码、密钥）不宜上传。
• 大型二进制文件或临时文件会占用仓库空间，影响性能。
简单来说，.gitignore帮助我们排除不必要的文件，只将真正重要的源代码和资源提交到仓库中。
二、如何创建和配置.gitignore文件？
1. 在Git项目的根目录新建一个名为.gitignore的文件。
2. 在文件中写入你想忽略的文件名、目录或匹配规则。
3. 保存后提交.gitignore文件本身到仓库，以便团队成员共享忽略规则。
你不必从零开始写规则，GitHub官方维护了一个丰富的.gitignore模板库，涵盖各种编程语言和框架，地址：
github.com 。你可以直接复制对应语言的模板内容到你的.gitignore中使用。
三、.gitignore文件的常用语法
• 注释：以#开头的行为注释行，Git会忽略。
例如： # 忽略所有日志文件
• 忽略文件：直接写文件名或使用通配符。
例如： *.log 忽略所有.log文件
• 忽略目录：目录名后加斜杠/表示忽略整个目录。
例如：build/ 忽略build目录及其所有内容
• 通配符匹配：
• * 匹配任意多个字符
• ? 匹配单个字符
• [abc] 匹配括号内任意一个字符
• ** 匹配任意目录层级
• 否定规则：以!开头表示排除某个文件或目录，不被忽略。
例如：
*.class
!App.class
表示忽略所有.class文件，但App.class除外，仍被跟踪提交。
四、使用.gitignore避免泄露本地配置的示例
项目中经常有一些本地配置文件包含敏感信息，如数据库连接字符串、API密钥、密码等，这些文件不应上传到远程仓库。使用.gitignore可以有效避免这些敏感信息被泄露。
假设项目中有如下配置文件：
• config.ini：存储数据库用户名和密码
• .env：环境变量文件，包含私密密钥
• config.local：本地开发专用配置文件
你可以在.gitignore中添加：
# 忽略配置文件，防止敏感信息泄露
config.ini
.env
config.local
!config.local.example # 保留一个示例配置文件，方便他人参考
这样，当你执行git add .时，这些文件不会被添加到版本库，也不会推送到远程仓库。如果项目中其他人需要参考配置文件时，复制 example 文件修改就可以了。
五、使用中的注意事项
• .gitignore只对未跟踪文件生效，如果某文件已经被Git跟踪，再修改.gitignore不会自动忽略它。此时需要先用git rm --cached 文件名将其从版本库中移除，再提交，才能生效。
• 在项目开始阶段就创建并配置好.gitignore，避免后期处理已提交的无用文件带来麻烦。
掌握.gitignore的使用，是每个开发者高效使用Git的必备技能。希望本文能帮助你快速上手.gitignore，提升版本管理体验。