介紹
代碼質量管理的開源平台,用於管理源代碼的質量 通過插件形式,可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十幾種編程語言的代碼質量管理與檢測。集成了CheckStyle,PMD,Findbugs等工具校驗規則,具有重復代碼發現,代碼測試覆蓋率,代碼注釋率,及所有的檢測率變化追蹤的功能特性。
特點
SonarQube:開源的代碼質量管控平台,我們使用的http://localhost:9000即為SonarQube。
SonarLint:一個擴展插件,可以安裝在idea與eclipse等開發工具中
Eclipse中的使用
1、 安裝
help -> eclipse marketplace...,搜索sonarlint, Install。
2、 使用
打開java文件,soanrlint會自動進行檢測,對於不規范或有問題的代碼會在下方划藍色波浪線,如圖:
鼠標放在藍色部分會有彈框顯示錯誤信息或建議修改信息
點擊“open description of rule”可以查看具體的錯誤描述,錯誤示例及修改示例。
在項目或單個java文件上右鍵 -> sonarlint -> Analyze 進行手動操作分析。這樣SonarLint Report面板中查看所有的異常信息
3、Server
連接SonarQube的主要目的是同步分析規則、質量規則與自定義設置。操作如下:
從Window -> show view 中找到SonarLint Bindings打開;
在該面板空白處 右鍵創建 server連接,選擇SonarQube
使用UserName+Password或者token登陸
沒有token可以點擊右側按鈕創建,或者尋找管理員創建
配置名稱
完成服務配置
綁定工程,點擊add
輸入sonarQube中創建的工程的名稱
完成
4、 結果同步SonarQube顯示
在maven的settings.xml中配置如下:
配置完成后,使用soanr:sonar命令運行項目,此部分要求JDK為1.8。clean install sonar:sonar
可以打開http://localhost:9000/dashboard?id=com.xxx查看對應的錯誤信息,也可以在SonarQube點擊Issues進行查看
IDEA中使用
1、 安裝
File -> settings -> plugins 搜索sonarLint,Install。
2、 使用
在左下角點擊隱藏面板,可以看到sonarLint,打開
打開java文件,soanrlint會自動進行檢測,對於不規范或有問題的代碼會添加暗金色的背景色,鼠標放上去會有如圖提示:
也可以通過點擊上圖的綠色倒三角手動執行分析。
3、 Server
連接SonarQube的主要目的是同步分析規則、質量規則與自定義設置。操作如下:
從File -> settings -> OtherSettings中找到“SonarLint General Settings”打開;
點擊加號,輸入一個name,如localhost;選擇SonarQube,Url為http://localhost9000;
選擇Login/Password或者token,輸入賬號與密碼或者token;
finish
勾選“Enable binding to remote SonarQube Server”,選擇添加的server,搜索到你需要綁定的項目,然后選擇確認。
4、結果同步SonarQube顯示
同Eclipse部分,此部分要求JDK為1.8。