.gitignore使用

Posted 2021-03-17 halfcircle

一、简绍

我们做的每个Git项目中都需要一个“.gitignore”文件，这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。比如我们项目中的npm包(node_modules)，它在我们项目中是很重要的，但是它占的内存也是很大的，所以一般我们用Git管理的时候是不需要添加npm包的。

二、常用的规则

Git忽略文件的原则

• 忽略操作系统自动生成的文件，比如缩略图等；
• 忽略编译生成的中间文件、可执行文件等，也就是如果一个文件是通过另一个文件自动生成的，那自动生成的文件就没必要放进版本库，比如Java编译产生的.class文件；
• 忽略你自己的带有敏感信息的配置文件，比如存放口令的配置文件。

.gitignore忽略规则的优先级

在 .gitingore 文件中，每一行指定一个忽略规则，Git检查忽略规则的时候有多个来源，它的优先级如下（由高到低）：
1）从命令行中读取可用的忽略规则
2）当前目录定义的规则
3）父级目录定义的规则，依次递推
4）$GIT_DIR/info/exclude 文件中定义的规则
5）core.excludesfile中定义的全局规则

.gitignore忽略规则的匹配语法

在 .gitignore 文件中，每一行的忽略规则的语法如下：
1）空格不匹配任意文件，可作为分隔符，可用反斜杠转义

2）以“＃”开头的行都会被 Git 忽略。即#开头的文件标识注释，可以使用反斜杠进行转义。

3）可以使用标准的glob模式匹配。所谓的glob模式是指shell所使用的简化了的正则表达式。

4）以斜杠"/"开头表示目录；"/"结束的模式只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件；"/"开始的模式匹配项目跟目录；如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在 .gitignore 文件中，则相对于项目根目录。

5）以星号"*****"通配多个字符，即匹配多个任意字符；使用两个星号"******" 表示匹配任意中间目录，比如a/**/z可以匹配 a/z, a/b/z 或 a/b/c/z等。

6）以问号"?"通配单个字符，即匹配一个任意字符；

7）以方括号"[]"包含单个字符的匹配列表，即匹配任何一个列在方括号中的字符。比如[abc]表示要么匹配一个a，要么匹配一个b，要么匹配一个c；如果在方括号中使用短划线分隔两个字符，表示所有在这两个字符范围内的都可以匹配。比如[0-9]表示匹配所有0到9的数字，[a-z]表示匹配任意的小写字母）。

8）以叹号"!"表示不忽略(跟踪)匹配到的文件或目录，即要忽略指定模式以外的文件或目录，可以在模式前加上惊叹号（!）取反。需要特别注意的是：如果文件的父目录已经被前面的规则排除掉了，那么对这个文件用"!"规则是不起作用的。也就是说"!"开头的模式表示否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用"!"也不会再次被包含。可以使用反斜杠进行转义。

注意：git对于.ignore配置文件是按行从上到下进行规则匹配的，意味着如果前面的规则匹配的范围更大，则后面的规则将不会生效；

创建.gitignore文件

1) 常规的windows操作

• 根目录下创建gitignore.txt；
• 编辑gitignore.txt，写下你的规则，例如加上node_modules/；
• 打开命令行窗口，切换到根目录（可以直接在文件夹上面的地址栏输入cmd回车）；
• 执行命令ren gitignore.txt .gitignore。

2) 用Git Bash

• 根目录下右键选择“Git Bash Here”进入bash命令窗口；
• 输入vim .gitignore或touch .gitignore命令，打开文件（没有文件会自动创建）；
• 按i键切换到编辑状态，输入规则，例如node_modules/，然后按Esc键退出编辑，输入:wq保存退出。

.gitignore文件的使用方法

首先，在你的工作区新建一个名称为.gitignore的文件。
然后，把要忽略的文件名填进去，Git就会自动忽略这些文件。
不需要从头写.gitignore文件，GitHub已经为我们准备了各种配置文件，只需要组合一下就可以使用了。

有时对于git项目下的某些文件，我们不需要纳入版本控制，比如日志文件或者IDE的配置文件，此时可以在项目的根目录下建立一个隐藏文件 .gitignore（linux下以.开头的文件都是隐藏文件），然后在.gitignore中写入需要忽略的文件。

[root@dalin ~]``# cat .gitignore
*.xml
*.log
*.apk

.gitignore注释用‘#‘, *表示匹配0个或多个任意字符，所以上面的模式就是要忽略所有的xml文件,log文件和apk文件。

.gitignore配置文件用于配置不需要加入版本管理的文件，配置好该文件可以为版本管理带来很大的便利。

示例说明

a、规则：fd1/
说明：忽略目录 fd1 下的全部内容；注意，不管是根目录下的 /fd1/ 目录，还是某个子目录 /child/fd1/ 目录，都会被忽略；
b、规则：/fd1/
说明：忽略根目录下的 /fd1/ 目录的全部内容；
c、规则：

 !.gitignore
 !/fw/bin/
 !/fw/sf/

说明：忽略全部内容，但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录；

快速导入.gitignore模块

对于一个文件或者一个git项目来说，一般都是一种或者是多种特定的语言，其实有一个可以简化.gitignore编写流程，或者是说提供一种忽略思路给我们，就是在githua上有相关的项目，有罗列到常见所有的语言的一些常用忽略规则。
首先提供一下github的链接：gitignore

当然并不是说，添加了这些文件就不需要在自己写，因为在不用的工程或者开发环境下都有自己特定的文件生成，可以使配置文件，可以是中间文件，这些文件往往是不需要上传到我们的版本库中，这就需要我们手动添加特定的忽略规则。

---

如果你不慎在创建.gitignore文件之前就push了项目，那么即使你在.gitignore文件中写入新的过滤规则，这些规则也不会起作用，Git仍然会对所有文件进行版本管理。简单来说出现这种问题的原因就是Git已经开始管理这些文件了，所以你无法再通过过滤规则过滤它们。所以大家一定要养成在项目开始就创建.gitignore文件的习惯，否则一单push，处理起来会非常麻烦。
。