1、准備好Java項目代碼
只要是java語言實現的項目均可。
比如,自動化測試的代碼,測試平台等均可以。
本次案例,使用java語言實現的測試平台來做為掃描對象。
2、了解java項目代碼的結構。
為什么要了解項目代碼結構呢?
1)區分出來,哪些是開發人員寫的代碼,哪些是引用的第三方包或配置文件等。
2)sonarQube主要是分析開發人員寫的代碼質量,對於外部的依賴庫這些全部都可以忽略掉。
經過與開發人員的溝通,上圖中的代碼當中,有如下說明:

3、在項目根目錄下,配置掃描數據。
3.1 在項目下:添加 sonar-project.properties 文件

3.2 copy以下內容到sonar-project.properties當中
# must be unique in a given SonarQube instance sonar.projectKey=my:project # --- optional properties --- # defaults to project key #sonar.projectName=My project # defaults to 'not provided' #sonar.projectVersion=1.0 # Path is relative to the sonar-project.properties file. Defaults to . #sonar.sources=. # Encoding of the source code. Default is default system encoding #sonar.sourceEncoding=UTF-8
3.3 配置sonar.projectKey
1、sonar.projectKey(必填): 的值為你的項目名稱,是會顯示在sonarQube管理平台上的。
要求在SonarQube當中,項目key名唯一。其它項目不能夠再取這個名字。
2、sonar.projectName:項目名稱。一般與key名一致。
3、sonar.sources: 項目下有多個目錄。可以指定要掃描的源碼目錄。
主要目的是掃描團隊當中開發人員編寫的代碼 。所以可以根據項目情況來指明。
4、sonar.sourceEncoding:指定源碼的編碼格式,一般都會去指定為UTF-8。
5、sonar.java.binaries(必填):指定java文件編譯后class文件目錄。
6、sonar.language:指定在掃描當中,只掃描的語言。

4、啟動掃描。
啟動方式:在項目的根目錄下,運行sonar-scanner命令

等待任務掃描完成。

在掃描任務完成之后,sonarQube需要將其掃描結果寫入數據庫,需要一定的時間。
掃描的代碼量越大,寫入數據庫的時間相對的也要長一點。
5、在sonarQube上查看掃描結果。
在sonar-scanner提示掃描完成之后,訪問sonarQube地址( http://localhost:9000/projects ),會看到有1個后台任務正在執行中。
等待sonarQube的后台任務處理完成,再去查看項目分析結果:








