在使用Git的过程中,经常会有一些文件,我们并不希望提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交。本篇就详细讲解下Git的忽略规则(本篇主要以.gitignore讲解为主)
Git忽略文件的原则
- 忽略操作系统自动生成的文件,比如缩略图等;
- 忽略编译生成的中间文件、可执行文件等,也就是如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库,比如Java编译产生的.class文件;
- 忽略你自己的带有敏感信息的配置文件,比如存放口令的配置文件
创建.gitignore文件
首先在你的项目或项目的某级目录下创建一个名称为.gitignore的文件
注意: .gitignore文件只对它所在目录及其子目录生效
.gitignore语法
- 空格不匹配任意文件,可作为分隔符,可用反斜杠转义
- 以“#”开头的行表示注释,如需使用"#"则可以使用反斜杠进行转义。
- 可以使用标准的glob模式匹配。所谓的glob模式是指shell所使用的简化了的正则表达式。
- 以斜杠"/"开头表示目录;"/"结束的模式只匹配文件夹以及在该文件夹路径下的内容,但是不匹配该文件;"/"开始的模式匹配项目跟目录;如果一个模式不包含斜杠,则它匹配相对于当前 .gitignore 文件路径的内容,如果该模式不在 .gitignore 文件中,则相对于项目根目录。
- 以星号"*"代表多个任意字符;使用两个星号"**" 表示匹配任意中间目录,比如`a/**/z`可以匹配 a/z, a/b/z 或 a/b/c/z等。
- 以问号"?"代表一个任意字符;
- 以方括号"[]"包含单个字符的匹配列表,即匹配任何一个列在方括号中的字符。比如[abc]表示要么匹配一个a,要么匹配一个b,要么匹配一个c;如果在方括号中使用短划线分隔两个字符,表示所有在这两个字符范围内的都可以匹配。比如[0-9]表示匹配所有0到9的数字,[a-z]表示匹配任意的小写字母)。
- 以叹号"!"表示不忽略(跟踪)匹配到的文件或目录,即要忽略指定模式以外的文件或目录,可以在模式前加上惊叹号(!)取反
.gitignore案例
# 表示此为注释
*.class 表示忽略后缀为.class的文件
!src 表示src目录不忽略
/TODO 表示仅仅忽略项目根目录下的 TODO 文件,不包括其他目录下的TODO文件
build/ 表示忽略 build/目录下的所有文件,过滤整个build文件夹
doc/*.txt 表示会忽略doc目录下的所有后缀为.txt的文件,但不忽略doc子目录中后缀为.txt的文件
bin/: 表示忽略当前路径下的bin文件夹,该文件夹下的所有内容都会被忽略,不忽略 bin 文件
/bin: 表示忽略根目录下的bin文件
/*.c: 表示忽略cat.c,不忽略 build/cat.c
debug/*.obj: 表示忽略debug/io.obj,不忽略 debug/common/io.obj和tools/debug/io.obj
**/foo: 表示忽略/foo,a/foo,a/b/foo等
a/**/b: 表示忽略a/b, a/x/b,a/x/y/b等
!/bin/run.sh 表示不忽略bin目录下的run.sh文件
*.log: 表示忽略所有 .log 文件
config.php: 表示忽略当前路径的 config.php 文件
/mtk/ 表示过滤整个文件夹
*.zip 表示过滤所有.zip文件
/mtk/do.c 表示过滤某个具体文件
被过滤掉的文件就不会出现在git仓库中(gitlab或github)了,当然本地库中还有,只是push的时候不会上传。
需要注意的是,gitignore还可以指定要将哪些文件添加到版本管理中,如下:
!*.zip
!/mtk/one.txt
唯一的区别就是规则开头多了一个感叹号,Git会将满足这类规则的文件添加到版本管理中。为什么要有两种规则呢?
想象一个场景:假如我们只需要管理/mtk/目录中的one.txt文件,这个目录中的其他文件都不需要管理,那么.gitignore规则应写为::
/mtk/*
!/mtk/one.txt
假设我们只有过滤规则,而没有添加规则,那么我们就需要把/mtk/目录下除了one.txt以外的所有文件都写出来!
注意上面的/mtk/*不能写为/mtk/,否则父目录被前面的规则排除掉了,one.txt文件虽然加了!过滤规则,也不会生效!
----------------------------------------------------------------------------------
还有一些规则如下:
fd1/*
说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
/fd1/*
说明:忽略根目录下的 /fd1/ 目录的全部内容;
/*
!.gitignore
!/fw/
/fw/*
!/fw/bin/
!/fw/sf/
说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;注意要先对bin/的父目录使用!规则,使其不被排除。
在Eclipse中如何使用
显示.gitignore文件
在Eclipse中默认是不显示.gitignore文件的,我们需要切换到"Navigator"视图才能看到.gitignore文件,切换"Navigator"视图的方法如下
在如下视图中就可以看到.gitignore文件了,如果没有说明当前项目还未忽略任何内容
忽略内容
忽略内容有俩种操作方式
方式一: 直接编辑.gitignore文件,如果文件不存在可以手动创建
方式二:界面化操作,操作步骤如下图,此操作会在没有.gitignore文件时自动创建