SonarQube代碼品質管理平台安裝與使用

SonarQube代碼品質管理平台安裝與使用

Sonar簡介

Sonar是一個用於代碼品質管理的開源平台，用於管理原始碼的品質，可以從七個維度檢測代碼品質

通過外掛程式形式，可以支援包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十幾種程式設計語言的代碼品質管理與檢測

sonarQube能帶來什嗎？

Developers' Seven Deadly Sins
1.糟糕的複雜度分布
檔案、類、方法等，如果複雜度過高將難以改變，這會使得開發人員難以理解它們，且如果沒有自動化的單元測試，對於程式中的任何組件的改變都將可能導致需要全面的迴歸測試

2.重複
顯然程式中包含大量複製粘貼的代碼是品質低下的

sonar可以展示源碼中重複嚴重的地方

3.缺乏單元測試

  sonar可以很方便地統計並展示單元測試覆蓋率

4.沒有代碼標準
  sonar可以通過PMD,CheckStyle,Findbugs等等代碼規則偵查工具規範代碼編寫
5.沒有足夠的或者過多的注釋
  沒有注釋將使代碼可讀性變差，特別是當不可避免地出現人員變動時，程式的可讀性將大幅下降
  而過多的注釋又會使得開發人員將精力過多地花費在閱讀注釋上，亦違背初衷
6.潛在的bug

  sonar可以通過PMD,CheckStyle,Findbugs等等代碼規則偵查工具檢測出潛在的bug

7.糟糕的設計（原文Spaghetti Design，意大利麵式設計）
  通過sonar可以找出迴圈，展示包與包、類與類之間的相互依賴關係
  可以檢測自訂的架構規則
  通過sonar可以管理第三方的jar包
  可以利用LCOM4檢測單個任務規則的應用情況
  檢測耦合

關於Spaghetti Design：http://docs.codehaus.org/display/SONAR/Spaghetti+Design

通過sonar可以有效檢測以上在程式開發過程中的七大問題

 

SonarQube安裝

預置條件
1.已安裝JAVA環境
2.已安裝有MySQL資料庫

軟體：http://www.sonarqube.org/downloads/
下載SonarQube與SonarQube Runner
中文補丁包下載：http://docs.codehaus.org/display/SONAR/Chinese+Pack

1.資料庫配置
進入資料庫命令
#mysql -u root -p

mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
mysql> FLUSH PRIVILEGES;

2.安裝sonar與sonar-runner
將下載的sonar-3.7.zip包解壓至Linux某路徑如/usr/local
將下載的sonar-runner-dist-2.3.zip包解壓某路徑/usr/local
添加SONAR_HOME、SONAR_RUNNER_HOME環境變數，並將SONAR_RUNNER_HOME加入PATH

修改sonar設定檔
編輯<install_directory>/conf/sonar.properties檔案，設定資料庫設定，預設已經提供了各類資料庫的支援
這裡使用mysql，因此取消mysql模組的注釋
#vi sonar.properties

sonar.jdbc.username:                      sonar
sonar.jdbc.password:                      sonar
sonar.jdbc.url:                            jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true

# Optional properties
sonar.jdbc.driverClassName:                com.mysql.jdbc.Driver

修改sonar-runner的設定檔
切換至sonar-runner的安裝目錄下，修改sonar-runner.properties
根據實際使用資料庫情況取消相應注釋

#Configure here general information about the environment, such as SonarQube DB details for example
#No information about specific project should appear here
#----- Default SonarQube server
sonar.host.url=http://localhost:9000
#----- PostgreSQL
#sonar.jdbc.url=jdbc:postgresql://localhost/sonar
#----- MySQL
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
#----- Oracle
#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE
#----- Microsoft SQLServer
#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor
#----- Global database settings
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
#----- Default source code encoding
sonar.sourceEncoding=UTF-8
#----- Security (when 'sonar.forceAuthentication' is set to 'true')
sonar.login=admin
sonar.password=admin

 

