點擊“開發(fā)者技術前線”，選擇“星標”
讓一部分開發(fā)者先看到未來
來源 | https://urlify.cn/eIzyya眾所周知，Code Review是開發(fā)過程中一個非常重要的環(huán)節(jié)，但是很多公司或者團隊是沒有這一環(huán)節(jié)的，今天筆者結合自己所在團隊，淺談Code Review的價值及如何實施。
1. CR的價值
許多團隊沒有Code Review環(huán)節(jié)，或者因為追求項目快速上線，認為CR浪費時間；或者團隊成員缺少CR觀念，認為CR的價值并不大。所以想要推動CR在團隊中的實施，最最重要的一點便是增強團隊成員對CR環(huán)節(jié)的認同感。Code Review環(huán)節(jié)，它更加依賴于團隊成員的主觀能動性，只有團隊成員對其認可，他們才會積極地參入這一環(huán)節(jié)，CR的價值才能最大化的體現。如果團隊成員不認可CR，即使強制設置了CR流程，也是形同虛設，反而可能阻礙正常開發(fā)流程的效率。那么如何讓團隊成員認可CR環(huán)節(jié)呢，自然是讓他們意識到CR的價值，然后就會……真香！1.1 提升團隊代碼質量
隨著團隊規(guī)模的擴大和項目的迭代升級，團隊之間的信息透明度會越來越低，項目的可維護性也會越來越差，可能引發(fā)如下一系列問題：已有的utils方法，重復造輪子
代碼過于復雜，缺少必要注釋，后人難以維護
目錄結構五花八門，雜亂不堪
……
合理的CR環(huán)節(jié)，可以有效地把控每次提交的代碼質量，不至于讓項目的可維護性隨著版本迭代和時間推移變得太差，這也是CR的首要目的。CR環(huán)節(jié)并不會降低開發(fā)效率，就一次代碼提交來說，也許部分人認為CR可能花費了時間，但是有效的CR給后人擴展和維護時所節(jié)省的時間是遠超于此的。1.2 團隊技術交流
Reviewer和Reviewee，在參與CR的過程中，都是可以收獲到許多知識，進行技術交流的。有利于幫助新人快速成長，團隊有新人加入時（如實習生和校招生），往往需要以為導師帶領一段時間，通過CR環(huán)節(jié)，可以使導師最直接的了解到新人開發(fā)過程中所遇到的問題，作出相應的指導。通過CR環(huán)節(jié)，團隊成員可以了解他人的業(yè)務，而不局限于自己的所負責的業(yè)務范圍。項目發(fā)現問題時，可以迅速定位到相關業(yè)務的負責人進行修改。同時若有的團隊成員離職后，也可以減少業(yè)務一人負責所帶來的后期維護困難。學習他人的優(yōu)秀代碼。通過CR環(huán)節(jié)，可以迅速接觸到團隊成員在項目中解決某些問題的優(yōu)秀代碼，或者使用的一些你所未接觸過的一些api等。1.3 保證項目的統(tǒng)一規(guī)范
既然要進行CR，首先要對項目的規(guī)范制定要求，包括編碼風格規(guī)范、目錄結構規(guī)范、業(yè)務規(guī)范等等。一方面，統(tǒng)一的項目規(guī)范才能保證項目的代碼質量，提高項目的質量和可維護性；另一方面，在大家熟悉了統(tǒng)一的規(guī)范后，能夠提升CR的效率，節(jié)省時間。2. Code Review的實踐
關于Code Review的實踐，要考慮的包括CR所花費的時間、CR的形式、何時進行CR等等。2.1 預留CR的時間
首先不得不承認，CR環(huán)節(jié)是要耗費一定時間的，所以在項目排期中，不僅要考慮開發(fā)、聯(lián)調、提測、改bug等時間，還要預留出CR的時間。包括擔任Reviewer和Reviewee角色的時間都要考慮。另外如果遇到的需求比較復雜，為了避免因為CR過程導致代碼需要大量修改，最好提前和團隊成員溝通好需求的設計和結果思路。2.2 CR的形式
我所見過的CR大多有兩種形式。一種是設立一個特定時間，例如每周或者每半月等等，團隊成員一起對之前的Merge Request進行CR；另一種是對每次的Merge Request都進行CR。我個人更偏向于后者。第一種定期CR，Merge Request的數量太多，不太可能對所有的MR進行CR，如果CR之后再對之前的諸多MR進行修改成本太大；而且一次性太多的CR會打擊團隊成員的積極性。第二種MR相對就輕松的多，可以考慮輪班每天設置2-3人對當天的MR進行CR即可。2.3 CR的時機
CR的環(huán)節(jié)應該設立在提測環(huán)節(jié)之前。因為CR后如果優(yōu)化代碼雖然理論上只是代碼優(yōu)化，但很可能會對業(yè)務邏輯產生影響，如果在提測時候，那么可能會影響到已經測試過的功能點。當然也要分情況，如果遇到比較緊急的需求或者bug修復，那么也可以先提測，后續(xù)再做相應的CR。3. 對團隊成員要求
前面已經提到，要增強團隊成員對CR環(huán)節(jié)的認同感。作為CR環(huán)節(jié)的參與者，還應該根據自己的團隊特點，對團隊成員做出相應要求，可以參考我們團隊。3.1 Reviewer
指明review的級別。reviewer再給相應的代碼添加評論時，建議指明評論的級別，可以在評論前用[]作出標識，例如：[request]xxxxxxx 此條評論的代碼必須修改才能予以通過
[advise]xxxxxxxx 此條評論的代碼建議修改，但不修改也可以通過
[question]xxxxxx 此條評論的代碼有疑問，需reviewee進一步解釋
講明該評論的原因。在對代碼做出評論時，應當解釋清楚原因，如果自己有現成的更好地解決思路，應該把相應的解決思路也評論上，節(jié)省reviewee的修改時間。平等友善的評論。評論者在review的過程中，目的是提升項目代碼質量，而不是抨擊別人，質疑別人的能力，應該保持平等友善的語氣。享受Code Review。只有積極的參與CR，把CR作為一種享受，才能將CR的價值最大化的體現。3.2 Reviewee
注重注釋。對于復雜代碼寫明相應注釋，在進行commit時也應簡明的寫清楚背景，幫助reviewer理解，提高review的效率。保持樂觀的心態(tài)接受別人的review。團隊成員的review不是對你的批判，而是幫助你的提升，所以要尊重別人的review，如果review你感覺不正確，可以在下面提出疑問，進一步解釋。完成相應review的修改應當在下面及時進行回復，保持信息同步。— 完 —
點這里??關注我，記得標星呀～
前線推出學習交流一定要備注：研究/工作方向+地點+學校/公司+昵稱（如JAVA+上海
掃碼加小編微信，進群和大佬們零距離
后臺回復“電子書” “資料” 領取一份干貨，數百面試手冊等你開發(fā)者技術前線 ，匯集技術前線快訊和關注行業(yè)趨勢，大廠干貨，
