2. 程式人生 > >sonar程式碼質量管理工具

sonar程式碼質量管理工具

阿新 • • 發佈：2019-02-05

[原文地址：http://blog.csdn.net/hunterno4/article/details/11687269]

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

  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
根據實際使用資料庫情況取消相應註釋
  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.新增資料庫驅動
除了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，輸入如下內容：

  1. #!/bin/sh  
  2. #  
  3. # rc file for SonarQube  
  4. #  
  5. # chkconfig: 3459610
  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: 345
  13. # Default-Stop: 0126
  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專案為例：

  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

相關推薦

sonar程式碼質量管理工具

[原文地址：http://blog.csdn.net/hunterno4/article/details/11687269] Sonar簡介 Sonar是一個用於程式碼質量管理的開源平臺，用於管理原始碼的質量，可以從七個維度檢測程式碼質量 通過外掛形式，可以支援包括

【程式碼質量管理工具】——sonar

   【前言】    bug越改越多，程式一換資料就崩，這就是目前我們系統的一個現狀。在這之前，進行過前後臺程式碼規範整理，程式碼判空等工作，但這是人工檢測的，有點慢，效率也比較低。當重新匯入資料之後

codereview(程式碼質量管理工具)

網上一堆亂七八糟的教程，看的我是頭暈眼花的，自己整一個 其實直接在idea工具中下載sonar也是可以的，不過只是對單個類檔案進行分析 (我趕腳安裝sonarqube和sonar-scanner僅僅為了web頁面統計展示以及專案分析) 1.先在idea中下載sonar外掛吧(過程比較

sonar程式碼質量檢測工具的配置和使用

背景：我們一直在重構，調整架構，但是一直不知道我們做的效果如何，也沒有辦法量化，所以需要引入一個工具和標準來量化我們的工作。 簡介：sonarqube是一個開源的，程式碼質量檢測的工具，我們可以使用它來檢測我們的程式碼。 如何安裝： 2.將安裝包解壓到指定目錄

【程式碼質量管理工具】--使用sonarLint提高程式碼質量

【背景】        專案組，在12月份的時候使用了強大的程式碼質量管理工具--Sonar來檢測規範我們的程式碼，但是當時使用的時候會有一個缺陷，就是我每使用一次maven命令將程式碼掃描到sona

SonarQube：開源的程式碼質量管理工具

SonarQube是一個開源的程式碼質量管理工具，如下圖所示，它覆蓋了程式碼質量的7個方面：SonarQube的主要特性：通過外掛擴充套件支援新的程式語言、新增規則引擎、計算更復雜的度量指標，這些都可以藉助強大的外掛擴充套件機制。目前已經有超過 50 個外掛可用。通過外掛機制

程式碼質量管理工具SonarQube詳解

SonarQube的目的是對軟體專案的程式碼進行分析，在開發人員提交程式碼之際就儘早發現程式碼的質量問題，並提示（或強制要求）開發人員改進。SonarQube由以下幾個部分組成：1. SonarQube Platform，就是SonarQube伺服器，這是SonarQube執

Sonar程式碼質量分析工具：sonar-runner 的專案配置檔案

以JAVA專案為例，在專案的根目錄下，要新建sonar-project.properties。其內容：#sonar-project.properties# Required metadatasonar.projectKey=nuodaoasonar.projectName=n

快速搭建sonar程式碼質量管理平臺

安裝 新增mysql驅動至\extensions\jdbc-driver\mysql\建立mysql資料庫和使用者：10.22.10.139 db:sonar 使用者名稱/密碼:sonar/sonar修改sonar.properties，註釋掉預設的資料庫配置，新增以下配

持續整合之整合Jenkins與程式碼質量管理平臺Sonar並實現構建失敗郵件通知

一：Sonar是什麼？Sonar 是一個用於程式碼質量管理的開放平臺，通過外掛機制，Sonar 可以整合不同的測試工具，程式碼分析工具，以及持續整合工具。與持續整合工具（例如 Hudson/Jenkins 等）不同，Sonar 並不是簡單地把不同的程式碼檢查工具結果（例如FindBugs，PMD等）直接顯示在

SonarQube程式碼質量管理平臺C++外掛sonar-cxx的安裝

SonarQube的問題，對於C/C++使用者來說，SonarQube的預設C/C++外掛CFamily是收費的，讓人絕望啊，一度讓我放棄了自己搭建SonarQube伺服器， 改為了使用Travis CI持續整合自己的專案，然後讓Travis CI轉SonarCloud來實現

iOS整合Sonar的詳細步驟, 業內經常說的是iOS程式碼質量管理

1. Sonar介紹     行業內提到"程式碼質量管理, 自動化質量管理", 一般指的都是通過Sonar來實現。本文的目標是實現在Sonar上顯示出iOS專案, 先看張最終的效果圖:     用Sonar能夠實現什麼?技術債務(sonar根據"規則"掃描出不符合規則的程式碼)覆蓋率(單元測試覆蓋率)重複(重

程式碼質量管理-Sonar 使用手冊

持續整合之程式碼質量管理-Sonar簡介Sonar是一個用於程式碼質量管理的開源平臺，用於管理Java原始碼的質量。通過外掛機制，Sonar 可以整合不同的測試工具，程式碼分析工具，以及持續整合工具，比如checkstyle、findbugs、Jenkins。通過不同的外掛對

使用 Sonar 進行程式碼質量管理

Sonar 是一個開源的程式碼質量管理平臺。通過外掛機制，Sonar 可以整合不同的測試工具，程式碼分析工具，以及持續整合工具（如Jenkins）。 Sonar 並不是簡單地把不同的程式碼檢查工具結果（例如 FindBugs，PMD 等）直接顯示在 Web

使用sonar進行java程式碼質量管理

前言 應公司要求，這一次的開發需要進行sonar進行靜態程式碼質量檢測。 接到這個任務的時候，我還並不知道sonar是什麼，但聽到靜態程式碼檢測幾個字的時候，我下意識的以為是類似checkstyle之類的工具，但是真正用過之後我發現我錯了。 我發現實際執行

使用sonar進行maven專案程式碼質量管理

 今天突然心血來潮想來搭建sonar檢測一下手上的專案程式碼質量， 首先當然是到sonar官網下載最新版本了， 地址在這 ：http://www.sonarqube.org/downloads/   ， 我下載的是SonarQube 4.0 ， 然後解壓， 進根目錄裡的bin

Git程式碼版本管理工具

Git Git 是分散式版本控制系統，原始碼管理工具。 作用：   方便協同開發、方便版本控制 分散式管理：伺服器和客戶端都有版本控制能力,都能進行程式碼的提交、合併、… Git會在根目錄下建立一個.git隱藏資料夾，作為原生代碼倉庫 Git伺服器 -

Jenkins 整合Sonar程式碼質量掃描

Jenkins上安裝外掛 在jenkins外掛安裝介面安裝： 外掛名 SonarQube Scanner for Jenkins Jenkins上配置 jenkins中操作：系統管理-系統設定，找到 SonarQube servers 部分，填寫如下 jenkins中操作：系統管理-全域性工具配置找

SonarQube+Scanners程式碼質量管理

簡介 sonaqube是一個開原始碼質量管理平臺，致力於持續分析和測量技術質量。 系統構成 SonarQube平臺由4部分組成： SonarQube伺服器 Web伺服器的開發者，管理者，瀏覽質量快照和配置SonarQube例項 基於Elasticsearch搜尋

基於docker搭建sonar程式碼質量檢測平臺

最近有點忙，好久不寫博文了，今天聽一個同事說之前他們的程式碼review都是人工來弄的，這多累，於是我趕緊搭建一個sonar程式碼質量檢測平臺給大家用用 docker環境搭建什麼的就不說了。網上很多，直接上核心命令 第一條是docker 執行一個pgsql 第二條是docker 執行一個sonar