3.添加資料庫驅動
除了Oracle資料庫外，其它資料庫驅動都預設已經提供了，且這些已添加的驅動是sonar唯一支援的，因此不需要修改
如果是Oracle資料庫，需要複製JDBC驅動至<install_directory>/extensions/jdbc-driver/oracle目錄

4.啟動服務
目錄切換至sonar的<install_directory>/bin/linux-x86-64/目錄，啟動服務
#./sonar.sh start  啟動服務
#./sonar.sh stop    停止服務
#./sonar.sh restart 重啟服務

至此，sonar就安裝好了
訪問http:\\localhost:9000即可

5.sonar中文補丁包安裝
中文包安裝
安裝中文補丁包可以通過訪問http:\\localhost:9000，開啟sonar後，進入更新中心安裝
或者下載中文補丁包後，放到SONARQUBE_HOME/extensions/plugins目錄，然後重啟SonarQube服務

sonar作為Linux服務並開機自啟動
建立檔案/etc/init.d/sonar，輸入如下內容：

#!/bin/sh
#
# rc file for SonarQube
#
# chkconfig: 345 96 10
# description: SonarQube system (www.sonarsource.org)
#
### BEGIN INIT INFO
# Provides: sonar
# Required-Start: $network
# Required-Stop: $network
# Default-Start: 3 4 5
# Default-Stop: 0 1 2 6
# Short-Description: SonarQube system (www.sonarsource.org)
# Description: SonarQube system (www.sonarsource.org)
### END INIT INFO
 
/usr/bin/sonar $*

 SonarQube開機自啟動（Ubuntu, 32位）：

sudo ln -s $SONAR_HOME/bin/linux-x86-32/sonar.sh /usr/bin/sonar
sudo chmod 755 /etc/init.d/sonar
sudo update-rc.d sonar defaults

SonarQube開機自啟動（RedHat, CentOS, 64位）：

sudo ln -s $SONAR_HOME/bin/linux-x86-64/sonar.sh /usr/bin/sonar
sudo chmod 755 /etc/init.d/sonar
sudo chkconfig --add sonar

使用SonarQube Runner分析源碼

預置條件
已安裝SonarQube Runner且環境變數已配置，即sonar-runner命令可在任意目錄下執行

1.在項目源碼的根目錄下建立sonar-project.properties設定檔
以Android項目為例：

sonar.projectKey=android-sonarqube-runner
sonar.projectName=Simple Android project analyzed with the SonarQube Runner
sonar.projectVersion=1.0
sonar.sources=src
sonar.binaries=bin/classes
sonar.language=java
sonar.sourceEncoding=UTF-8
sonar.profile=Android Lint

註：要使用Android Lint
規則分析需要先訪問http:\\localhost:9000更新中心添加Android Lint外掛程式，使其可以分析Android Lint規則

2.執行分析
切換到項目源碼根目錄，執行命令
# sonar-runner
分析成功後訪問http:\\localhost:9000即可查看分析結果

不同參數的意思：
http://docs.codehaus.org/display/SONAR/Analysis+Parameters
不同項目的源碼分析樣本下載：
https://github.com/SonarSource/sonar-examples/zipball/master

與IDE關聯

最後，當然了，得與IDE相關聯，才能更方便地即時查看

以Eclipse為例，請見：http://docs.sonarqube.org/display/SONAR/SonarQube+in+Eclipse

附：

sonarQube官網地址：http://www.sonarqube.org/
sonarQube官方文檔地址：http://docs.codehaus.org/display/SONAR/Documentation
sonarQube樣本地址：http://nemo.sonarqube.org/

另兩篇相關的文章：

配置Sonar、Jenkins進行持續審查

sonarQube代碼品質管理工具環境籌建筆記

Sonar 的詳細介紹：請點這裡
Sonar 的：請點這裡

本文永久更新連結地址：