7 個建議讓 Code Review 高效又高質

2021-10-07 08:50:11 字數 4273 閱讀 7805

關於**評審(code review)的文章也算是汗牛充棟了,**評審也已經是許多組織的標準化實踐。不過,許多團隊在嘗試**評審實踐時,卻有如下疑問:

「政治正確」 的**評審活動究竟有沒有達到期望的實際效果?

給了我一大堆**,到底該從**看起?哪些方面是我該評審的?哪些不是?

別人有沒有認真評審我的**?如何讓別人更容易的評審**?

這些都不是什麼新問題,但是它們是如此的普遍,而且經年累月地在不同的上下文中被提起,不外乎兩個方面:

理解**評審的核心目標,建立關於**評審的正確預期。

了解**評審為什麼可能無效,並採取有針對性的實踐來提公升**評審的效果。

為什麼要做**評審

不少同學認為**評審就是用來查錯的,甚至希望用**的缺陷數量來檢驗**評審的效果。這低估了**評審的價值。**評審最本質的作用不是問題發現。除了**評審,我們有更多更好的手段來發現問題。**評審的作用更多是關於社會學的,是一種長期行為和組織文化。

cr 是**規範性的保證

編碼者視角:良性的社交壓力

你正在緊張地編碼,交付時間迫在眉睫。你的組織對**的單元測試有乙個要求:凡是新增的**,必須有完整的自動化單元測試。但是,在壓力之下,你想給自己降低一點要求,不寫這部分的單元測試了,以後再編寫吧,或者為了應付工具的覆蓋率要求,先寫一點不那麼有用但是卻能帶來覆蓋率的測試(例如沒有斷言的測試)。

但是,一旦想到你的**將會發出去給你的同事做 review,有沒有為剛才的這種想法產生一絲絲壓力?這種壓力是良性的,它能給你帶來一種即時的反饋,阻止你去選擇那些短期收益、長期損失的 「投機」 行為。如果沒有**評審這個環節,或許你就會真的 「為所欲為」 了,其實最終還是要為這種取巧行為買單。

維護者視角:**可讀性的保證

有許多方式能實現同乙個軟體需求。有興趣的讀者可自行搜尋 「hello world 的 n 種寫法」。儘管條條大路通羅馬,但是,不同的道路代價是不一樣的。小到變數命名,大到設計結構,如果你採用的是一種不那麼常見的做法,往往就是給後來的**維護者挖坑。這種維護活動可能發生在 1 個月以後,也可能發生在 1 年以後,甚至是更久之後。甚至那時候,作為作者的你,已經不在這個團隊了,已經沒有人能理解當時的軟體為什麼這樣設計。

**評審強制提前了這個反饋週期,**編寫完成之後,就立即有了一位或多位讀者——他們是這個**的 reviewer。所以,這段**在編碼完成之後,立即經歷了可讀性的檢驗。更理想地,如果組織已經有了編碼規範和設計規範,還能確保這段**遵循了這些規範。如果 cr 過程中發現這段**沒有遵循規範,那更是好事,它指向了 cr 的另外乙個關鍵價值:知識傳播。

cr 帶來了知識傳播和設計共識

你可能是乙個團隊的 leader,正在為如何提公升團隊成員的程式設計能力發愁。你希望他們去讀書,所以你介紹了諸如《整潔**》之類的入門書籍,你還介紹了經典名著《設計模式》,還推薦了《領域驅動設計》。你也希望團隊成員能理解產品的業務邏輯,所以希望團隊成員周期性地進行業務分享。

所有這些努力都很好。但是,也有可能你會被打擊。乙個月過去了,似乎團隊成員對命名規範都建立了概念,但是在怎麼命名這件事上,大家並未形成共識。不少同學已經了解了一些設計模式,但是有人過度運用模式,搞得**臃腫不堪,有人則只知道singleton。團隊成員為什麼是實體物件,什麼是值物件爭的不可開交,沒有人說得清楚聚合是什麼,應該在什麼場景下使用。

你真正缺乏的,是乙個場景。抽象的概念如果不落到具體的事情上,就很難形成共識。有人或許知道海洋法系的 「判例」,這是在法律層面形成共識的一種非常好的方法。**評審,其實也是在形成判例:哪一類設計是合理的,哪一類設計是不合理的。通過針對具體的問題進行分析,團隊就會逐漸形成設計共識,在過程中,對這些共識不那麼熟悉的新同學,也可以慢慢融入。

檢驗邏輯正確性

當然,cr 也能用來檢驗邏輯正確性。

保證**邏輯正確,是設計者的責任

為了不讓 cr 被濫用並被寄予過高期望,我們在此首先申明一點:保證**的邏輯正確,是設計者的責任。出現了乙個空指標錯誤,究竟是編碼做的不好,是 cr 做的不好,還是測試做的不好?首先肯定是**作者製造了這個問題。把這個板子打在 reviewer 身上公平嗎?或許,reviewer 確實有責任發現這樣的問題,但是,如果**本來就錯誤多多呢?如果一次性 review 了 1000 行**,根本看不過來呢?我能找到一大把的理由,來說明為什麼漏掉這麼乙個空指標錯誤。

發現邏輯錯誤的其他方法

你還有許多其他的方法來發現錯誤,它們的成本往往並不高,例如:

編寫自動化單元測試

使用**靜態檢查工具

無論是否存在 cr 活動,上述兩點都是一名專業的開發者和開發組織應該大力倡導的行為。

