Git忽略文件.gitignore

咱们搞开发的时候,都懂一个道理:不是项目里的每一个文件都得扔进版本库。比如编译生成的“target”目录,或者各种临时文件、日志,要是都提交上去,那仓库可就臃肿得没法看了。这事儿怎么解决呢?很简单,在Git工作区的根目录下,创建一个名叫“.gitignore”的特殊文件。把那些你想让Git“视而不见”的文件或目录名称填进去,Git在后续操作中就会自动忽略它们。

gitignore的基础用法

# .gitignore配置文件的一些通用技巧 [参考:https://git-scm.com/docs/gitignore]

# 1.空白行不匹配任何文件,所以可以作为可读性的分隔符,同时两端的空格将会被忽略。

# 2.使用[#]开头,将会注释掉整行,使其不进行匹配操作。如果需要匹配#开头,可以使用转义字符[\]。

# 3.1匹配模式以[/]结尾,表示想要匹配一个目录及其子文件。(比如[foo/]会匹配foo目录及其下面的路径。)

# 3.2匹配模式不包含[/],将会全局匹配该文件。

# 4.通配符

# [*]: 匹配除[/]以外的任何内容,也就意味着[*]不能跨目录。

# [?]: 匹配除[/]和[[]以及[]]以外的任何一个字符。

# [**]:匹配所有的内容,或者说匹配任意目录下的内容。

# 示例:

# 1.[**/foo/bar] 将会匹配所有直接在foo目录下的bar,无论foo处在何处。

# 2.[foo/**]则表示匹配foo目录下的所有文件和目录。

# 3.[a/**/b]则可以匹配a/b, a/c/b, a/c/d/b,即此处的[**]可以表示0个或多个。

# !!! 需要注意的是,除上面示例的用法外,剩余的[**]都是无效的。

# 5.可以通过前缀[!]来表示不忽略某些文件。比如可以通过[!a]来确保文件a不会被忽略,即使前面已经声明了忽略其父目录。该模式优先级高于普通忽略模式。

Git 三种方法忽略提交的文件

在Git项目中定义 .gitignore 文件

这是最主流、最推荐的方式。操作起来也很直观:在项目的某个目录(通常是根目录)下创建一个“.gitignore”文件,然后在里面写上你的忽略规则。这样一来,这个目录下的文件提交行为就都由这个文件来管理了。

关键是,这个“.gitignore”文件本身是可以提交到仓库里的。这就意味着,项目组里的所有小伙伴都能共享同一套精心定义好的“清洁”规则,从源头上保持仓库的整洁。

文件里的语法是每行一条规则。来看几个简单的例子:

*.log
*.temp
/vendor/

在Git项目的设置中指定排除文件

有时候,你可能有些个人偏好或临时产生的文件不想提交,但又不想把这些规则共享给整个团队。这时候,可以试试这个方法。

操作路径是:编辑你本地项目下的“.git/info/exclude”文件,把要忽略的文件路径加进去。需要注意,这里写的路径,其根目录就是项目的根目录。

这个方法的好处是,规则只对你自己的本地仓库生效,不会影响其他协作者。算是一种“私人订制”的忽略列表。

定义Git全局的 .gitignore 文件

如果你发现自己经常在不同的项目里重复添加某些忽略规则(比如你自己常用的编辑器临时文件),那么设置一个全局忽略文件会方便很多。

这属于Git应用级别的配置,跟具体项目无关。你需要先在一个固定的位置(比如用户主目录)创建一个“.gitignore”文件,然后把那些通用的规则放进去。最后,用下面这条命令告诉Git它的位置:

git config --global core.excludesfile ~/.gitignore

配置好之后,你所有的Git项目都会自动应用这些全局忽略规则,省去了在每个项目里重复配置的麻烦。

.gitignore文件中的忽略规则

规则看似简单,但细节不少,理解透了才能用得精准:

空格本身不匹配任何文件,通常用作格式上的分隔符以提高可读性。如果需要匹配空格,得用反斜杠转义。

# 开头:这一行会被当作注释,Git直接跳过。当然,真要匹配以#开头的文件,也得靠反斜杠转义。

! 开头:表示“否定”或“例外”。意思是,即使前面有规则忽略了这类文件,加了“!”的这条规则也能把它重新包含进来。不过要注意,如果它的父目录被忽略了,光用“!”可能也救不回来。

/ 结尾:这只匹配目录。写上“doc/”,就意味着忽略名为“doc”的文件夹及其里面的所有东西,但不会忽略一个叫“doc”的普通文件。

/ 开头:匹配规则会从项目根目录开始生效。比如“/README.md”就只忽略根目录下的README.md文件。

不包含斜杠的模式:它会相对于当前.gitignore文件所在的目录进行匹配。如果这个模式是写在项目根目录的.gitignore里,那就相当于相对于项目根目录。

使用 **:这是“超级通配符”,可以匹配任意层级的目录。可以用在模式的开头、中间或结尾,非常灵活。比如“**/tmp”就能匹配任何位置的“tmp”文件或目录。

使用 ?:通用匹配任意单个字符。

使用 []:匹配方括号内列出的任意单个字符。

常用匹配示例:

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 文件

ja va忽略文件

# 编译后的class文件,忽略所有以[.class]结尾的文件
*.class

# 日志文件,忽略所有以[.log]结尾的文件
.*.log

# BlueJ 文件,忽略所有以[.ctxt]结尾的文件
*.ctxt

# Mobile Tools for Ja va (J2ME),忽略[.mtj.tmp/]目录及其子文件
.mtj.tmp/

# 打包文件,忽略所有以[.jar]或[.war]或[.nar]或[.ear]或[.zip]或[.tar.gz]或[rar]结尾的文件
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

IDE环境忽略文件

.idea/
*.idea/compiler.xml
.idea/encodings.xml
.idea/modules.xml
*.iml

ma ven忽略文件

target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
# 避免忽略 Ma ven wrapper jar 文件(通常.jar文件是被忽略的)
!/.mvn/wrapper/ma ven-wrapper.jar

other环境忽略文件

*.sw?
.#*
*~
.classpath
.project
.settings/
bin
build
target
dependency-reduced-pom.xml
*.sublime-*
/scratch
.gradle
Guardfile
README.html
*.iml
.idea

.gitignore规则不生效

这是很多开发者都会踩的一个坑:为什么我明明加了规则,Git还在跟踪那个文件?

问题的关键在于,.gitignore只对尚未被Git跟踪(untracked)的文件起作用。如果某个文件已经被提交过(即已纳入版本管理),那么你再修改.gitignore来忽略它,是无效的。Git已经“认识”它了。

解决办法其实也不难,核心思路是:让这个文件先从Git的跟踪列表里“脱钩”。具体操作分三步走:

git rm -r --cached .
git add .
git commit -m 'update .gitignore'

简单解释一下:第一条命令“git rm -r --cached .”会删除所有已跟踪文件在暂存区(索引)中的记录,但保留工作区的实际文件。然后再重新“git add .”,这时.gitignore规则就会生效,那些被忽略的文件就不会再被添加进去了。最后提交更改即可。

需要警惕的是,这个操作会影响所有文件,如果是团队协作的项目,最好提前沟通。对于单个文件的处理,可以把“.”换成具体的文件路径。

本文转载于:https://www.jb51.net/program/336202ngh.htm 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。