天天看點
傳回

Sonar簡介

Sonar簡介

Sonar是一個用于代碼品質管理的開源平台，用于管理源代碼的品質，可以從七個次元檢測代碼品質

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

sonarQube能帶來什麼？

Developers' Seven Deadly Sins

1.糟糕的複雜度分布

  檔案、類、方法等，如果複雜度過高将難以改變，這會使得開發人員難以了解它們，

  且如果沒有自動化的單元測試，對于程式中的任何元件的改變都将可能導緻需要全面的回歸測試

Sonar簡介

2.重複

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

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

Sonar簡介

3.缺乏單元測試

  sonar可以很友善地統計并展示單元測試覆寫率

Sonar簡介

4.沒有代碼标準

  sonar可以通過PMD,CheckStyle,Findbugs等等代碼規則檢測工具規範代碼編寫

5.沒有足夠的或者過多的注釋

  沒有注釋将使代碼可讀性變差，特别是當不可避免地出現人員變動時，程式的可讀性将大幅下降

  而過多的注釋又會使得開發人員将精力過多地花費在閱讀注釋上，亦違背初衷

6.潛在的bug

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

Sonar簡介

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

[java]  view plain  copy

  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. # Optional properties  
  5. sonar.jdbc.driverClassName:                com.mysql.jdbc.Driver  

修改sonar-runner的配置檔案

切換至sonar-runner的安裝目錄下，修改sonar-runner.properties

根據實際使用資料庫情況取消相應注釋

[java]  view plain  copy

  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. #----- <a href="http://lib.csdn.net/base/oracle" class='replace_word' title="Oracle知識庫" target='_blank' style='color:#df3434; font-weight:bold;'>Oracle</a>  
  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.添加資料庫驅動

除了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，輸入如下内容：

[java]  view plain  copy

  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. /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項目為例：

[java]  view plain  copy

  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

規則分析需要先通路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

規範化 Java核心 代碼品質 sonar sonarqube
上一篇: 用PHPExcel導出的個人總結
下一篇: 凸優化--對偶問題 for SVM

繼續閱讀