Git忽略規則.gitignore梳理

對於經常使用Git的朋友來說,.gitignore配置一定不會陌生。廢話不說多了,接下來就來說說這個.gitignore的使用。

首先要強調一點,這個文件的完整文件名就是".gitignore",注意最前面有個“.”。
一般來說每個Git項目中都需要一個“.gitignore”文件,這個文件的作用就是告訴Git哪些文件不需要添加到版本管理中。實際項目中,很多文件都是不需要版本管理的,比如Python的.pyc文件和一些包含密碼的配置文件等等。這個文件的內容是一些規則,Git會根據這些規則來判斷是否將文件添加到版本控制中。

下面我們看看常用的規則:
1)/mtk/ 過濾整個文件夾
2)*.zip 過濾所有.zip文件
3)/mtk/do.c 過濾某個具體文件

很簡單吧,被過濾掉的文件就不會出現在git倉庫中(gitlab或github)了,當然本地庫中還有,只是push的時候不會上傳。
需要注意的是,gitignore還可以指定要將哪些文件添加到版本管理中:
1)!*.zip
2)!/mtk/one.txt

唯一的區別就是規則開頭多了一個感嘆號,Git會將滿足這類規則的文件添加到版本管理中。
爲什麼要有兩種規則呢?想象一個場景:假如我們只需要管理/mtk/目錄中的one.txt文件,這個目錄中的其他文件都不需要管理,那麼我們就需要使用:
1)/mtk/
2)!/mtk/one.txt
假設我們只有過濾規則,而沒有添加規則,那麼我們就需要把/mtk/目錄下除了one.txt以外的所有文件都寫出來!

最後需要強調的一點是,如果你不慎在創建.gitignore文件之前就push了項目,那麼即使你在.gitignore文件中寫入新的過濾規則,這些規則也不會起作用,Git仍然會對所有文件進行版本管理。
簡單來說,出現這種問題的原因就是Git已經開始管理這些文件了,所以你無法再通過過濾規則過濾它們。因此一定要養成在項目開始就創建.gitignore文件的習慣,否則一旦push,處理起來會非常麻煩。

.gitignore配置文件用於配置不需要加入版本管理的文件,配置好該文件可以爲版本管理帶來很大的便利,以下是對於配置.gitignore的一些心得記錄:
1)配置語法:
以斜槓“/”開頭表示目錄;
以星號“*”通配多個字符;
以問號“?”通配單個字符
以方括號“[]”包含單個字符的匹配列表;
以歎號“!”表示不忽略(跟蹤)匹配到的文件或目錄;

此外,git 對於 .ignore 配置文件是按行從上到下進行規則匹配的,意味着如果前面的規則匹配的範圍更大,則後面的規則將不會生效;

2)示例說明
a)規則:fd1/
說明:忽略目錄 fd1 下的全部內容;注意,不管是根目錄下的 /fd1/ 目錄,還是某個子目錄 /child/fd1/ 目錄,都會被忽略;
b)規則:/fd1/

說明:忽略根目錄下的 /fd1/ 目錄的全部內容;
c)規則:
/*
!.gitignore
!/fw/bin/
!/fw/sf/
說明:忽略全部內容,但是不忽略 .gitignore 文件、根目錄下的 /fw/bin/ 和 /fw/sf/ 目錄;

其實,需要清除的一點是:
有三種方法可以實現過濾掉Git裏不想上傳的文件,這三種方法都能達到目的,只不過適用情景不一樣。

1)第一種方法
針對單一工程排除文件,這種方式會讓這個工程的所有修改者在克隆代碼的同時,也能克隆到過濾規則,而不用自己再寫一份,這就能保證所有修改者應用的都是同一份規則,而不是張三自己有一套過濾規則,李四又使用另一套過濾規則,個人比較喜歡這個。配置步驟如下:

在工程根目錄下建立.gitignore文件,將要排除的文件或目錄 寫到.gitignore這個文件中,其中有兩種寫入方法。
a)使用命令行增加排除文件
排除以.class結尾的文件 echo “*.class” >.gitignore (>> 是在文件尾增加,> 是刪除已經存在的內容再增加),之後會在當前目錄下生成一個.gitignore的文件。
排除bin目錄下的文件 echo “bin/” >.gitignore
b)最方便的辦法是,用記事本打開,增加需要排除的文件或目錄,一行增加一個,例如:

.class
.apk
bin/
gen/
.settings/
proguard/

2)第二種方法
全局設置排除文件,這會在全局起作用,只要是Git管理的工程,在提交時都會自動排除不在控制範圍內的文件或目錄。這種方法對開發者來說,比較省事,只要一次全局配置,不用每次建立工程都要配置一遍過濾規則。但是這不保證其他的開發者在克隆你的代碼後,他們那邊的規則跟你的是一樣的,這就帶來了代碼提交過程中的各種衝突問題。
配置步驟如下:
a)像方法(1)一樣,也需要建立一個.gitignore文件,把要排除的文件寫進去。
b)但在這裏,我們不規定一定要把.gitnore文件放到某個工程下面,而是任何地方,比如我們這裏放到了Git默認的Home路徑下,比如:/home/wangshibo/hqsb_ios
c)使用命令方式可以配置全局排除文件 git config --global core.excludesfile ~/.gitignore,你會發現在~/.gitconfig文件中會出現excludesfile = /home/wangshibo/hqsb_ios/.gitignore。
說明Git把文件過濾規則應用到了Global的規則中。

3)第三種方法
單個工程設置排除文件,在工程目錄下找到.git/info/exclude,把要排除的文件寫進去:

.class
.apk
bin/
gen/
.settings/
proguard/

這種方法就不提倡了,只能針對單一工程配置,而且還不能將過濾規則同步到其他開發者,跟方法(1)(2)比較起來沒有一點優勢。

------------------------Git忽略規則及.gitignore規則不生效的解決辦法-----------------------------
在git中如果想忽略掉某個文件,不讓這個文件提交到版本庫中,可以使用修改根目錄中 .gitignore 文件的方法(如無,則需自己手工建立此文件)。這個文件每一行保存了一個匹配的規則例如:

此爲註釋 – 將被 Git 忽略

.a # 忽略所有 .a 結尾的文件
!lib.a # 但 lib.a 除外
/TODO # 僅僅忽略項目根目錄下的 TODO 文件,不包括 subdir/TODO
build/ # 忽略 build/ 目錄下的所有文件
doc/
.txt # 會忽略 doc/notes.txt 但不包括 doc/server/arch.txt
規則很簡單,不做過多解釋,但是有時候在項目開發過程中,突然心血來潮想把某些目錄或文件加入忽略規則,按照上述方法定義後發現並未生效,原因是.gitignore只能忽略那些原來沒有被track的文件,如果某些文件已經被納入了版本管理中,則修改.gitignore是無效的。那麼解決方法就是先把本地緩存刪除(改變成未track狀態),然後再提交:

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

注意:
不要誤解了 .gitignore 文件的用途,該文件只能作用於 Untracked Files,也就是那些從來沒有被 Git 記錄過的文件(自添加以後,從未 add 及 commit 過的文件)。
如果文件曾經被 Git 記錄過,那麼.gitignore 就對它們完全無效。
當你發現自己的才華撐不起野心時,就請安靜下來學習吧

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章