Code Review是什么?
Code Review是一種用來確認方案設計和代碼實現的質量保證機制,通過這個機制我們可以對代碼、測試過程和注釋進行檢查。
Code Review主要用來在軟件工程過程中改進代碼質量,通過Code Review可以達到, 在項目早期就能夠發現代碼中的BUG。
Code Review 主要 Revivew 什么?
代碼設計/構思方面:
1、單一職責原則(SRP)
這是經常被違背的原則。一個類只能干一個事情 , 一個方法最好也只干一件事情。 比較常見的違背是一個類既干 UI 的事情,又干邏輯的事情 , 這個在低質量的客戶端代碼里很常見。
2、行為是否統一
1.比如緩存是否統一,錯誤處理是否統一, 錯誤提示是否統一, 彈出框是否統一 等等。
2.同一邏輯 / 同一行為 有沒有走同一 Code Path?
3、代碼污染
代碼有沒有對其他模塊強耦合 ?
4、重復代碼
主要看有沒有把公用組件,可復用的代碼,函數抽取出來。
5、開放封閉原則(OCP)
就是好不好擴展。 Open for extension, closed for modification.
6、接口隔離原則(ISP)
使用多個隔離的接口,比使用單個接口要好。
7、面向接口編程 和 不是 面向實現編程
主要就是看有沒有進行合適的抽象, 把一些行為抽象為接口。
8、健壯性
1.對 Corner case 有沒有考慮完整,邏輯是否健壯?有沒有潛在的 bug?
2.有沒有內存泄漏?有沒有循環依賴 ?(針對特定語言,比如 Objective-C) ?有沒有野指針?
3.有沒有考慮線程安全性, 數據訪問的一致性
9、錯誤處理
有沒有很好的 Error Handling?比如網絡出錯,IO 出錯。
10、改動是不是對代碼的提升
新的改動是讓代碼質量繼續惡化,還是對代碼質量做了修復?
11、效率 / 性能
1.客戶端程序 對頻繁消息 和較大數據等耗時操作是否處理得當。
2.關鍵算法的時間復雜度多少?有沒有可能有潛在的性能瓶頸。
12、可讀性 / 可維護性
1.字段、變量、參數、方法、類的命名是否合理。
2.字段、變量、參數、方法、類的注釋是否完整。
如何進行Code Review?
1.多問問題。多問 “這塊兒是怎么工作的?” “如果有 XXX case,你這個怎么處理?”
2.每次提交的代碼不要太多,最好不要超過 1000 行,否則 review 起來效率會非常低。
3.當面討論代替 Comments。 大部分情況下小組內的同事是坐在一起的,face to face 的 code review 是非常有效的。
4.區分重點,不要舍本逐末。 優先抓住設計,可讀性,健壯性等重點問題。
Code Review應該注意什么?
1.作為審查者:代碼審查是一種學習,是表揚,是獲得反饋,是一種十分社交性的活動。代碼審查應該是有趣的,不要讓它變的無聊。
2.作為開發人員:代碼審查是針對代碼,不是針對你。不要把代碼審查當成互相諷刺的論壇和相互批判的工具。反而,代碼審查是提高你的一種路徑。