SonarQube代碼質(zhì)量管理平臺(tái)安裝與使用

Sonar簡(jiǎn)介

Sonar是一個(gè)用于代碼質(zhì)量管理的開源平臺(tái)，用于管理源代碼的質(zhì)量，可以從七個(gè)維度檢測(cè)代碼質(zhì)量

通過(guò)插件形式，可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十幾種編程語(yǔ)言的代碼質(zhì)量管理與檢測(cè)

sonarQube能帶來(lái)什么？

Developers' Seven Deadly Sins
1.糟糕的復(fù)雜度分布
  文件、類、方法等，如果復(fù)雜度過(guò)高將難以改變，這會(huì)使得開發(fā)人員難以理解它們，

  且如果沒(méi)有自動(dòng)化的單元測(cè)試，對(duì)于程序中的任何組件的改變都將可能導(dǎo)致需要全面的回歸測(cè)試

2.重復(fù)
  顯然程序中包含大量復(fù)制粘貼的代碼是質(zhì)量低下的

  sonar可以展示源碼中重復(fù)嚴(yán)重的地方

3.缺乏單元測(cè)試

  sonar可以很方便地統(tǒng)計(jì)并展示單元測(cè)試覆蓋率

4.沒(méi)有代碼標(biāo)準(zhǔn)
  sonar可以通過(guò)PMD,CheckStyle,Findbugs等等代碼規(guī)則檢測(cè)工具規(guī)范代碼編寫
5.沒(méi)有足夠的或者過(guò)多的注釋
  沒(méi)有注釋將使代碼可讀性變差，特別是當(dāng)不可避免地出現(xiàn)人員變動(dòng)時(shí)，程序的可讀性將大幅下降
  而過(guò)多的注釋又會(huì)使得開發(fā)人員將精力過(guò)多地花費(fèi)在閱讀注釋上，亦違背初衷
6.潛在的bug

  sonar可以通過(guò)PMD,CheckStyle,Findbugs等等代碼規(guī)則檢測(cè)工具檢測(cè)出潛在的bug

7.糟糕的設(shè)計(jì)（原文Spaghetti Design，意大利面式設(shè)計(jì)）
  通過(guò)sonar可以找出循環(huán)，展示包與包、類與類之間的相互依賴關(guān)系
  可以檢測(cè)自定義的架構(gòu)規(guī)則
  通過(guò)sonar可以管理第三方的jar包
  可以利用LCOM4檢測(cè)單個(gè)任務(wù)規(guī)則的應(yīng)用情況
  檢測(cè)耦合

關(guān)于Spaghetti Design：http://docs.codehaus.org/display/SONAR/Spaghetti+Design

通過(guò)sonar可以有效檢測(cè)以上在程序開發(fā)過(guò)程中的七大問(wèn)題

SonarQube安裝

預(yù)置條件
1.已安裝Java環(huán)境
2.已安裝有MySQL數(shù)據(jù)庫(kù)

軟件下載地址：http://www.sonarqube.org/downloads/
下載SonarQube與SonarQube Runner
中文補(bǔ)丁包下載：http://docs.codehaus.org/display/SONAR/Chinese+Pack

1.數(shù)據(jù)庫(kù)配置
進(jìn)入數(shù)據(jù)庫(kù)命令
#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環(huán)境變量，并將SONAR_RUNNER_HOME加入PATH

修改sonar配置文件
編輯<install_directory>/conf/sonar.properties文件，配置數(shù)據(jù)庫(kù)設(shè)置，默認(rèn)已經(jīng)提供了各類數(shù)據(jù)庫(kù)的支持
這里使用mysql，因此取消mysql模塊的注釋
#vi sonar.properties

1. sonar.jdbc.username:                       sonar  

2. sonar.jdbc.password:                       sonar  

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

4.   

5. # Optional properties  

6. sonar.jdbc.driverClassName:                com.mysql.jdbc.Driver  

修改sonar-runner的配置文件
切換至sonar-runner的安裝目錄下，修改sonar-runner.properties
根據(jù)實(shí)際使用數(shù)據(jù)庫(kù)情況取消相應(yīng)注釋

1. #Configure here general information about the environment, such as SonarQube DB details for example  

2. #No information about specific project should appear here  

3. #----- Default SonarQube server  

4. sonar.host.url=http://localhost:9000  

5. #----- PostgreSQL  

