Git忽略文件.gitignore的使用

2022 年 2 月 13 日
筆記
git, study

本部落格旨在自我學習使用，如有任何疑問請及時聯繫部落客

1.WHY?

當你使用git add .的時候有沒有遇到把你不想提交的文件也添加到了快取中去？比如項目的本地配置資訊，如果你上傳到Git中去其他人pull下來的時候就會和他本地的配置有衝突，所以這樣的個性化配置文件我們一般不把它推送到git伺服器中，但是又為了偷懶每次添加快取的時候都想用git add .而不是手動一個一個文件添加，該怎麼辦呢？很簡單，git為我們提供了一個.gitignore文件只要在這個文件中申明那些文件你不希望添加到git中去，這樣當你使用git add .的時候這些文件就會被自動忽略掉。

2.忽略文件的原則

忽略作業系統自動生成的文件，比如縮略圖等；
忽略編譯生成的中間文件、可執行文件等，也就是如果一個文件是通過另一個文件自動生成的，那自動生成的文件就沒必要放進版本庫，比如Java編譯產生的.class文件；
忽略你自己的帶有敏感資訊的配置文件，比如存放口令的配置文件。

3.使用方法

首先，在你的工作區新建一個名稱為.gitignore的文件。然後，把要忽略的文件名填進去，Git就會自動忽略這些文件。不需要從頭寫.gitignore文件，GitHub已經為我們準備了各種配置文件，只需要組合一下就可以使用了。所有配置文件可以直接在線瀏覽：//github.com/github/gitignore

4.栗子

比如你的項目是java項目，.java文件編譯後會生成.class文件，這些文件多數情況下是不想被傳到倉庫中的文件。這時候你可以直接適用github的.gitignore文件模板。//github.com/github/gitignore/blob/master/Java.gitignore 將這些忽略文件資訊複製到你的.gitignore文件中去：

*.class

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.ear

# virtual machine crash logs, see [//www.java.com/en/download/help/error_hotspot.xml](//www.java.com/en/download/help/error_hotspot.xml)
hs_err_pid*

可以看到github為我們提供了最流行的.gitignore文件配置。
保存.ignore文件後我們查看下git status，檢查下是否還有我們不需要的文件會被添加到git中去：

$ git status
On branch master

Initial commit

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
    new file:   .gitignore
    new file:   HelloWorld.java

Untracked files:
  (use "git add <file>..." to include in what will be committed)
    Config.ini

比如我的項目目錄下有一個Config.ini文件，這個是個本地配置文件我不希望上傳到git中去，我們可以在gitignore文件中添加這樣的配置：

Config.ini

或者你想忽略所有的.ini文件你可以這樣寫：

*.ini

如果有些文件已經被你忽略了，當你使用git add時是無法添加的，比如我忽略了*.class，現在我想把HelloWorld.class添加到git中去：

$ git add HelloWorld.class
The following paths are ignored by one of your .gitignore files:
HelloWorld.class
Use -f if you really want to add them.

git會提示我們這個文件已經被我們忽略了，需要加上-f參數才能強制添加到git中去：

$ git status
On branch master

Initial commit

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)

    new file:   .gitignore
    new file:   HelloWorld.class
    new file:   HelloWorld.java

這樣就能強制添加到快取中去了。如果我們意外的將想要忽略的文件添加到快取中去了，我們可以使用rm命令將其從中移除：

$ git rm HelloWorld.class --cached
rm 'HelloWorld.class'

如果你已經把不想上傳的文件上傳到了git倉庫，那麼你必須先從遠程倉庫刪了它，我們可以從遠程倉庫直接刪除然後pull程式碼到本地倉庫這些文件就會本刪除，或者從本地刪除這些文件並且在.gitignore文件中添加這些你想忽略的文件，然後再push到遠程倉庫。

5.查看gitignore規則

如果你發下.gitignore寫得有問題，需要找出來到底哪個規則寫錯了，可以用git check-ignore命令檢查：

$ git check-ignore -v HelloWorld.class
.gitignore:1:*.class    HelloWorld.class

可以看到HelloWorld.class匹配到了我們的第一條*.class的忽略規則所以文件被忽略了。

6.忽略規則文件語法

a.忽略指定文件/目錄

# 忽略指定文件
HelloWrold.class

# 忽略指定文件夾
bin/
bin/gen/

b.通配符忽略規則

通配符規則如下：

# 忽略.class的所有文件
*.class

# 忽略名稱中末尾為ignore的文件夾
*ignore/

# 忽略名稱中間包含ignore的文件夾
*ignore*/

原貼：wolai

Tags: git study