Git忽略規則.gitignore梳理此為注釋 – 将被 Git 忽略

對于經常使用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/

假設我們隻有過濾規則，而沒有添加規則，那麼我們就需要把/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，把要排除的檔案寫進去：

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

------------------------Git忽略規則及.gitignore規則不生效的解決辦法-----------------------------

在git中如果想忽略掉某個檔案，不讓這個檔案送出到版本庫中，可以使用修改根目錄中 .gitignore 檔案的方法（如無，則需自己手工建立此檔案）。這個檔案每一行儲存了一個比對的規則例如：

.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 就對它們完全無效。

<b>本文轉自 AltBoy 51CTO部落格，原文連結:http://blog.51cto.com/altboy/2044696</b>