SonarQube使用教程


SonarQube是管理代碼質量一個開放平台,可以快速的定位代碼中潛在的或者明顯的錯誤,下面將會介紹一下這個工具的安裝、配置以及使用。
 
一、安裝篇
1.下載好sonarqube后,解壓打開bin目錄,啟動相應OS目錄下的StartSonar。如本文演示使用的是win的64位系統,則打開D:\sonar\sonarqube-5.3\sonarqube-5.3\bin\windows-x86-64\StartSonar.bat
 
2.啟動瀏覽器,訪問http://localhost:9000,如出現下圖則表示安裝成功。
 
二、配置篇
1.打開mysql,新建一個數據庫。
2.打開sonarqube安裝目錄下的D:\sonar\sonarqube-5.3\sonarqube-5.3\conf\sonar.properties文件
3.在mysql5.X節點下輸入以下信息
sonar.jdbc.url=jdbc:mysql: //192.168.10.10:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance sonar.jdbc.username=dev sonar.jdbc.password=123456 sonar.sorceEncoding=UTF-8 sonar.login=admin sonar.password=admin
 
其中: url是數據庫連接地址,username是數據庫用戶名,jdbc.password是數據庫密碼,login是sonarqube的登錄名,sonar.password是sonarqube的密碼
4.重啟sonarqube服務,再次訪問http://localhost:9000,會稍微有點慢,因為要初始化數據庫信息,重啟時候有可能一直卡在那里,重啟服務不生效,這時候可以重啟電腦,然后再次訪問http://localhost:9000,會發現配置生效。
5.數據庫初始化成功后,登錄
6.按照下圖的點擊順序,進入插件安裝頁面,搜索框搜索chinese,選擇中文包,安裝中文插件,安裝之后,會自動提醒重啟服務,點擊重啟,重啟完之后,刷新,就看到中文版的頁面
 
7.在Maven的settings.xml設置sonar信息
其中<sonar.host.url>http://localhost:9000</sonar.host.url>指明了sonar服務器的地址。所以在執行maven命令的時候,<sonar.host.url>指明的服務器必須已運行起來。
 
${MAVEN_HOME}/conf/settings.xml:
<profiles>
    <profile>
<id>sonar</id>
        <properties>
            <sonar.jdbc.url>jdbc:mysql://192.168.10.10:3306/sonar</sonar.jdbc.url>
            <sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
            <sonar.jdbc.username>dev</sonar.jdbc.username>
            <sonar.jdbc.password>123456</sonar.jdbc.password>
            <sonar.host.url>http://localhost:9000</sonar.host.url> <!-- Sonar服務器訪問地址 -->
        </properties>
    </profile>
</profiles>
<activeProfiles>
    <activeProfile>sonar</activeProfile>
</activeProfiles>
 
三、執行篇
1.執行mvn sonar:sonar命令進行代碼分析。
我們可以在Eclipse中,對一個標准maven工程執行sonar。說明:由於maven對sonar有很好的支持,會自動執行相應的腳本,所以無需在pom中添加sonar說明。
在執行maven進行sonar分析之前,必須確保sonar服務器已經處於運行狀態。本例中sonar服務器運行在localhost:9000上。
 
首先,執行sonar:sonar命令,最后得到輸出如下輸出。如果輸出”BUILD SUCCESS“說明已經構建成功。
查看分析結果
對於使用sonar自帶服務器來說,在瀏覽器訪問:http://sonar_ip:9000,打開sonar結果頁面。可使用admin/admin賬號登錄進入,可以查看到相關信息
 
三、升級篇
1)sonar和scanner配合使用
1.sonar和scanner配合使用,測試人員不用安裝java開發環境即可完成代碼的分析,scanner下載地址:https://akamai.bintray.com/5c/5cc23ee0cb8e8b09793eef05cfb1b091ee05265e275a89846e476e630e087e05?__gda__=exp=1533549597~hmac=3e1003b56de521e52548dc07ab349a98381a4fc114080fe39b86bb6f7c91edde&response-content-disposition=attachment%3Bfilename%3D%22sonar-scanner-cli-3.2.0.1227-windows.zip%22&response-content-type=application%2Fzip&requestInfo=U2FsdGVkX18KaX8hf3WAMXb08UHk93sEBM5q05tIJwXpQQFDfBsdsVeOkfV6L4llrn1fUs_wj3CTm597aERFIpQzXUVWk-e1gmCsHt1tdpBxK_-FJv7j2AZ9ANdC4TAX3odWRyym4bBYtcT1NhiDY65anr46174ohQisBwi5mH4yc_BiCSsNY0kja1pM2wPZqhEtKu5eWeBN7iKJk-FwFF5HsY4E9XLmZ4KlQhEzd0E&response-X-Checksum-Sha1=4e5de3df905ab76a8a98d859a9879b214f1d8b09&response-X-Checksum-Sha2=5cc23ee0cb8e8b09793eef05cfb1b091ee05265e275a89846e476e630e087e05
 
2.解壓,放到和sonarqube並列路徑下,修改配置文件:
 
配置文件示例:
sonar.jdbc.url=jdbc:mysql://192.168.10.10:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=dev
sonar.jdbc.password=123456
 
3.配置系統變量:增加變量SONAR_SCANNER_HOME,然后在path中增加變量值,完成系統變量的配置
 
4.測試變量是否成功,打開cmd,輸入sonar-scanner -version,顯示如下內容,表示配置成功
5.新增一個文件sonar-project.properties,配置內容如下
# must be unique in a given SonarQube instance
sonar.projectKey=CRM
# this is the name displayed in the SonarQube UI
sonar.projectName=CRM
sonar.projectVersion=1.0
 
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# Since SonarQube 4.2, this property is optional if sonar.modules is set.
# If not set, SonarQube starts looking for source code from the directory containing
# the sonar-project.properties file.
sonar.sources=.
sonar.language=java
sonar.java.binaries=./target/classes
 
# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8
 
其中projectkey和projectName根據項目進行修改。
6.把建立好的文件放到項目根目錄下
然后在該目錄下打開命令運行窗口,執行sonar-scanner命令,分析成功之后,會顯示如下內容:
7.打開sonar項目,則可以查看到剛剛分析的項目
 
2)jenkins集成sonar
1.在jenkins安裝scanner插件:SonarQube Scanner for Jenkins
2.安裝完成后,在 系統管理->系統設置中,找到SonarQube servers模塊,填寫服務器信息
3.執行代碼分析,新增一個構建步驟,選擇Execute SonarQube Scanner,選擇你的jdk版本,若沒有,請在全局工具配置中配置好jdk位置。再選擇好sonarqube scanner的版本。
之后,在Analysis properties處,輸入sonar的檢查參數
完成配置。

如果想了解更多的關於軟件的使用方法,請查看我的另外一篇文章: https://www.cnblogs.com/shuideqing/articles/11925233.html
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM