一.SonarQube简介
SonarQube 是一款用于代码质量管理的开源工具,它主要用于管理源代码的质量。 通过插件形式,可以支持众多计算机语言,比如 java, C#, go,C/C++, PL/SQL, Cobol, JavaScrip, Groovy 等。sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具来检测你的代码,帮助你发现代码的漏洞,Bug,异味等信息。
Sonar 不仅提供了对 IDE 的支持,可以在 Eclipse和 IntelliJ IDEA 这些工具里联机查看结果;同时 Sonar 还对大量的持续集成工具提供了接口支持,可以很方便地在持续集成中使用 Sonar。
二.安装SonarQube
1. 环境准备:
(1)jdk
(2)sonarqube下载:https://www.sonarqube.org/downloads/
(3)sonar-scanner下载:https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
(4)MySql数据库
(5)操作系统:本次以windows环境为例
2. 具体安装与配置过程
(1)分别下载sonarqube和sonar-scanner安装包到本地之后进行解压
![项目工程代码质量检测神器——SonarQube 的用法_第1张图片](http://img.e-com-net.com/image/info3/6bd5f21613454fb0bdb0652bef04818c.jpg)
(2)启动MySQL数据库,创建sonar数据库即可。
(3)进入sonarqube解压缩之后的文件目录中,进入conf文件下,找到sonar.properties文件,并向其中添加MySQL数据库的连接配置信息如下:
(4)进入sonar-scanner解压缩之后的文件目录中,进入conf文件下,找到sonar-scanner.properties文件,并向其中添加MySQL数据库的连接配置信息如下:
(5)至此,Sonar的基本配置就已经完成了,启动它
进入sonarqube解压缩之后的文件目录中,进入bin目录下,找到相对应操作系统的启动环境(StartSonar.bat)进行启动服务。
我的windows64位系统,具体是:C:\soft\SonarQube\sonarqube-7.6\bin\windows-x86-64\StartSonar.bat,点击执行StartSonar.bat文件启动服务
(7)进入数据库中,你会看到生成了大量的数据表,如下:
![项目工程代码质量检测神器——SonarQube 的用法_第4张图片](http://img.e-com-net.com/image/info3/f20ccc2e6ab0476abe31df5f9f73f899.png)
(8)在浏览器上访问:http://localhost:9000,出现如下页面信息,表示sonar安装成功,
![项目工程代码质量检测神器——SonarQube 的用法_第5张图片](http://img.e-com-net.com/image/info3/50dd16f68b8640e08ee10121c615667f.jpg)
点击登录进行登录,账户:admin,密码:admin,即可进入
(9)安装中文语言包,搜索chinese Pack,进行安装即可
![项目工程代码质量检测神器——SonarQube 的用法_第6张图片](http://img.e-com-net.com/image/info3/324a7a8a8d33460ebe0977ca61870ea9.jpg)
安装成功,需要重启StartSonar.bat服务,即可看到如下效果。
![项目工程代码质量检测神器——SonarQube 的用法_第7张图片](http://img.e-com-net.com/image/info3/dbb9aa311a334288b092bf78260ca408.jpg)
到这里已经完成了安装。
3. 启动失败及闪退问题
(1)如果在重启StartSonar.bat服务的时候失败了,你可以启动进程管理器,关闭所有java.exe服务,然后再次启动该服务即可
(2)如果出现启动StartSonar.bat服务之后,过段时间服务闪退,你可以进入sonarqube解压目录下的logs文件下,查看web.log日志查看出错的日志信息,进行解决。
三.使用SonarQube
1. 配置sonar-scanner的环境变量
(1)windows环境下进入高级系统设置环境变量下进行配置,
新建环境变量:
变量名:SONAR_RUNNER_HOME
变量值:C:\soft\SonarQube\sonar-scanner-3.3.0.1492-windows (此处是你所下载的sonar-scanner解压之后所在的文件)
![项目工程代码质量检测神器——SonarQube 的用法_第8张图片](http://img.e-com-net.com/image/info3/e8c00ca9e4a34a7d807da99a5259c710.jpg)
(2)编辑Path环境变量,输入内容: ;%SONAR_RUNNER_HOME%\bin; (注意分号; 是英文状态下的),之后保存退出
(3)以管理的身份启动cmd命令窗口,查看sonar-scanner的版本信息:sonar-scanner -v,如下:
![项目工程代码质量检测神器——SonarQube 的用法_第9张图片](http://img.e-com-net.com/image/info3/a722ba84a1504606bdc98330fd614f64.jpg)
说明环境变量配置成功
2. 新建配置文件sonar-project.properties
打开要进行代码分析的项目根目录,新建sonar-project.properties文件
![项目工程代码质量检测神器——SonarQube 的用法_第10张图片](http://img.e-com-net.com/image/info3/1a6bbee58f3f47319c19aa7c61ff0224.jpg)
文件内容输入如下信息:
之后保存
3. 启动StartSonar.bat服务,并以管理员的身份启动一个cmd命令窗口,cd命令进入项目的根路径下,执行命令:sonar-scanner,开始对你的代码进行质量审核。你会看到如下信息:
![项目工程代码质量检测神器——SonarQube 的用法_第12张图片](http://img.e-com-net.com/image/info3/993c172f974d4688a518a06d3d298d18.jpg)
4. 之后访问http://localhost:9000/, 并进行登录admin/admin,即可查看代码审查结果信息,如下
![项目工程代码质量检测神器——SonarQube 的用法_第13张图片](http://img.e-com-net.com/image/info3/0e99f9926bbd4662b265cc47dea128d8.jpg)
![项目工程代码质量检测神器——SonarQube 的用法_第14张图片](http://img.e-com-net.com/image/info3/6f66fc17288f4693b4c093d31d03040b.jpg)
哇,好多bug,漏洞,然后你就慢慢有针对性的检查自己的代码吧。
总结:代码有bug是在所难免的,但是我们作为开发人员是可以避免出现部分bug的,这就要求我们规范自己的代码习惯,思考发现的问题,及时改进,保证下次写代码不会再犯,做到努力提高自己的代码质量,追求代码的极致完美。