6. #sonar.jdbc.url=jdbc:postgresql://localhost/sonar  

7. #----- MySQL  

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

9. #----- Oracle  

10. #sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE  

11. #----- Microsoft SQLServer  

12. #sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor  

13. #----- Global database settings  

14. sonar.jdbc.username=sonar  

15. sonar.jdbc.password=sonar  

16. #----- Default source code encoding  

17. sonar.sourceEncoding=UTF-8  

18. #----- Security (when 'sonar.forceAuthentication' is set to 'true')  

19. sonar.login=admin  

20. sonar.password=admin  

3.添加數(shù)據(jù)庫(kù)驅(qū)動(dòng)
除了Oracle數(shù)據(jù)庫(kù)外，其它數(shù)據(jù)庫(kù)驅(qū)動(dòng)都默認(rèn)已經(jīng)提供了，且這些已添加的驅(qū)動(dòng)是sonar唯一支持的，因此不需要修改
如果是Oracle數(shù)據(jù)庫(kù)，需要復(fù)制JDBC驅(qū)動(dòng)至<install_directory>/extensions/jdbc-driver/oracle目錄

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

至此，sonar就安裝好了
訪問(wèn)http:\\localhost:9000即可

5.sonar中文補(bǔ)丁包安裝
中文包安裝
安裝中文補(bǔ)丁包可以通過(guò)訪問(wèn)http:\\localhost:9000，打開sonar后，進(jìn)入更新中心安裝
或者下載中文補(bǔ)丁包后，放到SONARQUBE_HOME/extensions/plugins目錄，然后重啟SonarQube服務(wù)

sonar作為L(zhǎng)inux服務(wù)并開機(jī)自啟動(dòng)
新建文件/etc/init.d/sonar，輸入如下內(nèi)容：

1. #!/bin/sh  

2. #  

3. # rc file for SonarQube  

4. #  

5. # chkconfig: 345 96 10  

6. # description: SonarQube system (www.sonarsource.org)  

7. #  

8. ### BEGIN INIT INFO  

9. # Provides: sonar  

10. # Required-Start: $network  

11. # Required-Stop: $network  

12. # Default-Start: 3 4 5  

13. # Default-Stop: 0 1 2 6  

14. # Short-Description: SonarQube system (www.sonarsource.org)  

15. # Description: SonarQube system (www.sonarsource.org)  

16. ### END INIT INFO  

17.    

18. /usr/bin/sonar $*  

SonarQube開機(jī)自啟動(dòng)（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開機(jī)自啟動(dòng)（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分析源碼

預(yù)置條件
已安裝SonarQube Runner且環(huán)境變量已配置，即sonar-runner命令可在任意目錄下執(zhí)行

1.在項(xiàng)目源碼的根目錄下創(chuàng)建sonar-project.properties配置文件
以Android項(xiàng)目為例：

1. sonar.projectKey=android-sonarqube-runner  

2. sonar.projectName=Simple Android project analyzed with the SonarQube Runner  

3. sonar.projectVersion=1.0  

4. sonar.sources=src  

5. sonar.binaries=bin/classes  

6. sonar.language=java  

7. sonar.sourceEncoding=UTF-8  

8. sonar.profile=Android Lint  

注：要使用Android Lint
規(guī)則分析需要先訪問(wèn)http:\\localhost:9000更新中心添加Android Lint插件，使其可以分析Android Lint規(guī)則

2.執(zhí)行分析
切換到項(xiàng)目源碼根目錄，執(zhí)行命令
# sonar-runner
分析成功后訪問(wèn)http:\\localhost:9000即可查看分析結(jié)果

不同參數(shù)的意思：
http://docs.codehaus.org/display/SONAR/Analysis+Parameters
不同項(xiàng)目的源碼分析示例下載：
https://github.com/SonarSource/sonar-examples/zipball/master

與IDE關(guān)聯(lián)

最后，當(dāng)然了，得與IDE相關(guān)聯(lián)，才能更方便地實(shí)時(shí)查看

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

附：

sonarQube官網(wǎng)地址：http://www.sonarqube.org/
sonarQube官方文檔地址：http://docs.codehaus.org/display/SONAR/Documentation
sonarQube示例地址：http://nemo.sonarqube.org/

網(wǎng)上另兩篇相關(guān)的文章：http://www.cnblogs.com/gao241/p/3190701.html
                                       http://www.myexception.cn/open-source/1307345.html