Git 二分除錯法,火速定位疑難Bug!

承香墨影發表於2017-12-20

Git 二分除錯法,火速定位疑難Bug!

你一定遇到過,一個很久沒修改過的功能,莫名其妙的出現了問題?肉眼查程式碼、屢邏輯完全找不到問題點?前兩天還好好的功能,怎麼這個今天就不行了?這兩天改動了這麼多程式碼,到底是那一次改動引發的 Bug?

這樣非崩潰的 Bug,有時候想要排查出問題,並不是一件容易的事情。我想,這個時候你會需要 git bisect !

一、git bisect 基礎使用

git bisect 是 Git 提供的一種 二分法 的除錯工具,它可以按照我們選定的提交,進行二分分割,快速定位出出錯的提交。來幫我們縮小最小改動的程式碼,從而快速定位問題。

git bisect 其實很簡單,主要是基於幾個基本命令:

  • git bisect start:準備進行 bisect debug。
  • git bisect good:標記一個提交為 "good"。
  • git bisect bad:標記一個提交為 “bad”。
  • git bisect reset:退出 bisect debug 的狀態。

git bisect 涉及到的命令,非常的清晰簡單,下面舉個實際的例子,結合上面的解釋,就更清晰了。

二、git bisect 工作流

我自己生造出 6 個 commit,然後使用 git log 看看我的提交記錄。

gitlog

這裡假設我正常開發的階段,到 v6 提交的時候,突然發現有個 Bug ,無法定位到問題,但是能明確的知道,在 v1 提交階段,並沒有這個 Bug。

那麼,在這樣的情況下,v6 就是一個有問題的版本,而 v1 則是一個好的版本,我們就可以藉助 git bisect 來進行二分超找定位問題來自哪個提交。

還記得剛才的命令嗎?

我們先用 git bisect start 標記開始 bisect debug ,然後使用 git bisect goodgit bisect bad 分別標記出正確的和錯誤的提交。

biscet-start

每個提交,都有一個針對這個提交唯一的 SHA-1 值,因為太長不方便輸入和閱讀,這裡可以直接使用前幾位作為簡寫。

當標記處正確的和錯誤的提交之後,git bisect 立刻就可以幫我們定位出中間提交 v3

現在 HEAD 就已經指向了 v3 提交的程式碼了,這個可以使用 git status 檢視當前的狀態。

git-status

所以我們可以基於 v3 版本的程式碼,直接執行專案,測試看該提交是否有問題。

經過測試之後,發現 v3 的提交程式碼版本,並沒有復現 Bug,那我們就可以縮小錯誤提交的範圍,大概落在了 v4v5v6 之間。

此時,我們只需要使用 git good 標記 v3 版本是正確的。

bisect-good-v3

標記好 v3good 之後,立刻又會進行一次二分,此次標記的為中間提交 v5

經過對 v5 提交的版本程式碼,進行測試之後發現,它是有問題的。我們繼續使用 git bisect bad 對它進行標記。

bisect-bad-v4

v5 有問題的時候,現在只中間一個 v4 版本,所以會立刻指向 v4 提交。

我們繼續對 v4 版本的程式碼進行測試,發現 v4 版本也有問題,繼續標記它為 bad

bisect-bad

此時就很明確了,出錯的提交就是 v4,而 Git 也直接幫我們指出來出錯的提交。

雖然這裡定位到,出錯的提交就是 v4 的問題,我們只需要仔細閱讀 v4 提交的程式碼,然後定位出問題程式碼,就達到了我們的目的。但是我們並不應該在 v4 提交上直接修改 Bug,我們應該退出 bisect debug 狀態,在最新的提交版本上進行修改,這裡使用 git bisect reset 退出,再進行修改即可。

到這裡,就是 git bisect 的完整工作流程。

三、bisect的後悔藥

對提交進行 goodbad 的標記,都是人為來進行的,難免有出錯的情況。而提交比較少的時候,大不了就是 reset 之後,重頭來過。

但是如果有幾十個提交,再從頭進行一次 bisect 就比較麻煩了。Git 考慮到這一點,已經為我們配好了後悔藥。

想要擦除之前的標記狀態,就涉及到一個命令:

  • git bisect replay:重置到某個狀態。

replay 需要制定一個回退的點,這個點是需要使用 git bisect log > log.txt 輸出的 Log 檔案, 我們需要通過修改這個 Log 檔案,來確定回退的點。

舉個例子,我們使用 log 命令,輸出一個 log.txt 檔案。

log

可以看到,這個 log.txt 檔案,記錄了我們剛才所有的操作。

在這個例子中,假如我們的操作,對 v5 進行 bad 的這個標記錯了,那麼,我們把這個操作之下的 Log 全部刪除掉,然後執行 git bisect replay log.txt

replay

這樣就將回退到判斷 v5 提交好壞的地方,重新進行標記。

在修改 Log.txt 檔案的時候,最好只執行刪除操作,不要對其中的順序有所修改,畢竟我們只是想要一個回滾的動作,並不是要改動我們之前的某些操作。

今天在承香墨影公眾號的後臺,回覆『成長』。我會送你一些我整理的學習資料,包含:Android反編譯、演算法、設計模式、虛擬機器、Linux、Kotlin、Python、爬蟲、Web專案原始碼。

推薦閱讀:

Git 二分除錯法,火速定位疑難Bug!

相關文章