前言
今天給大家分享一下我之前在公司搭建的一個(gè)Code Review服務(wù)器的一些心得吧。由于現(xiàn)在移動(dòng)互聯(lián)網(wǎng)更新迭代速度很快，分布版本的速度基本上決定了創(chuàng)業(yè)公司的生命，所以代碼質(zhì)量在決定產(chǎn)品質(zhì)量上也體現(xiàn)出尤其重要的地位。
目錄
1.Phabricator Summary
2.pre-push code review tool —— Differential
3.code repository browse tool — Diffusion
4.post-push code review tool —— Audit
5.Other Feature Summary
6.Final
一.Phabricator Summary
今天我要向大家分享的是一款非常棒的代碼檢視工具Phabricator。Phabricator是Facebook保駕護(hù)航的11大IT技術(shù)之一。在Phabricator的網(wǎng)站中，開發(fā)者給出了這樣的描述：“Facebook的工程師們毫不掩飾自己對于Phabricator的喜愛之情，他們甚至將它視為’順利’與’嚴(yán)謹(jǐn)’的代名詞”。下面我就將演示使用Phabricator進(jìn)行代碼檢視的流程以及它的亮點(diǎn)。
Facebook 保價(jià)護(hù)航的11大IT技術(shù)
1.HTML5
2.Facebook平臺(tái)
3.Facebook虛擬幣
4.Facebook應(yīng)用
5.開放計(jì)算項(xiàng)目
6.Hadoop
7.LAMP堆棧
8.Scuba
9.HipHop For PHP
10.Scribe 與 Thift
11.Phabricator
這就是搭建好的服務(wù)器的界面
二.Differential
Differential是Phabricator核心功能之一，它是開發(fā)者相互檢視代碼，互相討論代碼的主要平臺(tái)。
談到如何生成Diff，此處需要用到Arcanist Tool工具了。
1.DownLoad Tool 下載Arcanist Tool
2.Edit Path 配置path路徑
3.install certificate 安裝證書
4.install certificate 驗(yàn)證證書token
5.creat diff 生成diff
6.edit diff info 編輯diff的信息
到此就生成了一個(gè)diff了。相應(yīng)的，在搭建的服務(wù)器網(wǎng)頁上也應(yīng)該對應(yīng)的有一條diff記錄
現(xiàn)在應(yīng)該到了pre-push code review，提交之前等待審核代碼的人審核了。
審核代碼的人界面上面就會(huì)出現(xiàn)這樣的界面
當(dāng)審核人同意通過后，申請審核的人的界面會(huì)收到通過的通知
三.Diffusion
Phabricator提供一個(gè)類似于gitlab之類的遠(yuǎn)程倉庫瀏覽工具diffusion，開發(fā)人員可以快速查看以下信息
1.VCS Repertory information 線上版本控制系統(tǒng) 倉庫信息
2.VCS commit history 提交歷史
3.Repertory directory structure 倉庫目錄樹
4.Directory structure & commit information 提交信息
5.Branches information 分支信息
四.Audit 審計(jì)
1.區(qū)別
很多人會(huì)有疑惑了，我們有了Differential，那么現(xiàn)在為何還需要一個(gè)Audit ？
下面我來解釋解釋Review vs Audit的區(qū)別
1.Phabricator supports two similar but separate code review workflows:
2.Differential is used for pre-push code review, called "reviews" elsewhere in the documentation. You can learn more in Differential User Guide.
3.Audit is used for post-push code reviews, called "audits" elsewhere in the documentation. You can learn more in Audit User Guide.
(By "pre-push", this document means review which blocks deployment of changes, while "post-push" means review which happens after changes are deployed or en route to deployment.)
4.Both are lightweight, asynchronous web-based workflows where reviewers/auditors inspect code independently, from their own machines -- not synchronous review sessions where authors and reviewers meet in person to discuss changes.
以上是FB官方的解釋，簡單的來說，Differential是代碼提交VCS倉庫前的代碼檢視工具，但是有些情況下我們的代碼由于某些情況來不及做非常細(xì)致的pre-commit review，需要提前部署。那么有什么辦法在在代碼提交VCS之后來進(jìn)行代碼檢視，保證我們的代碼質(zhì)量呢？答案是Audit。這就是Audit的職責(zé)。
2.工作原理
這里還會(huì)有人問了，Audit是怎么工作的呢？工作原理是什么呢？
Audit主要是由一些Audit請求觸發(fā)器實(shí)現(xiàn)的。
Audit工具主要跟蹤兩件事：
代碼提交（Commits），以及它們的審核狀態(tài)（譬如“未經(jīng)審核（Not Audited）”、“認(rèn)可（Approved）”、“引發(fā)擔(dān)憂（Concern Raised）”）。
審核請求（Audit Requests）。審核請求提醒用戶去審核一次提交。它有多種觸發(fā)方式。
現(xiàn)在說完了它的工作原理，我們來看看它的界面
3.Audit類型
Audit又可以分為2種：
必要的審核（Required Audits）。當(dāng)你是某個(gè)項(xiàng)目的成員，或者是一個(gè)包的擁有者，Required Audits提示你去審核一次提交。當(dāng)你認(rèn)可這次提交時(shí)，審核請求會(huì)被關(guān)閉。
問題提交（Problem Commits）。是指有人在審核過程中對你提交的代碼表示擔(dān)憂。當(dāng)你消除了他們的疑慮并且所有審核人均對代碼表示認(rèn)可時(shí)，問題提交將會(huì)消失。
4.Audit流程
舉個(gè)例子來詳細(xì)說明一下Audit的流程：
A進(jìn)行了一次代碼提交
B接收到審核請求
過了一陣兒，B登錄Phabricator并在首頁看到審核請求
B檢查A提交的代碼。他發(fā)現(xiàn)代碼中的一些問題，之后他選擇了“引發(fā)擔(dān)憂”選項(xiàng)，并且在評論中描述了這些問題
A收到一封關(guān)于B對她的提交表示憂慮的email。她決定過一會(huì)兒再處理這個(gè)問題
不久后，A登錄Phabricator并在首頁“問題提交”下看到提示
A通過某些方式解決了那些問題（如“找B討論”、“修復(fù)問題并提交”）
B表示滿意，并認(rèn)可了最初那次提交
審核請求將從B的待辦事項(xiàng)中消失。問題提交也會(huì)從A的待辦事項(xiàng)里消失
以上就是Audit的標(biāo)準(zhǔn)的流程了。
5.Audit Triggers 觸發(fā)器
審核請求可由以下4種方式觸發(fā)：
- 將“Auditors: username1, username2”寫入提交注釋中，會(huì)觸發(fā)上述用戶接到審核請求。
- 可以在Herald工具中，根據(jù)提交的屬性創(chuàng)建一系列的觸發(fā)規(guī)則。如有文件被創(chuàng)建、文本被修改，提交人等。
- 可以在任何提交中，通過提交注釋為自己創(chuàng)建審核請求。
- 你可以創(chuàng)建一個(gè)包，并且選擇“開啟審核”，這個(gè)功能是更強(qiáng)的特性，而且可能對于非常大的團(tuán)隊(duì)比較有用
6.關(guān)于Audit的小建議
- 審核人的責(zé)任感。在審閱一次代碼提交時(shí)，你所負(fù)責(zé)的審核是被突出顯示的。你要為自己的任何審核行為負(fù)責(zé)。
- 在diff對比區(qū)域，點(diǎn)擊行號(hào)將可添加內(nèi)嵌評論。
- 在diff對比區(qū)域，在行號(hào)上拖動(dòng)可添加跨越多行的內(nèi)嵌評論。
- 內(nèi)嵌評論最初只保存為草稿，直到你在頁面底部提交評論。
- 按“?”鍵查看快捷鍵。
Raise Concern
Add Comment
五.Other Feature Summary 其他的一些常用功能
- Maniphest：任務(wù)管理和缺陷追蹤(類似于Github的Issue)
- CountDown：定時(shí)提醒工具
- Repository：遠(yuǎn)程VCS倉庫管理
- Herald Rule：創(chuàng)建自定義規(guī)則，當(dāng)某些事件觸發(fā)了規(guī)則時(shí)提醒我們(類似于IFTTT)
六.Final
最后來談?wù)刾habricator的優(yōu)點(diǎn)吧。
- phabricator 中也是通過提交request來展示diff做reivew.但是他的diff不是文件的全部內(nèi)容，只是diff的部分，所以不需要事先在工具里添加庫，可以直接提交diff，也可以粘貼diff的內(nèi)容來提交。
- 不光只有代碼review工具，還有bug跟蹤，wiki等功能。可以直接做單元測試,bug與代碼review的關(guān)聯(lián)。
- 按request狀態(tài)分類清晰，搜索功能好用。
- 支持svn 和 git。
- 所有檢視工作只需要一個(gè)瀏覽器，不需要安裝額外的插/軟件。
- 操作界面和易用性非常棒。可自定義界面布局和主題，更加時(shí)尚和有活力
“The function of good software is to make the complex appear to be simple”
–Grady Booch,One of the UML founders
“好的軟件的作用是讓復(fù)雜的東西看起來簡單。”
(Grady Booch，UML創(chuàng)始人之一)
大家都來一起體驗(yàn)code review的強(qiáng)大吧！！
這篇是分享給大家使用Phabricator的方法，公司里面有這個(gè)服務(wù)器的，或者買了Phabricator服務(wù)的，又不會(huì)使用的，看了我這篇文章應(yīng)該能上手用起來啦！！有時(shí)間再給大家分享一下我當(dāng)時(shí)自己搭建這個(gè)服務(wù)器遇到的一些坑吧。這篇分享就到這里了，歡迎大家一起討論！
這里是我當(dāng)時(shí)在公司給大家分享時(shí)用的Keynote，做的一般，也一起分享出來給大家看看吧：http://pan.baidu.com/s/1dFiAaM9
GitHub Repo：Halfrost-Field
Follow: halfrost · GitHub
Source: https://halfrost.com/code_review_phabricator_use_guide_introduce/
