SonarQub e 與 J enkin s 簡 介
SonarQub e 是 一個開源的程式碼質量分析平臺，便於管理程式碼的質量，可檢查出專案程式碼的漏洞和潛在的邏輯問題。同時，它提供了豐富的外掛，支援多種語言的檢測， 如 J ava、Python、Groovy、C、C++等幾十種程式語言的檢測。它主要的核心價值體現在如下幾個方面：
- 檢查程式碼是否遵循程式設計標準：如命名規範，編寫的規範等。
- 檢查設計存在的潛在缺陷：SonarQub e 通 過插 件 F indbugs、Checkstyl e 等 工具檢測程式碼存在的缺陷。
- 檢測程式碼的重複程式碼量：SonarQub e 可 以展示專案中存在大量複製貼上的程式碼。
- 檢測程式碼中註釋的程度：原始碼註釋過多或者太少都不好，影響程式的可讀可理解性。
- 檢測程式碼中包、類之間的關係：分析類之間的關係是否合理，複雜度情況。
SonarQub e 平 臺是 由 4 個 部分組成:
- SonarQube Server
- SonarQube Database
- SonarQube Plugins
- SonarQube Scanner
SonarQube 與 SonarQube-Scanner 的安裝與配置
SonarQube
在 S onarQub e 官 網，我們可以下載最新 的 S ona r 安 裝包，本節 以 L inu x 系 統為例，搭 建 S onarQub e 平 臺，解壓到任意目錄,如：unzip sonarqube5.6.zip。
SonarQub e 自帶了一個 H2 的資料庫，當然為了獲得更好的效能我們可以指定一個外部的資料庫，在這裡我們使用 MySQL 資料庫。 先 在 M ysq l 數 據庫中建立一 個 S ona r 數 據庫，主要用於存放分析結果的資料，如 圖 1 ：
進入解壓 的 S onarQue b 目 錄，在系統路徑裡面配 好 p ath，配置如下：
| 1 2 3 4 5 |
#sonar profile
export
SONAR_HOME=/usr/local/sonarqube-5.6.1
export
PATH=${SONAR_HOME}/bin:${PATH}
|
並修改配置文 件 s onar.properties，如下：
| 1 2 3 4 5 6 7 |
# sonar.jdbc.username=root
#sonar.jdbc.password=root
#sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?
useUnicode=true&characterEncoding=
utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
#option properties
sonar.jdbc.driverClassName:com.mysql.jdbc.Driver
|
基本配置完成，在命令列啟 動 S onarQube：進 入 S onarQub e 安 裝目錄，進 入 b i n 目 錄，執行 ./sonar.sh start， 打 開 h ttp://localhost:9000，如果顯 示 S onarQub e 主 頁， 則 S onarQub e 安 裝成功。如 圖 2。
如果需要關 閉 S onarQube，則執行 ./sonar.sh stop
如果需要重 啟 S onarQube，則執行 ./sonar.sh restart
SonarQube Scanner
下 載 S onar-Scanner-2.6.1，解壓到目錄(可解壓到任意目錄)。修改系統路 徑 p ath，如下：
| 1 2 3 4 5 |
#sonar-scanner profile
export
SONAR_SCANNER_HOME=/usr/local/sonar-scanner-2.6.1
export
PATH=${SONAR_SCANNER_HOME}/bin:${PATH}
|
修 改 c on f 目 錄的配置文 件 s onar-scanner.properties，具體如下：
sonar.jdbc.username=root
sonar.jdbc.password=root
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode
=true&characterEncoding=utf8&rewriteBatchedStatements=true&
useConfigs=maxPerformance
sonar.sourceEncoding=UTF-8
sonar.login=admin
sonar.password=admin
在命令列中執行 sonar-runner -h 檢視是否安裝成功。
在 Jenkins 專案中使用構建後步驟進行程式碼分析
在 Jenkins 專案構建過程中加入 SonarScanner 進行程式碼分析
配置 SonarQube Scanner 構建步驟，在 Task to run 輸入框中輸入 scan，即分析程式碼；在 JDK 選擇框中選擇 SonarQube Scanner 使用的 JDK（注意這裡必須是 JDK 不能是 JRE）；Path to project properties 是可選擇的輸入框，這裡可以指定一個 sonar-project.properties 檔案，如果不指定的話會使用專案預設的 properties 檔案；Analysis properties 輸入框，這裡需要輸入一些配置引數用來傳遞給 SonarQube，這裡的引數優先順序高於 sonar-project.properties 檔案裡面的引數，所以可以在這裡來配置所有的引數以替代 sonar-project.properties 檔案，下面列出了一些引數，sonar.language 指定了要分析的開發語言（特定的開發語言對應了特定的規則），sonar.sources 定義了需要分析的原始碼位置（示例中的$WORKSPACE 所指示的是當前 Jenkins 專案的目錄），sonar.java.binaries 定義了需要分析程式碼的編譯後 class 檔案位置；Additional arguments 輸入框中可以輸入一些附加的引數，示例中的-X 意思是進入 SonarQube Scanner 的 Debug 模式，這樣會輸出更多的日誌資訊；JVM Options 可以輸入在執行 SonarQube Scanner 是需要的 JVM 引數。
sonar.projectName=testSonar
sonar.projectVersion=1.0
sonar.language=java
sonar.java.binaries=$WORKSPACE/testSonar/target/test-classes/
sonar.sources=$WORKSPACE/testSonar/src
檢視分析結果
在新建的 Jenkins 專案的構建的 Console Output 中可以得到 SonarQube 分析結果的連結