git gitignore

一、什么是gitignore

在使用Git进行版本控制时，我们常常会遇到一些无需纳入版本控制的文件，比如编译生成的文件、日志文件、临时文件等。如果不将这些文件排除在版本控制之外，会导致仓库变得臃肿，并可能引发一些不必要的问题。而.gitignore文件就是用来指定不需要纳入版本控制的文件列表的。

.gitignore文件是一个文本文件，用于列出要忽略的文件、文件夹和文件类型的规则。当Git在进行版本控制时，会根据.gitignore文件的规则自动忽略这些文件。这样，我们就可以将注意力集中在真正需要版本控制的文件上，提高开发效率。

二、.gitignore文件的语法规则

.gitignore文件的语法比较简单，主要包括以下几个方面：

1. 文件匹配模式

.gitignore文件中的每一行都是一个模式，用于指定要忽略的文件或文件夹。对于文件夹，可以使用通配符/来匹配路径。

例如，要忽略所有的.exe文件，可以在.gitignore中添加一行*.exe。

*.exe

2. 注释

.gitignore文件中可以使用#来添加注释。#后面的内容会被忽略。

# 忽略所有的日志文件
*.log

3. 感叹号!的使用

在.gitignore文件中，我们可以使用感叹号!来指定某些例外。即使前面的规则匹配了某个文件，但如果在后面使用!指定了该文件，那么这个文件将不会被忽略。

# 忽略所有的txt文件，但例外某个特定的txt文件
*.txt
!important.txt

4. 通配符

.gitignore文件中可以使用通配符来匹配文件名或路径。以下是常用的通配符：

• *：匹配0个或多个字符
• ?：匹配任意一个字符
• [abc]：匹配括号中的任意一个字符
• [^abc]：匹配除括号中的字符之外的任意一个字符
• [0-9]：匹配从0到9之间的任意一个数字
• **：递归匹配子目录

# 匹配所有的tmp文件夹下的txt文件
tmp/**/*.txt

三、如何创建.gitignore文件

创建.gitignore文件有以下几种方式：

1. 使用命令行

可以使用命令行工具（如Git Bash）在项目根目录下创建.gitignore文件，并编辑文件内容。

touch .gitignore
code .gitignore   # 使用VS Code编辑器打开文件

2. 使用文本编辑器

在项目根目录下使用文本编辑器创建一个名为.gitignore的文件，并编辑文件内容。

3. 使用Git官方提供的模板

Git官方提供了一些常用的.gitignore模板，可以直接复制使用。

可以访问https://github.com/github/gitignore获取这些模板。找到对应的模板文件，复制文件内容，粘贴到.gitignore文件中即可。

四、示例

下面给出一些常见的.gitignore规则示例：

1. 忽略某个文件

如果要忽略某个具体的文件，只需要在.gitignore文件中添加相应的规则即可。

# 忽略根目录下的config.ini文件
config.ini

2. 忽略某类文件

如果要忽略某类文件，可以使用通配符来进行匹配。

# 忽略所有的txt文件
*.txt

3. 忽略文件夹

如果要忽略某个文件夹及其所有内容，可以在.gitignore中添加指定的文件夹路径。

# 忽略dist文件夹及其所有内容
dist/

4. 忽略指定文件夹下的特定文件类型

有时候，我们希望忽略某个文件夹下的特定文件类型，但该文件夹下的其他文件类型需要被版本控制。

# 忽略dist文件夹下的所有txt文件
dist/*.txt

5. 忽略嵌套文件夹下的特定文件类型

有时候，我们希望忽略嵌套文件夹中的特定文件类型。

# 忽略src中的所有test文件夹下的txt文件
src/**/test/*.txt

6. 忽略特定文件夹的特定文件类型

有时候，我们希望忽略特定文件夹中的特定文件类型。

# 忽略assets文件夹和static文件夹下的所有png图片
/{assets,static}/*.png

五、.gitignore的注意事项

在使用.gitignore时，需要注意以下几点：

1. .gitignore需要提交到版本库中

.gitignore文件本身需要被提交到版本库中，以便团队中其他人员可以共享忽略规则。因此，在创建或修改.gitignore文件后，需要使用git add命令将其添加到暂存区，并通过git commit命令提交。

2. 忽略规则只对未被版本控制的文件生效

.gitignore的忽略规则只对尚未被版本控制的文件生效。如果一个文件已经被添加到版本库中，再将其添加到.gitignore中是无效的。在这种情况下，需要使用git rm --cached命令将文件从版本库中删除。

git rm --cached file.txt

3. .gitignore规则仅作用于当前仓库

.gitignore文件中的忽略规则只作用于当前仓库，不会影响到其他仓库。可以在不同项目的.gitignore文件中添加不同的规则。

4. 查看忽略的文件

使用git status --ignored命令可以查看当前被忽略的文件。

git status --ignored

六、总结

.gitignore是一个非常强大且实用的工具，可以帮助我们排除无需纳入版本控制的文件，提高版本控制的效率和可读性。通过学习.gitignore文件的语法规则和使用方法，我们可以轻松地创建和管理.gitignore文件，确保版本库中只包含必要的文件。

在创建.gitignore文件时，我们可以使用命令行工具或文本编辑器进行操作。可以手动添加忽略规则，也可以使用Git官方提供的模板进行参考和复制。.gitignore文件中的规则可以通过文件匹配模式、注释、感叹号以及通配符等进行定义。我们可以根据需求来使用这些规则，以达到精确指定要忽略的文件、文件夹或文件类型的目的。

需要注意的是，.gitignore文件需要被提交到版本库中，以便团队中的其他成员可以共享并生效。同时，.gitignore的忽略规则只会对尚未被版本控制的文件生效，对已经添加到版本库中的文件无效。如果需要忽略已被版本控制的文件，可以使用git rm --cached命令将其从版本库中删除。

此外，.gitignore文件中的忽略规则仅对当前仓库生效，不会影响到其他仓库。在不同的项目中，可以根据需要添加不同的.gitignore文件和规则。使用git status --ignored命令可以查看当前被忽略的文件。

综上所述，.gitignore是Git中一个必不可少的文件，通过合理使用.gitignore文件，我们可以将注意力集中在需要版本控制的文件上，提高开发效率。掌握.gitignore的基本语法规则和注意事项，对于使用Git进行版本控制的项目是非常重要的。