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/

網上另兩篇相關的文章：http://www.cnblogs.com/gao241/p/3190701.html
                                       http://www.myexception.cn/open-source/1307345.html