SonarQube使用指南
一、介紹
- SonarQube是一個開源的代碼質量分析平台,便於管理代碼的質量,可檢查出項目代碼的漏洞和潛在的邏輯問題。同時,它提供了豐富的插件,支持多種語言的檢測。
2.主要的核心價值體現在如下幾個方面:
*檢查代碼是否遵循編程標准:如命名規范,編寫的規范等。
*檢查設計存在的潛在缺陷:SonarQube通過插件Findbugs、Checkstyle等工具檢測代碼存在的缺陷。
*檢測代碼的重復代碼量:SonarQube可以展示項目中存在大量復制粘貼的代碼。
*檢測代碼中注釋的程度:源碼注釋過多或者太少都不好,影響程序的可讀可理解性。
*檢測代碼中包、類之間的關系:分析類之間的關系是否合理,復雜度情況。
二、安裝指南
1.java環境准備
2.SonarQube安裝包,官網下載地址https://www.sonarqube.org/downloads/
3.MySql數據庫,新建一個數據庫sonardb create database sonardb;
4.SonarQube安裝目錄F:\sonarqube-7.5\conf\sonar.properties配置文件
5.執行F:\sonarqube-7.5\bin\windows-x86-64\StartSonar.bat,打開http://localhost:9000,如果顯示sonar主頁,則sonar安裝成功。
6.sonar-scanner安裝包,修改配置文件F:\sonar-scanner-3.0.3.778-windows\conf\sonar-scanner.properties
7.添加環境變量F:\sonar-scanner-3.0.3.778-windows\bin,執行sonar-scanner -h安裝成功顯示如下
三、執行代碼質量分析
1.代碼根目錄下新建配置文件sonar-project.properties
2.代碼跟目錄下執行sonar-scanner
4.打開http://localhost:9000/查看結果
四、SonarQube與jenkins集成實現自動化代碼檢查
1.jenkisn安裝插件,系統管理-插件管理-可選插件,搜索sonar,安裝如下插件
2.SonarQube Scanner配置,系統管理-全局工具配置
3.SonarQube servers配置,系統管理-系統設置
4.新建Jenkins工程,構建環境
5.構建步驟
6.執行構建,查看結果
五、SonarQube更多探討
有待學習...