關於Code Review的一些思考總結

Code Review

目的

• 提高程式碼質量
• 提前發現bug
• 統一程式碼規範
• 提高團隊成員程式碼技能

前期找問題（程式碼規範、潛在缺陷、BUG，程式碼設計等等），後期演變成開發者技術交流和員工成長

如何開展

• 程式碼規範：明確Coding規則
• 檢視清單：結合業務特點，check重點
• 總結優化：透明問題，持續優化
• 激勵措施：激發主觀能動性

開展方式

• 強制&非強制
• 線上交流（小組review）&線下會議（團隊review）
• 小片段&大模組
• 釋出前&釋出後
• 高頻率&低頻率

阻力因素

• 領導或者團隊骨幹不認同
• 為了疲於應付
• 以需求多，沒時間 做為偷懶藉口

組織型別

1. 小組內review，通常是模組負責人或者專案負責人review，頻率比較高，一天至少一次

2. 團隊review，通常是整個團隊review程式碼，團隊負責人牽頭，頻率可以低一點，鑑於公司情況一週至少1次吧

review內容

統一團隊程式碼風格和程式設計規範

靜態程式碼檢查工具

1. Java類：Checkstyle、FindBugs、PMD、Infer等

2. JavaScript類：JSLint、ESLint等

3. Object-C類：OCLint、Clang Static Analyzer、Infer等

4. C#類：StyleCode等

……

更多可以參考的一些編碼規範(Kristories/awesome-guidelines )

發現『bad smell』的程式碼以及bug

相關書籍：《重構-改善既有程式碼的設計》《程式碼整潔之道》

團隊成員好的經驗

• 什麼寫法可能導致效能低下？
• 哪個介面要慎用？
• 哪些設計方式需要規避？
• 什麼習慣容易引發記憶體洩漏？

……

開發者由於當初時間緊迫而覺得設計不合理的功能

• 功能不完善
• 設計有欠缺
• 程式碼有更好實現方案
• 重視專案程式碼的可讀性

總之，程式碼是否符合團隊約定的程式碼風格規範、程式碼是否切合它所實現的業務、程式碼是否安全、程式碼效能、對後續開發者是否友好，即是否容易維護等

注意事項

• GitLab可以設定master和develop分支保護，開發者不能向這兩個分支push程式碼，只能通過PR/MR形式。
• 可以通過設定git pre-commit hook來check，從而使不符合規範的程式碼禁止提交倉庫。
• 配合CI檢查，作為build的第一步。
• 使用者角色有：所有者/主程/開發者/報告者/訪客 ，其中只有所有者和主程才有review程式碼和合並程式碼許可權。
• 注意小組至少有兩個人有許可權review併合並程式碼，避免一個人請假或者不在，導致程式碼合不上去。
• 主程一定要注意，避免過多模組工作堆積在自己身上，一定要學會合理分配任務，因為你還需要有精力去review程式碼，這也是一部分額外任務。
• 提交的 feature 分支全部走 gitlab 的 MR ，develop分支不允許提交，只用來合併 ，並且只合並那些經過review過的程式碼，master分支不允許提交，也只用來合併 ，並且只合並來自develop分支的程式碼。
• 不一定職稱越高，就更有可能比別人review程式碼，code review知識共享更受重視，通過review發現bug是有的，但不是最終目的，增進團隊共識，保護團隊一致性其實更重要。
• 儘量避免開發經驗不足的開發者或者剛進公司對業務不熟悉的人員（哪怕高階工程師）review 程式碼。
• 如果可以儘可能寫單元測試，不一定cover全面，如果時間緊迫可以只對關鍵模組做。
• 提交PR/MR，記得在IM上通知相關人員review，比如專案負責人或者模組負責人。
• 控制團隊review的時間，半個小時到1個小時，最好不要超過1個小時，30-40分鐘為宜，專案負責人具體把握。
• 根據公司情況團隊review一週在至少一次比較合適。
• review可能需要多次才被允許合入程式碼，這也就意味著，可能你的程式碼需要給多次修改才能改好。
• 避免程式碼堆積，造成一次review大量程式碼，一方面急於review，這樣容易放水，同時也浪費時間，造成效果不理想。
• 建議由1人做好記錄，把每次review的改進點以清單形式彙總列清楚發給所有參會人員。

總結

由於工期緊、需求變更快，如果不想清楚為什麼要做 Code Review ，遇到障礙會非常容易妥協，慢慢 Code Review 就會走樣，最終流於形式。反之，在我們遇到障礙，review 程式碼不順利時就會以積極的心態來解決問題。Code Review會影響開發效率，事實上追求高質量的程式碼本身就降低了區域性的開發效率，但是放眼長遠，這樣寫出來的程式碼更加健壯，不會或很少出現“詭異”的bug，降低了後期維護的成本。

所以Code Review本身沒有問題，其實是人容易出問題。