代碼檢查工具sonarqube介紹及使用

親測有效

環境：springboot+gradle+jdk1.8+sonarqube7.4

1、說明：

SonarQube爲靜態代碼檢查工具，採用B/S架構，幫助檢查代碼缺陷，改善代碼質量，提升開發速度，經過插件形式，能夠支持Java、C、C++、JavaScripe等等二十幾種編程語言的代碼質量管理與檢測。

經過客戶端插件分析源代碼，sonar客戶端能夠採用IDE插件、Sonar-Scanner插件、Ant插件和Maven插件方式等，官網是這麼列舉的很方便集成：

• Gradle - 用於Gradle的SonarScanner
• MSBuild - 用於MSBuild的SonarScanner
• Maven - 使用SonarScanner for Maven
• Jenkins - Jenkins的SonarScanner
• Azure DevOps - Azure DevOps的SonarQube擴展
• Ant - 用於Ant的SonarScanner
• 其餘任何東西（CLI） - SonarScanner

每一種都有本身的分析機制對項目源代碼進行分析和掃描，並把分析掃描後的結果上傳到sonar的數據庫，經過sonar web界面對分析結果進行查看管理

架構圖

 

下載sonarqube包：https://www.sonarqube.org/。如今下載使用的是7.4。下載後是zip格式，linux下和windows下都是這個包，解壓便可。

下載sonarqube中文包：地址：https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases，根據對應的版本，下載對應的sonar-l10n-zh-plugin-***.jar包，下載下來後，把jar放到sonarqube-7.4/extensions/plugins目錄下，

2、配置

配置文件爲/conf/sonar.properties。能夠設置使用的數據庫和提供的ip和端口。使用postgresql數據庫須要注意不能指定模式名稱，必須使用默認的default。若是不使用須要按照文檔作更多配置來支持。如今配置以下便可

sonar.jdbc.url=jdbc:postgresql://192.169.31.106:5432/sonar

sonar.jdbc.username=postgres

sonar.jdbc.password=123456

sonar.web.host=192.169.31.107

sonar.web.port=9000

數據庫能夠不進行配置，若不配置則使用自帶數據庫，不支持數據遷移。Ip爲部署機器的ip

3、啓動

Windows下：在sonarqube-7.4/bin目錄下，根據對應的系統版本，選擇對應的文件夾，個人是windows 64位，故選擇windows-x86-64目錄，打開文件StartSonar.bat ，

Linux下：

一、      建立新用戶：adduser sonarUser

二、      改變權限：、chown -R sonarUser:sonarUser  /usr/local/sonarqube-7.4/

三、      切換至普通用戶下，進入bin/linux64啓動下：./sonar.sh console  日誌啓動模式；./sonar.sh start 後臺啓動模式；第一次啓動可使用日誌模式查看下是否能成功啓動，若沒有問題，停掉後再切換爲後臺啓動

四、      若是啓動出錯能夠查看下/sonarqube-7.4/temp/conf/es的權限是改變了，若是沒有改變則從新執行chown -R sonarUser:sonarUser  /usr/local/sonarqube-7.4/對應目錄

4、gradle集成：

Build.gradle中配置：

plugins {

  id "org.sonarqube" version "2.6.2"

}

{buildscript

{  repositories

{    maven

"https://plugins.gradle.org/m2/"      url

}   

} 

{  dependencies

"org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.6.2"    classpath

} 

}

:"org.sonarqube"apply plugin

在build.gradle平級目錄新建gradle.properties配置文件。內容爲systemProp.sonar.host.url=http://172.16.31.107:9000。次配置是爲了將掃描代碼結果傳送給sonar服務。

在gradle命令行輸入：gradle sonarqube便可進行掃描。

5、打開瀏覽器輸入192.169.31.107:9000訪問掃描結果。