細說Sonar之——前端接入篇

一、sonar是什麼

sonar是一個代碼質量管理的開源平臺，用於管理源代碼的質量，經過插件形式，能夠支持包括java、C#、JavaScript等二十餘種編程語言的代碼質量管理與檢測。

sonar是從七個維度檢測代碼質量:
 1) 不遵循代碼標準sonar能夠經過PMD，CheckStyle，Findbugs等代碼規則檢測工具規範代碼編寫
 2) 潛在的缺陷sonar能夠經過PMD，CheckStyle，Findbugs等代碼規則檢測工具檢測出潛在的缺陷
 3) 糟糕的複雜度分佈文件、類、方法等，若是複雜度太高將難以改變，這會使得開發人員難以理解它們，且沒有自動化的單元測 試，對於程序中的任何組件的改變都將可能致使須要全面的迴歸測試
 4) 重複顯然程序中包含大量複製粘貼的代碼是質量低下的，sonar能夠展現源碼中重複嚴重的地方
 5) 註釋不足或者過多沒有註釋將使代碼可讀性變差，特別是當不可避免出現人員變更時，程序的可讀性大幅度降低，而過多的註釋又會使得開發人員將精力過多的花費在閱讀註釋上，亦違背初衷
 6) 缺少單元測試sonar能夠很方便地統計並展現單元測試覆蓋率
 7) 糟糕的設計經過sonar能夠找出循環，展現包與包、類與類之間相互依賴關係，能夠檢測自定義的架構規則， 能夠管理第三方的jar包，能夠利用LCOM4檢測單個任務規則的應用狀況，檢測耦合。

二、sonar安裝

以mac安裝sonar爲例，而且只是前端安裝sonar的過程，不涉及後端數據等安裝

a）安裝JDK。

JDK下載網址

先選擇接受許可協議【1】而後選擇操做系統點擊下載【2】

安裝步驟： 按照提示安裝便可

b）sonar-SonarQube 安裝

1）sonar-SonarQube下載地址

2）下載完成：解壓縮到 /usr/local

3）終端進入：/usr/local/sonarqube-7.4/bin/macosx-universal-64

4）啓動/中止/重啓服務

• ./sonar.sh start 啓動服務
• ./sonar.sh stop 中止服務
• ./sonar.sh restart 重啓服務

5）打開網址 http://localhost:9000 登陸admin／admin

6）漢化-> 按圖操做

搜索的chinese ，而後install

安裝成功後，重啓sonarqube服務，再次訪問 http://localhost:9000/ ，便可看到中文界面

c) sonar-scanner掃描器安裝

1） sonar-scanner掃描器下載地址

2）下載完成：解壓縮到 /usr/local

3）修改環境變量 進入/usr/local 若是沒有權限的修改文件能夠試試下面的方法 打開文件：

sudo vi /etc/profile（須要輸入本身的密碼）
在 /etc/profile 的末尾添加
PATH=$PATH:/usr/local/sonar-scanner-3.2.0.1227-macosx/bin
export PATH
存文件：wq! 
複製代碼

1的標註處，應爲你放包的地址。

4）source /etc/profile 運行更改

三、sonar使用

在項目中根目錄增長文件sonar-project.properties

a)projectKey 是惟一的

獲取projectKey的步驟

1）添加項目

2）根據步驟操做

最終獲得projectKey

b) cmd進入項目的根目錄執行 sonar-scanner

c) 結果查看

1）整體結果

2）結果列表

四、添加sonar的規則文件

1）用管理賬號登陸SonarQube平臺；

2）從質量配置菜單進入配置頁面；

3. 在最右邊點擊建立，建立一個新的配置；

4. 輸入規則名稱，選擇語言，點擊建立；

5）建立完成

6）進入質量配置，找到你選擇的語言

7）設置本身添件的規則文件，

8）能夠設置本身規則爲默認規則，去激活本身想要的規則

添加規則文件的另外一種方法：能夠直接複製已有規則

兩種添加規則文件的區別：

新的規則文件中會有複製那個規則文件裏的全部規則。
新建的方式獲取規則文件：新的規則文件是空的
複製代碼

說明：js，css等幾種語言只能在如今已有的規則中去激活你想要的規則，不能添加規則表中沒有的規則（目前本人沒有找到自定義規則方法），java等語言能經過上傳本身定義的規則文件進行自定義規則。
複製代碼

查看某種語言已有的規則：

在【代碼規則】中選擇【語言】能夠查看如今已有的規則列表中的全部規則：
複製代碼

最後

sonar不只可以提升代碼質量，瞭解編輯過程當中犯過的錯誤，讓代碼更有可讀性和維護性，還可以顯示應用程序的運行情況，突出顯示最新的問題，而且經過代碼質量檢查，您能夠修復泄漏，從而系統地提升代碼質量。

關於咱們

快狗打車前端團隊專一前端技術分享，按期推送高質量文章，歡迎關注點贊。