1. 從“open-code-review”這個(gè)標(biāo)題說(shuō)起它到底想解決什么問(wèn)題第一次看到“open-code-review”這個(gè)標(biāo)題我腦子里蹦出來(lái)的第一個(gè)念頭是這大概率不是一個(gè)單純的代碼審查工具而是一套把“審查”這件事從封閉走向開(kāi)放的機(jī)制設(shè)計(jì)。為什么這么說(shuō)因?yàn)椤皁pen”這個(gè)詞放在“code review”前面本身就帶著兩層含義——一層是審查過(guò)程對(duì)團(tuán)隊(duì)內(nèi)部透明另一層是審查能力對(duì)外部生態(tài)開(kāi)放。這兩層含義疊加起來(lái)指向的其實(shí)是一個(gè)很現(xiàn)實(shí)的問(wèn)題大多數(shù)團(tuán)隊(duì)的代碼審查做得并不好。我待過(guò)幾個(gè)不同類(lèi)型的研發(fā)團(tuán)隊(duì)從十幾人的小作坊到上百人的中臺(tái)部門(mén)代碼審查這件事的落地質(zhì)量差異極大。小團(tuán)隊(duì)往往是“誰(shuí)有空誰(shuí)看一眼”大團(tuán)隊(duì)則容易陷入“流程走完了但沒(méi)人真看”的形式主義。更麻煩的是審查標(biāo)準(zhǔn)不統(tǒng)一、審查意見(jiàn)難追溯、新人不知道該怎么審、老人沒(méi)時(shí)間審這些問(wèn)題幾乎在每個(gè)團(tuán)隊(duì)都出現(xiàn)過(guò)。open-code-review 這個(gè)標(biāo)題之所以值得展開(kāi)聊是因?yàn)樗噲D用“開(kāi)放”的思路去拆解這些老問(wèn)題。它適合誰(shuí)來(lái)參考我的判斷是三類(lèi)人第一類(lèi)是正在搭建或重構(gòu)代碼審查流程的技術(shù)負(fù)責(zé)人你需要一套可落地的機(jī)制而不是一句“大家要認(rèn)真review”第二類(lèi)是一線開(kāi)發(fā)者你想知道怎么審別人的代碼、怎么讓自己的代碼更容易被審過(guò)第三類(lèi)是對(duì)研發(fā)效能、工程文化感興趣的人你想理解為什么有些團(tuán)隊(duì)的代碼質(zhì)量能持續(xù)穩(wěn)定而有些團(tuán)隊(duì)總是在救火。這篇文章我會(huì)從設(shè)計(jì)思路、核心機(jī)制、實(shí)操落地、問(wèn)題排查幾個(gè)角度把 open-code-review 這個(gè)主題拆開(kāi)講透。所有內(nèi)容基于我對(duì)代碼審查這件事的長(zhǎng)期觀察和實(shí)踐總結(jié)涉及具體工具和參數(shù)的地方我會(huì)說(shuō)明這是基于常見(jiàn)工程實(shí)踐的合理補(bǔ)充你可以根據(jù)自己的技術(shù)棧做調(diào)整。2. 代碼審查的現(xiàn)狀拆解與 open-code-review 的設(shè)計(jì)邏輯2.1 為什么傳統(tǒng)代碼審查總是“看起來(lái)有實(shí)際上弱”先說(shuō)一個(gè)我觀察到的普遍現(xiàn)象很多團(tuán)隊(duì)在項(xiàng)目管理工具里確實(shí)配了代碼審查環(huán)節(jié)合并請(qǐng)求必須至少一人批準(zhǔn)才能合入。但實(shí)際執(zhí)行下來(lái)批準(zhǔn)往往發(fā)生在幾分鐘甚至幾十秒內(nèi)審查者可能只看了文件名和改動(dòng)行數(shù)就點(diǎn)了通過(guò)。這不是審查者不負(fù)責(zé)任而是機(jī)制設(shè)計(jì)出了問(wèn)題。傳統(tǒng)代碼審查的典型痛點(diǎn)可以歸納為四類(lèi)。第一類(lèi)是審查標(biāo)準(zhǔn)模糊什么算“必須改”、什么算“建議改”、什么算“可以忽略”沒(méi)有明確分級(jí)導(dǎo)致審查意見(jiàn)要么太瑣碎引發(fā)爭(zhēng)論要么太籠統(tǒng)沒(méi)有指導(dǎo)性。第二類(lèi)是審查負(fù)擔(dān)不均核心開(kāi)發(fā)者被大量合并請(qǐng)求淹沒(méi)新人提交的代碼沒(méi)人愿意花時(shí)間細(xì)看形成惡性循環(huán)。第三類(lèi)是審查知識(shí)不沉淀同一個(gè)問(wèn)題在不同合并請(qǐng)求里被反復(fù)指出但沒(méi)有人把它整理成團(tuán)隊(duì)規(guī)范或自動(dòng)化檢查規(guī)則。第四類(lèi)是審查過(guò)程不透明誰(shuí)審了、審了什么、為什么通過(guò)這些信息散落在各個(gè)合并請(qǐng)求的評(píng)論里無(wú)法聚合分析。open-code-review 的設(shè)計(jì)邏輯本質(zhì)上是用“開(kāi)放”的思路去對(duì)沖這四類(lèi)問(wèn)題。開(kāi)放意味著審查規(guī)則公開(kāi)、審查過(guò)程可見(jiàn)、審查知識(shí)共享、審查能力可擴(kuò)展。它不是簡(jiǎn)單地?fù)Q一個(gè)審查工具而是重新定義審查這件事的參與方式和沉淀方式。2.2 open-code-review 的核心設(shè)計(jì)原則基于我對(duì)這個(gè)主題的理解open-code-review 的設(shè)計(jì)原則可以拆成四條。第一條是規(guī)則前置把能自動(dòng)化的檢查盡量前置到提交階段讓人工審查聚焦在邏輯、設(shè)計(jì)、邊界條件這些機(jī)器難以判斷的地方。第二條是分級(jí)審查根據(jù)改動(dòng)的影響范圍和風(fēng)險(xiǎn)等級(jí)決定需要多少人審、審到什么深度。第三條是知識(shí)回流每次審查中發(fā)現(xiàn)的典型問(wèn)題都要有機(jī)制回流到規(guī)范文檔或自動(dòng)化規(guī)則里避免重復(fù)勞動(dòng)。第四條是開(kāi)放參與審查不局限于當(dāng)前項(xiàng)目的固定成員可以引入跨團(tuán)隊(duì)甚至外部貢獻(xiàn)者的視角。這四條原則聽(tīng)起來(lái)不復(fù)雜但落地時(shí)每一步都有坑。比如規(guī)則前置如果自動(dòng)化檢查太嚴(yán)格開(kāi)發(fā)者會(huì)覺(jué)得被束縛太寬松又起不到過(guò)濾作用。分級(jí)審查的難點(diǎn)在于如何定義“影響范圍”和“風(fēng)險(xiǎn)等級(jí)”這需要結(jié)合具體的代碼架構(gòu)和業(yè)務(wù)場(chǎng)景來(lái)設(shè)計(jì)。知識(shí)回流最大的障礙是“沒(méi)人愿意寫(xiě)文檔”所以必須把回流動(dòng)作嵌入到審查流程本身而不是額外增加負(fù)擔(dān)。開(kāi)放參與則要考慮權(quán)限管理和信息安全不能為了開(kāi)放而開(kāi)放。2.3 與常見(jiàn)審查模式的對(duì)比為了更清楚地說(shuō)明 open-code-review 的定位我把它和幾種常見(jiàn)的審查模式做個(gè)對(duì)比。審查模式核心特點(diǎn)主要問(wèn)題open-code-review 的改進(jìn)方向同步審查提交者當(dāng)面講解審查者即時(shí)反饋時(shí)間難協(xié)調(diào)記錄難沉淀異步為主關(guān)鍵改動(dòng)同步補(bǔ)充強(qiáng)制雙人審查每個(gè)合并請(qǐng)求至少兩人批準(zhǔn)負(fù)擔(dān)重容易形式化按風(fēng)險(xiǎn)分級(jí)低風(fēng)險(xiǎn)單人審自動(dòng)化檢查為主依賴(lài)靜態(tài)掃描和測(cè)試覆蓋無(wú)法發(fā)現(xiàn)設(shè)計(jì)問(wèn)題機(jī)器過(guò)濾基礎(chǔ)問(wèn)題人工聚焦邏輯社區(qū)式開(kāi)放審查任何人可評(píng)論和批準(zhǔn)權(quán)限混亂責(zé)任不清分層權(quán)限核心改動(dòng)仍需負(fù)責(zé)人確認(rèn)這個(gè)對(duì)比不是說(shuō)其他模式一無(wú)是處而是說(shuō) open-code-review 試圖在“效率”和“質(zhì)量”之間找一個(gè)更可持續(xù)的平衡點(diǎn)。它的核心不是追求最嚴(yán)格的審查而是追求最合理的審查投入產(chǎn)出比。3. 核心機(jī)制拆解規(guī)則、分級(jí)、回流、開(kāi)放怎么落地3.1 規(guī)則前置把機(jī)器能做的先做掉規(guī)則前置是 open-code-review 的第一道防線。我在多個(gè)團(tuán)隊(duì)實(shí)踐下來(lái)的經(jīng)驗(yàn)是代碼格式、命名規(guī)范、明顯的空指針風(fēng)險(xiǎn)、未使用的變量、硬編碼的敏感信息這些都應(yīng)該在提交階段就被自動(dòng)化工具攔截而不是留到人工審查時(shí)再提。具體怎么做以常見(jiàn)的開(kāi)發(fā)流程為例可以在代碼提交前配置鉤子運(yùn)行格式化和靜態(tài)檢查。如果檢查不通過(guò)提交直接被拒絕開(kāi)發(fā)者需要先修復(fù)再提交。這一步的關(guān)鍵是規(guī)則要少而精不要一上來(lái)就開(kāi)幾百條檢查規(guī)則那樣只會(huì)讓開(kāi)發(fā)者想辦法繞過(guò)。我的建議是先開(kāi)三類(lèi)規(guī)則格式化類(lèi)如縮進(jìn)、換行、導(dǎo)入順序、安全類(lèi)如硬編碼密鑰、SQL拼接、明顯錯(cuò)誤類(lèi)如未處理的異常、空的catch塊。注意規(guī)則前置的目的是減少人工審查的噪音不是替代人工審查。如果自動(dòng)化檢查太激進(jìn)開(kāi)發(fā)者會(huì)花大量時(shí)間在格式問(wèn)題上反而擠占了真正重要的邏輯審查時(shí)間。這里有個(gè)實(shí)操細(xì)節(jié)值得展開(kāi)。很多團(tuán)隊(duì)在配置靜態(tài)檢查時(shí)會(huì)把所有規(guī)則都設(shè)為“錯(cuò)誤”級(jí)別導(dǎo)致提交頻繁失敗。更合理的做法是分兩級(jí)錯(cuò)誤級(jí)別的規(guī)則必須修復(fù)才能提交警告級(jí)別的規(guī)則只提示不阻斷。警告級(jí)別的規(guī)則可以定期回顧如果某個(gè)警告長(zhǎng)期無(wú)人處理要么把它升級(jí)為錯(cuò)誤要么直接關(guān)掉避免規(guī)則列表越來(lái)越長(zhǎng)卻沒(méi)人看。3.2 分級(jí)審查不是所有改動(dòng)都值得三個(gè)人看分級(jí)審查是 open-code-review 里最容易被忽視但收益最大的機(jī)制。我見(jiàn)過(guò)太多團(tuán)隊(duì)對(duì)所有合并請(qǐng)求一視同仁結(jié)果就是核心開(kāi)發(fā)者被大量瑣碎改動(dòng)拖垮而真正有風(fēng)險(xiǎn)的改動(dòng)反而沒(méi)人細(xì)看。分級(jí)審查的核心是回答兩個(gè)問(wèn)題這個(gè)改動(dòng)影響什么這個(gè)改動(dòng)有多復(fù)雜影響范圍可以從幾個(gè)維度判斷是否涉及核心業(yè)務(wù)邏輯、是否修改公共接口、是否影響數(shù)據(jù)存儲(chǔ)結(jié)構(gòu)、是否涉及權(quán)限和安全。復(fù)雜度可以從改動(dòng)行數(shù)、涉及文件數(shù)、是否引入新依賴(lài)來(lái)評(píng)估。基于這兩個(gè)維度我通常把審查分成三級(jí)。一級(jí)審查適用于文檔更新、注釋修正、配置微調(diào)這類(lèi)低風(fēng)險(xiǎn)改動(dòng)只需要一名同組開(kāi)發(fā)者快速確認(rèn)即可。二級(jí)審查適用于普通功能開(kāi)發(fā)、局部重構(gòu)需要一名熟悉該模塊的開(kāi)發(fā)者仔細(xì)審查重點(diǎn)關(guān)注邏輯正確性和邊界條件。三級(jí)審查適用于核心邏輯變更、公共接口調(diào)整、數(shù)據(jù)遷移腳本需要至少兩名審查者其中一名必須是該模塊的負(fù)責(zé)人或架構(gòu)師。審查級(jí)別適用場(chǎng)景審查人數(shù)重點(diǎn)關(guān)注一級(jí)文檔、注釋、配置微調(diào)1人描述準(zhǔn)確性、無(wú)副作用二級(jí)普通功能、局部重構(gòu)1-2人邏輯正確性、邊界條件、測(cè)試覆蓋三級(jí)核心邏輯、公共接口、數(shù)據(jù)變更2人以上設(shè)計(jì)合理性、兼容性、回滾方案分級(jí)審查的難點(diǎn)在于如何讓開(kāi)發(fā)者自覺(jué)遵守分級(jí)規(guī)則。我的經(jīng)驗(yàn)是把分級(jí)判斷嵌入到合并請(qǐng)求的模板里提交者必須選擇審查級(jí)別并說(shuō)明理由。如果選錯(cuò)了級(jí)別審查者可以要求重新分級(jí)。時(shí)間長(zhǎng)了團(tuán)隊(duì)會(huì)形成對(duì)改動(dòng)風(fēng)險(xiǎn)的共同判斷標(biāo)準(zhǔn)。3.3 知識(shí)回流讓每次審查都變成團(tuán)隊(duì)資產(chǎn)知識(shí)回流是 open-code-review 里最能體現(xiàn)“開(kāi)放”精神的一環(huán)。傳統(tǒng)審查中審查意見(jiàn)留在合并請(qǐng)求的評(píng)論區(qū)隨著時(shí)間推移被淹沒(méi)。下次有人犯同樣的錯(cuò)誤審查者還是要重新解釋一遍。知識(shí)回流要做的就是把這些重復(fù)出現(xiàn)的審查意見(jiàn)提煉出來(lái)變成團(tuán)隊(duì)共享的規(guī)范或自動(dòng)化規(guī)則。具體操作上我建議在審查流程中加一個(gè)輕量動(dòng)作當(dāng)審查者發(fā)現(xiàn)一個(gè)“值得記錄”的問(wèn)題時(shí)在評(píng)論里加一個(gè)特定標(biāo)簽比如“規(guī)范候選”。每周或每?jī)芍苡梢幻喼党蓡T把這些“規(guī)范候選”整理一遍判斷哪些應(yīng)該寫(xiě)入團(tuán)隊(duì)規(guī)范文檔哪些可以轉(zhuǎn)化為自動(dòng)化檢查規(guī)則哪些只是一次性特殊情況不需要沉淀。這個(gè)動(dòng)作的關(guān)鍵是輕量。如果要求審查者每次都寫(xiě)詳細(xì)的規(guī)范建議沒(méi)人會(huì)做。加一個(gè)標(biāo)簽、每周花半小時(shí)整理這個(gè)負(fù)擔(dān)是大多數(shù)團(tuán)隊(duì)可以接受的。整理出來(lái)的規(guī)范文檔也不要追求大而全按主題分幾個(gè)短文檔就好比如“異常處理規(guī)范”“日志打印規(guī)范”“接口設(shè)計(jì)規(guī)范”每個(gè)文檔控制在幾頁(yè)以?xún)?nèi)方便查閱。提示知識(shí)回流不是一次性的項(xiàng)目而是持續(xù)的習(xí)慣。我見(jiàn)過(guò)一些團(tuán)隊(duì)一開(kāi)始熱情很高整理了一份很長(zhǎng)的規(guī)范文檔但后續(xù)沒(méi)人維護(hù)半年后就過(guò)時(shí)了。更好的做法是讓規(guī)范文檔保持“活”的狀態(tài)每次審查中發(fā)現(xiàn)新問(wèn)題就補(bǔ)充一條發(fā)現(xiàn)舊規(guī)則不適用就刪掉或修改。3.4 開(kāi)放參與審查視角的多元化開(kāi)放參與是 open-code-review 區(qū)別于傳統(tǒng)審查的最顯著特征。傳統(tǒng)審查通常局限在當(dāng)前項(xiàng)目的固定成員之間而開(kāi)放參與意味著可以引入跨團(tuán)隊(duì)、跨角色的視角。比如前端改動(dòng)可以邀請(qǐng)后端開(kāi)發(fā)者看看接口調(diào)用是否合理數(shù)據(jù)變更可以邀請(qǐng)運(yùn)維同學(xué)看看是否有部署風(fēng)險(xiǎn)新人提交的代碼可以邀請(qǐng)其他新人一起審查既減輕老人負(fù)擔(dān)也促進(jìn)新人成長(zhǎng)。開(kāi)放參與的落地需要解決兩個(gè)問(wèn)題權(quán)限和責(zé)任。權(quán)限方面不是所有開(kāi)放參與者都有批準(zhǔn)合并的權(quán)限但可以有評(píng)論和提問(wèn)的權(quán)限。責(zé)任方面最終批準(zhǔn)合并的仍然是該模塊的負(fù)責(zé)人或指定審查者開(kāi)放參與者提供的是額外視角不是最終決策。我實(shí)踐下來(lái)效果比較好的一種做法是“審查伙伴”機(jī)制。每個(gè)開(kāi)發(fā)者除了自己的主項(xiàng)目外可以選一個(gè)關(guān)聯(lián)項(xiàng)目作為“審查伙伴”項(xiàng)目定期參與該項(xiàng)目的審查。這樣既擴(kuò)大了審查視角又不會(huì)造成權(quán)限混亂。審查伙伴的評(píng)論可以作為參考但不強(qiáng)制要求合并請(qǐng)求發(fā)起者采納。4. 實(shí)操落地從零搭建一套可運(yùn)行的 open-code-review 流程4.1 工具選型與基礎(chǔ)環(huán)境準(zhǔn)備搭建 open-code-review 流程工具選型是第一步。這里我不推薦具體產(chǎn)品而是給出選型時(shí)需要考慮的維度。你需要一個(gè)支持合并請(qǐng)求的平臺(tái)能夠配置自動(dòng)化檢查、能夠記錄審查評(píng)論、能夠設(shè)置審查規(guī)則。大多數(shù)主流代碼托管平臺(tái)都具備這些能力關(guān)鍵是配置方式?；A(chǔ)環(huán)境準(zhǔn)備包括三部分。第一部分是自動(dòng)化檢查工具鏈包括代碼格式化工具、靜態(tài)分析工具、依賴(lài)安全檢查工具。第二部分是合并請(qǐng)求模板用于引導(dǎo)提交者填寫(xiě)改動(dòng)說(shuō)明、審查級(jí)別、測(cè)試情況。第三部分是審查規(guī)則配置包括必須通過(guò)的檢查項(xiàng)、必須獲得的批準(zhǔn)數(shù)、必須參與的審查者角色。以合并請(qǐng)求模板為例我通常會(huì)在模板里放這幾個(gè)字段改動(dòng)類(lèi)型功能/修復(fù)/重構(gòu)/文檔、影響范圍模塊名稱(chēng)、審查級(jí)別一級(jí)/二級(jí)/三級(jí)、測(cè)試情況已覆蓋/未覆蓋/不需要、關(guān)聯(lián)任務(wù)編號(hào)。這些字段看起來(lái)簡(jiǎn)單但能大幅減少審查者的認(rèn)知負(fù)擔(dān)讓審查者快速判斷該關(guān)注什么。4.2 自動(dòng)化檢查的配置與調(diào)優(yōu)自動(dòng)化檢查的配置有一個(gè)原則先跑起來(lái)再調(diào)優(yōu)。不要一開(kāi)始就追求完美的規(guī)則集先把最基本的格式檢查和明顯的錯(cuò)誤檢查配上讓流程跑起來(lái)然后根據(jù)實(shí)際運(yùn)行情況逐步調(diào)整。具體配置時(shí)我建議分三個(gè)階段。第一階段只開(kāi)格式化檢查和語(yǔ)法檢查確保代碼能正常構(gòu)建。第二階段加入安全檢查和依賴(lài)檢查攔截硬編碼密鑰、已知漏洞依賴(lài)等問(wèn)題。第三階段加入復(fù)雜度檢查和重復(fù)代碼檢查但這類(lèi)檢查建議先設(shè)為警告級(jí)別觀察一段時(shí)間再?zèng)Q定是否升級(jí)為錯(cuò)誤級(jí)別。調(diào)優(yōu)的關(guān)鍵是看數(shù)據(jù)。定期統(tǒng)計(jì)自動(dòng)化檢查的攔截率、誤報(bào)率、開(kāi)發(fā)者反饋。如果某個(gè)規(guī)則攔截率很高但誤報(bào)也很多說(shuō)明規(guī)則需要調(diào)整閾值或增加例外。如果某個(gè)規(guī)則幾乎不觸發(fā)可以考慮關(guān)掉減少維護(hù)成本。# 示例合并請(qǐng)求檢查配置基于常見(jiàn)實(shí)踐 checks: format: enabled: true level: error lint: enabled: true level: error security: enabled: true level: error complexity: enabled: true level: warning threshold: 15 duplicate: enabled: true level: warning min_lines: 10這個(gè)配置示例展示了分級(jí)思路格式、語(yǔ)法、安全檢查設(shè)為錯(cuò)誤級(jí)別必須通過(guò)復(fù)雜度和重復(fù)代碼檢查設(shè)為警告級(jí)別只提示不阻斷。閾值和具體規(guī)則需要根據(jù)團(tuán)隊(duì)的技術(shù)棧和代碼風(fēng)格來(lái)調(diào)整。4.3 審查分級(jí)的具體判斷標(biāo)準(zhǔn)與操作流程審查分級(jí)的判斷標(biāo)準(zhǔn)需要團(tuán)隊(duì)共同約定不能由某個(gè)人拍腦袋決定。我通常建議用一次團(tuán)隊(duì)會(huì)議來(lái)討論并確定分級(jí)標(biāo)準(zhǔn)然后寫(xiě)入合并請(qǐng)求模板和團(tuán)隊(duì)規(guī)范文檔。判斷標(biāo)準(zhǔn)可以從三個(gè)維度來(lái)定。影響維度是否修改公共接口、是否涉及數(shù)據(jù)存儲(chǔ)、是否影響權(quán)限控制、是否涉及核心業(yè)務(wù)邏輯。復(fù)雜度維度改動(dòng)行數(shù)、涉及文件數(shù)、是否引入新依賴(lài)、是否涉及并發(fā)或異步邏輯。風(fēng)險(xiǎn)維度是否有回滾方案、是否有測(cè)試覆蓋、是否在發(fā)布窗口期。操作流程上提交者在創(chuàng)建合并請(qǐng)求時(shí)先自評(píng)審查級(jí)別審查者如果認(rèn)為級(jí)別不合適可以調(diào)整。對(duì)于三級(jí)審查建議在合并請(qǐng)求描述里額外說(shuō)明設(shè)計(jì)思路和回滾方案方便審查者快速理解上下文。判斷維度一級(jí)審查二級(jí)審查三級(jí)審查影響范圍文檔、注釋、配置單模塊功能公共接口、數(shù)據(jù)存儲(chǔ)改動(dòng)規(guī)模10行以?xún)?nèi)10-200行200行以上或跨多模塊測(cè)試要求不需要單元測(cè)試覆蓋單元測(cè)試集成測(cè)試回滾方案不需要建議提供必須提供這個(gè)表格可以作為團(tuán)隊(duì)討論的起點(diǎn)具體數(shù)值和分類(lèi)需要根據(jù)實(shí)際情況調(diào)整。關(guān)鍵是讓分級(jí)標(biāo)準(zhǔn)可操作、可驗(yàn)證而不是模糊的“重要”或“不重要”。4.4 審查意見(jiàn)的撰寫(xiě)規(guī)范與溝通技巧審查意見(jiàn)的撰寫(xiě)質(zhì)量直接影響審查效果和團(tuán)隊(duì)氛圍。我見(jiàn)過(guò)太多審查評(píng)論寫(xiě)成“這不對(duì)”“改一下”“有問(wèn)題”這種評(píng)論除了讓提交者困惑之外沒(méi)有任何價(jià)值。好的審查意見(jiàn)應(yīng)該包含三部分指出問(wèn)題、說(shuō)明原因、給出建議。舉個(gè)例子看到一段沒(méi)有處理異常的代碼差的評(píng)論是“這里沒(méi)處理異?！?。好的評(píng)論是“這個(gè)調(diào)用可能拋出網(wǎng)絡(luò)異常如果不在外層捕獲會(huì)導(dǎo)致整個(gè)流程中斷。建議在這里加try-catch或者在調(diào)用方統(tǒng)一處理?？梢詤⒖纪K的另一個(gè)函數(shù)的做法。”這樣的評(píng)論既指出了問(wèn)題又說(shuō)明了影響還給出了具體建議和參考。溝通技巧方面我建議遵循幾個(gè)原則。第一對(duì)事不對(duì)人評(píng)論針對(duì)代碼而不是開(kāi)發(fā)者。第二區(qū)分必須和建議必須修改的用明確語(yǔ)氣建議性質(zhì)的用“可以考慮”“建議”等措辭。第三避免反問(wèn)句“你為什么這么寫(xiě)”容易引發(fā)防御心理?yè)Q成“這里這樣寫(xiě)的考慮是什么”更中性。第四及時(shí)肯定看到好的設(shè)計(jì)或巧妙的實(shí)現(xiàn)不要吝嗇贊美這能讓審查氛圍更積極。注意審查意見(jiàn)的溝通成本往往被低估。一條模糊的評(píng)論可能導(dǎo)致來(lái)回好幾輪討論而一條清晰的評(píng)論可能一次就解決問(wèn)題?；〞r(shí)間把評(píng)論寫(xiě)清楚長(zhǎng)遠(yuǎn)看是節(jié)省時(shí)間。4.5 知識(shí)回流的操作細(xì)節(jié)與工具支持知識(shí)回流的操作細(xì)節(jié)前面提過(guò)標(biāo)簽機(jī)制這里補(bǔ)充一些工具支持方面的經(jīng)驗(yàn)。大多數(shù)代碼托管平臺(tái)都支持標(biāo)簽或標(biāo)記功能可以用來(lái)標(biāo)記“規(guī)范候選”。如果沒(méi)有現(xiàn)成的標(biāo)簽功能也可以用評(píng)論里的固定前綴來(lái)替代比如以“【規(guī)范候選】”開(kāi)頭的評(píng)論。整理頻率建議每周一次每次不超過(guò)半小時(shí)。整理時(shí)按主題分類(lèi)比如異常處理、日志、命名、接口設(shè)計(jì)、測(cè)試。每個(gè)主題下記錄典型問(wèn)題和推薦做法。整理結(jié)果可以放在團(tuán)隊(duì) wiki 或文檔平臺(tái)保持可搜索、可鏈接。工具支持方面如果團(tuán)隊(duì)有精力可以做一個(gè)簡(jiǎn)單的腳本自動(dòng)收集帶“規(guī)范候選”標(biāo)簽的評(píng)論生成周報(bào)。這樣整理者不需要手動(dòng)翻找效率更高。腳本可以用平臺(tái)提供的 API 來(lái)實(shí)現(xiàn)具體實(shí)現(xiàn)方式取決于你使用的平臺(tái)。5. 常見(jiàn)問(wèn)題與排查技巧實(shí)錄5.1 審查流于形式怎么辦這是最常見(jiàn)的問(wèn)題。表現(xiàn)是審查者快速批準(zhǔn)、評(píng)論稀少、問(wèn)題在合并后才暴露。排查思路可以從幾個(gè)角度入手。先看審查分級(jí)是否合理如果所有改動(dòng)都是一級(jí)審查那審查者自然不會(huì)花時(shí)間。再看自動(dòng)化檢查是否覆蓋了基礎(chǔ)問(wèn)題如果格式錯(cuò)誤、明顯bug都要人工指出審查者會(huì)疲憊。最后看審查意見(jiàn)是否有反饋閉環(huán)如果審查者提了意見(jiàn)但提交者不回應(yīng)也沒(méi)后果審查者會(huì)逐漸放棄。解決方法是多管齊下。調(diào)整分級(jí)標(biāo)準(zhǔn)讓高風(fēng)險(xiǎn)改動(dòng)獲得更多審查資源。加強(qiáng)自動(dòng)化檢查減少人工審查的噪音。建立審查意見(jiàn)的跟蹤機(jī)制未解決的審查意見(jiàn)不能合并。定期回顧審查數(shù)據(jù)對(duì)審查質(zhì)量高的成員給予認(rèn)可。5.2 審查者負(fù)擔(dān)過(guò)重怎么緩解審查者負(fù)擔(dān)過(guò)重通常是因?yàn)閷彶橘Y源集中在少數(shù)人身上。緩解方法包括擴(kuò)大審查者池讓更多成員參與審查降低低風(fēng)險(xiǎn)改動(dòng)的審查要求引入審查伙伴機(jī)制分擔(dān)審查壓力把重復(fù)出現(xiàn)的問(wèn)題轉(zhuǎn)化為自動(dòng)化規(guī)則減少人工指出。我實(shí)踐下來(lái)最有效的是輪值審查機(jī)制。每周指定一名輪值審查者負(fù)責(zé)初審所有合并請(qǐng)求判斷審查級(jí)別并分配給合適的審查者。輪值審查者不一定是技術(shù)最強(qiáng)的人但需要熟悉團(tuán)隊(duì)規(guī)范和模塊劃分。這個(gè)機(jī)制的好處是分散了審查決策的負(fù)擔(dān)也讓更多成員了解不同模塊的改動(dòng)。5.3 審查意見(jiàn)引發(fā)爭(zhēng)論怎么處理審查意見(jiàn)引發(fā)爭(zhēng)論通常是因?yàn)殡p方對(duì)某個(gè)設(shè)計(jì)或?qū)懛ㄓ胁煌捶āＬ幚碓瓌t是回到事實(shí)和標(biāo)準(zhǔn)。如果團(tuán)隊(duì)有明確的規(guī)范文檔引用規(guī)范。如果沒(méi)有規(guī)范討論是否應(yīng)該建立規(guī)范。如果只是風(fēng)格偏好建議以“不阻塞合并”的方式處理即審查者可以表達(dá)偏好但不強(qiáng)制要求修改。更根本的解決方法是提前對(duì)齊。在項(xiàng)目開(kāi)始或模塊設(shè)計(jì)階段就把關(guān)鍵的設(shè)計(jì)決策和編碼規(guī)范討論清楚減少審查階段的爭(zhēng)論。對(duì)于有爭(zhēng)議的改動(dòng)可以在合并請(qǐng)求描述里提前說(shuō)明設(shè)計(jì)取舍讓審查者理解決策背景。5.4 新人審查者不知道怎么審新人審查者常見(jiàn)的困惑是“看不出問(wèn)題”或“不敢提意見(jiàn)”。解決方法包括提供審查清單列出常見(jiàn)檢查點(diǎn)安排新人先審查低風(fēng)險(xiǎn)改動(dòng)積累經(jīng)驗(yàn)讓新人先做“影子審查”即審查但不提交評(píng)論和資深審查者的意見(jiàn)對(duì)比鼓勵(lì)新人提問(wèn)提問(wèn)也是審查的一部分。審查清單可以按類(lèi)別整理比如邏輯正確性、邊界條件、異常處理、日志、測(cè)試覆蓋、命名規(guī)范。新人對(duì)照清單逐項(xiàng)檢查慢慢形成自己的審查直覺(jué)。影子審查特別有效新人先自己審一遍再看資深審查者的評(píng)論對(duì)比差異學(xué)習(xí)效果很好。5.5 常見(jiàn)問(wèn)題速查表問(wèn)題現(xiàn)象可能原因排查方向解決建議審查快速通過(guò)分級(jí)不合理、自動(dòng)化不足檢查審查級(jí)別分布調(diào)整分級(jí)、加強(qiáng)自動(dòng)化審查者負(fù)擔(dān)重審查資源集中統(tǒng)計(jì)審查者分布輪值審查、擴(kuò)大審查池審查意見(jiàn)爭(zhēng)論多標(biāo)準(zhǔn)不明確檢查規(guī)范文檔建立規(guī)范、提前對(duì)齊新人不會(huì)審缺乏指導(dǎo)和練習(xí)了解新人反饋審查清單、影子審查問(wèn)題合并后才暴露審查深度不夠分析漏審問(wèn)題類(lèi)型加強(qiáng)三級(jí)審查、補(bǔ)充測(cè)試知識(shí)不沉淀回流機(jī)制缺失檢查規(guī)范更新頻率標(biāo)簽機(jī)制、定期整理這個(gè)速查表可以作為團(tuán)隊(duì)自查的參考根據(jù)實(shí)際情況調(diào)整排查方向和解決建議。5.6 幾個(gè)容易踩的坑第一個(gè)坑是過(guò)度依賴(lài)工具。工具能解決格式和明顯錯(cuò)誤但設(shè)計(jì)合理性、業(yè)務(wù)邏輯正確性、邊界條件這些還是需要人工判斷。不要把審查完全交給自動(dòng)化。第二個(gè)坑是審查標(biāo)準(zhǔn)一刀切。不同模塊、不同改動(dòng)類(lèi)型需要不同的審查標(biāo)準(zhǔn)。核心模塊和邊緣模塊、新功能開(kāi)發(fā)和bug修復(fù)審查重點(diǎn)應(yīng)該有所區(qū)別。第三個(gè)坑是忽視審查者的成長(zhǎng)。審查不僅是保證代碼質(zhì)量的手段也是團(tuán)隊(duì)成員互相學(xué)習(xí)的機(jī)會(huì)。如果審查變成單向的挑錯(cuò)就失去了成長(zhǎng)價(jià)值。鼓勵(lì)審查者解釋自己的思路也鼓勵(lì)提交者解釋自己的設(shè)計(jì)讓審查成為雙向交流。第四個(gè)坑是規(guī)范文檔寫(xiě)完就忘。規(guī)范文檔需要定期回顧和更新否則會(huì)過(guò)時(shí)。建議每季度回顧一次刪掉不適用的補(bǔ)充新出現(xiàn)的典型問(wèn)題。6. 一些個(gè)人體會(huì)和后續(xù)可以做的事我在多個(gè)團(tuán)隊(duì)推行過(guò)不同形式的 open-code-review 流程最大的體會(huì)是審查文化的建設(shè)比流程和工具更重要。流程可以照搬工具可以采購(gòu)但如果團(tuán)隊(duì)成員不認(rèn)同審查的價(jià)值再好的流程也會(huì)流于形式。審查文化的核心是“互相學(xué)習(xí)、共同提高”而不是“挑錯(cuò)、問(wèn)責(zé)”。這個(gè)基調(diào)定對(duì)了后面的機(jī)制設(shè)計(jì)才有意義。另一個(gè)體會(huì)是從小處著手。不要試圖一次性搭建完美的審查體系先從一個(gè)模塊、一個(gè)團(tuán)隊(duì)開(kāi)始試點(diǎn)跑通流程后再推廣。試點(diǎn)過(guò)程中收集反饋調(diào)整規(guī)則和分級(jí)標(biāo)準(zhǔn)形成適合自己團(tuán)隊(duì)的方案。后續(xù)可以做的事包括把審查數(shù)據(jù)可視化比如統(tǒng)計(jì)審查覆蓋率、審查意見(jiàn)解決率、問(wèn)題類(lèi)型分布用數(shù)據(jù)驅(qū)動(dòng)流程優(yōu)化探索跨團(tuán)隊(duì)審查讓不同團(tuán)隊(duì)互相審查引入更多視角把審查和持續(xù)集成更緊密地結(jié)合讓自動(dòng)化檢查覆蓋更多場(chǎng)景。最后分享一個(gè)小技巧在合并請(qǐng)求模板里加一個(gè)“審查者自查”字段讓審查者在批準(zhǔn)前確認(rèn)幾個(gè)關(guān)鍵點(diǎn)比如“是否理解了改動(dòng)意圖”“是否檢查了邊界條件”“是否確認(rèn)了測(cè)試覆蓋”。這個(gè)簡(jiǎn)單的動(dòng)作能顯著提高審查質(zhì)量因?yàn)樗谂鷾?zhǔn)前強(qiáng)制審查者做一次快速自檢。我試過(guò)在幾個(gè)團(tuán)隊(duì)推行效果比預(yù)期好審查意見(jiàn)的質(zhì)量和數(shù)量都有提升。