1 前言 良好的代碼習慣是一個優秀程式員應該具備的品質,但靠人的習慣與記憶來保證代碼質量,始終不是一件靠譜的事。在電腦行業應該深知,只要是人為的,都會有操作風險。本文講解如何通過 搭建代碼檢測平臺 ,並使用它來檢測 項目的代碼。 2 Docker安裝SonarQube 2.1 安裝 通過 安裝,方 ...
1 前言
良好的代碼習慣是一個優秀程式員應該具備的品質,但靠人的習慣與記憶來保證代碼質量,始終不是一件靠譜的事。在電腦行業應該深知,只要是人為的,都會有操作風險。本文講解如何通過Docker
搭建代碼檢測平臺SonarQube
,並使用它來檢測maven
項目的代碼。
2 Docker安裝SonarQube
2.1 安裝
通過Docker
安裝,方便快捷,不需要時直接刪掉容器和鏡像就好了。
# 拉取Sonar鏡像
docker pull sonarqube:8.3.1-community
# 運行實例
docker run --name sonarqube -p 9000:9000 -d sonarqube:8.3.1-community
接著訪問:http://localhost:9000/ 就可以了,預設管理員用戶和密碼為:admin/admin
。
這裡選擇免費的社區版Community
,另外還有Developer
、Enterprise
等收費版本,功能更強大,具體差別如下:
2.2 指定資料庫
一般我們會自己啟動一個資料庫如Oracle
、MySQL
或PostgreSQL
。相關係統信息可以在Administration-System
查看,我們不指定的話,預設是使用內嵌的H2
資料庫。如果要指定其它資料庫,啟動Docker時需要指定:
-e SONARQUBE_JDBC_USERNAME="xxx" \
-e SONARQUBE_JDBC_PASSWORD="***" \
-e SONARQUBE_JDBC_URL="jdbc:mysql://xxx"
使用H2
資料庫有會以下限制:
內嵌資料庫只能用於測試場景。內嵌資料庫無法擴展,也無法升級到新版本的SonarQube,並且不能支持將你的數據遷移至其他資料庫引擎。
所以建議實際使用時,不要使用內嵌的H2
資料庫。
2.3 進入容器
通過命令:
$ docker exec -it 容器ID bash
bash-5.0# ls
COPYING bin conf data elasticsearch extensions lib logs temp web
bash-5.0#
可以進入SonarQube
容器。在目錄/opt/sonarqube
可以查看配置文件、插件、數據文件和日誌文件等,實際使用應該映射到宿主機的目錄上,這樣重新啟動一個實例,數據和配置都還在。
2.4 安裝插件
SonarQube
提供了強大的插件管理功能,以中文語言包為示例,講解如何安裝插件:
Administration-Marketplace-Plugins
,在搜索框輸入Chinese
就可以選擇安裝了。
當狀態顯示為Install Pending
時,說明插件安裝完成,點擊Restart Server
即可生效。
3 通過maven檢測代碼
3.1 通過賬號密碼使用
指定SonarQube
平臺的地址,並指定用戶名和密碼,就能檢測代碼了,具體命令如下:
mvn clean verify sonar:sonar -Dsonar.host.url=http://localhost:9000 -Dsonar.login=admin -Dsonar.password=admin
3.2 通過Token令牌使用
當然,直接使用admin
並暴露密碼並不是一個好的習慣,可以通過配置-許可權-用戶
來創建用戶,並創建令牌。
複製令牌:9656c84090b2481db6ea97b6d14d87d546bff619
。
這樣,就可以通過令牌來操作了:
mvn clean verify sonar:sonar -Dsonar.host.url=http://localhost:9000 -Dsonar.login=9656c84090b2481db6ea97b6d14d87d546bff619
執行命令後,就會在界面上自動新建了一個項目,並給出檢測結果:
Sonar
提供了許多指標如測試覆蓋率、複雜度等,這能大大幫助我們寫出更好的代碼:
4 總結
SonarQube
功能強大,是DevOps
的重要工具之一,需要瞭解和掌握。
歡迎訪問南瓜慢說 www.pkslow.com獲取更多精彩文章!
歡迎關註微信公眾號<南瓜慢說>,將持續為你更新...
多讀書,多分享;多寫作,多整理。