SonarQube 的簡介、安裝、配置

前期準備:

  • SonarQube 簡介
  • 環境準備
  • 軟件準備
  • 安裝配置
  • 漢化插件安裝

話不多說,開始

SonarQube 簡介

SonarQube是一個用於管理代碼質量的開放平臺,可以快速的定位代碼中潛在的或者明顯的錯誤。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十幾種編程語言的代碼質量管理與檢測。

SonarQube特性

  • 持續檢查

    • 項目整體的健康程度:項目的主頁面會給出,項目整體的Bugs、Vulnerabilities、Code Smells
    • 專注於漏洞
  • 監測棘手的問題

  • 多語言支持

  • 集成DevOps(evOps 是一個完整的面向IT運維的工作流,以 IT 自動化以及持續集成(CI)、持續部署(CD)爲基礎,來優化程式開發、測試、系統運維等所有環節)

  • 集中質量

七個維度檢測代碼質量

  • 複雜度分佈(complexity):代碼複雜度過高將難以理解
  • 重複代碼(duplications):程序中包含大量複製、粘貼的代碼而導致代碼臃腫,sonar可以展示源碼中重複嚴重的地方
  • 單元測試統計(unit tests):統計並展示單元測試覆蓋率
  • 代碼規則檢查(coding rules):通過Findbugs,PMD,CheckStyle等檢查代碼是否符合規範
  • 註釋率(comments):若代碼註釋過少,特別是人員變動後,其他人接手比較難接手;若過多,又不利於閱讀
  • 潛在的Bug(potential bugs):通過Findbugs,PMD,CheckStyle等檢測潛在的bug
  • 結構與設計(architecture & design):找出循環,展示包與包、類與類之間的依賴、檢查程序之間耦合度

SonarQube安裝:

下載地址:https://www.sonarqube.org/downloads/

在這裏插入圖片描述
下載完成後,解壓縮直接可以使用,打開bin目錄下對應OS的StartSonar.bat,例如本人的電腦是windows64位
在這裏插入圖片描述
瀏覽器中打開:http://localhost:9000,可以進入web界面

至此安裝成功:

SonarQube配置:
SonarQube工具需要數據庫的支持,Scanner掃描項目時,會將分析結果存入數據庫,web頁面生成報告時會讀取數據庫的數據
目前支持Oracle、MySQL、PostgreSQL、MS SQL,數據庫版本以及要求
具體可參考:https://docs.sonarqube.org/latest/requirements/requirements/

  1. 建立數據庫:
    建立Mysql數據庫sonar
    MySQL數據庫必須是InnoDB存儲引擎,不支持MyISAM
  2. 配置 sonar.properties
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar7?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false  #數據庫連接地址
sonar.jdbc.username=root  #數據庫賬號
sonar.jdbc.password=123456 #數據庫密碼
sonar.sorceEncoding=UTF-8
sonar.login=admin #web頁面註冊的賬號
sonar.password=admin #web頁面註冊的密碼

配置完成後,重新啓動StartSonar.bat, 如果啓動不成功,可以結束Java™ Platform SE binary

啓動成功:
1)cmd命令行sonarqube is up
2)localhost:9000 可以打開
3)數據庫中,生成了十幾張表

SonarQube使用
使用SonarQube需要插件SonarQube Scanner
下載地址:https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/

下載完成後,配置conf文件夾下的sonar-scanner.properties

sonar.host.url=http://localhost:9000
sonar.sourceEncoding=UTF-8

配置安裝目錄配置環境變量
新建變量:SONAR_SCANNER_HOME=G:\develop\sonarqube-7.4\sonar-scanner-3.2.0.1227-windows
編輯path:新增%SONAR_SCANNER_HOME%\bin;
命令行cd到目錄執行sonar-scanner -h,可以正常返回相關信息即安裝成功

SonarQube項目配置
進入待檢測的項目目錄中,新建sonar-project.properties,增加以下內容:

sonar.projectKey=my:project
sonar.projectName=My project
sonar.projectVersion=1.0 
sonar.sources=.
sonar.sourceEncoding=UTF-8

打開命令行窗口,切換目錄到項目目錄,輸入sonar-scanner

運行成功後,打開web界面,即可看到對當前項目的分析

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章