發現錯誤的價值

在上述兩點得到承認的前提下,**評審確實也應該用於發現錯誤——它本質上建立了一種冗餘機制,通過多人工作在同一段**上,發現**中可能發生的認知錯誤(這對於單個開發者往往是很難發現的)以及疏忽。

高效高質的**評審

哪些因素阻礙了**評審的效果

**評審本身並不困難,但是,如果考慮到如下因素,可能就比較複雜了:

你可能對要評審的**的設計上下文一無所知

你可能非常忙碌

你一下子收到了幾千行需要被評審的**

實際操作建議

建議一:小批量——每次 review 的**量要少

研究發現, 成功的 cr 活動一定是小規模的。例如,《modern code review:a case at google》**介紹說, google 的 cr 活動中,有 35% 的 cr 僅僅修改了乙個檔案,90% 的 cr 修改的檔案數在 10 個檔案以內,甚至有 10% 的 cr 僅僅修改了1行**。

**量少的好處顯而易見:修改了**非常清晰,問題也會一目了然。一次推給別人 1000+ 行**,還想得到有價值的 review,可能性微乎其微。

當然,一次 review 它代表的功能應該是有意義的,是完整的,如果不是修復缺陷,這一定程度上也對開發者迭代地開發功能的能力提出了要求。

建議二:多批次——review 要頻繁發生

小批量必然導致了多批次。在微軟 2013 年的一篇**《iexpectations, outcomes, and challenges of modern code review》和前述的 google 的**中都提到了頻繁 review 的做法。其中,google 的每週每 developer 的**變更中位數是 3 個,每週每 reviewer 的 review 中位數是 4 個。

建議三:找對人——合適的 reviewer

誰適合 review 你的**?選乙個和被 review 的**毫不相干的人肯定是不明智的。下面列出了一些潛在的候選人:

如果你的組織有 owner 機制,owner 應該是合適人選

和你工作在相同上下文的同事

近期修改過相同**的同事

比你更資深的程式設計師,希望得到他們的專業反饋

現在已經有一些工具,能夠根據上下文推薦 reviewer,這也為選擇合適的 reviewer 提供了便利。

建議四:快速響應

當每次 review 的粒度不大,review 又比較頻繁時,快速響應才能成為可能,也是必然的要求。在這個資料上,google 的中位數是 4 小時。這個指標可以成為乙個較好的參照。

建議五:使用現代工具

快速響應、高質量的 review 離不開現代工具。現代的 review 工具能自動整合進工作流,高亮變化,甚至能自動彙總變更。這方面已經有許多現代的工具可以使用,還沒有選好工具的讀者,可以自行搜尋。

建議六:考慮結對程式設計

當我們提到 「小批量、多批次、快速反饋」 的時候,如果有過結對程式設計經驗的同學,馬上就會反映過來,結對程式設計和 cr 何其相似。

結對程式設計,共同程式設計的兩位同學擁有完全相同的上下文,不存在上下文切換的煩惱,沒有缺乏時間的煩惱,不需要借助額外的工具,反饋隨時隨地。事實上,在我的眼中,結對程式設計才是最好的 code review。

數位化的指標

研發行為的全面數位化,帶來了一些有價值的資料洞察。如果工具支援,可以通過一些指標的觀測,持續推進 cr 活動。我們把一些建議的指標和資料總結如下:

從 author 角度:

單次評審的**行數 (主要指標)

評審的頻度 (參考)

從 reviewer 角度:

響應時間

從 reviewer 的團體角度,還可以發現 author-reviewer 之間的社群關係,也是一種有價值地了解知識傳播的資訊。

不要做什麼:

避免用 cr 的數位化指標進行考核,即使動機良好。cr 的本質是文化建設,強烈建議僅僅把 cr 的指標用作提公升指引,而不要用於和績效有關的評價,無論是前述的幾種指標,還是和 review 的質量甚至是缺陷相關的資料。

實踐你的組織的**質量和技術氛圍如何?你們正在實施**評審嗎?

如果暫時還沒有,是否願意做一些嘗試?

如果已經在實施,既有的實踐是否達到了**評審的真正目標?

7 個建議讓 Code Review 高效又高質

關於 評審 code review 的文章也算是汗牛充棟了,評審也已經是許多組織的標準化實踐。不過,許多團隊在嘗試 評審實踐時,卻有如下疑問 這些都不是什麼新問題,但是它們是如此的普遍,而且經年累月地在不同的上下文中被提起,不外乎兩個方面 為什麼要做 評審 不少同學認為 評審就是用來查錯的,甚至希望...

提高程式設計的7個建議

程式設計是非常酷的一件事情,但是在酷炫的背後它對很多人來說還是挺難的。很多人在學習程式設計之初就被困難擊敗了。當你不熟悉程式設計的時候,你可能會覺得無從下手,並且不知道如何運用學到的知識。只要你通過了這一困難的學習階段,你就會發現乙個全新的世界。以下是一些能夠幫助你快速提高程式設計技巧的建議。1.多...

讓資料庫變快的10個建議

大多數 的內容都存在資料庫裡,使用者通過請求來訪問內容。資料庫非常的快,有許多技巧能讓你優化資料庫的速度,使你不浪費伺服器的資源。在這篇文章中,我收錄了十個優化資料庫速度的技巧。1 小心設計資料庫 第乙個技巧也許看來理所當然,但事實上大部分資料庫的問題都來自於設計不好的資料庫結構。譬如我曾經遇見過將...