Sonar介绍
Sonar是一个用于代码扫描检测的开放平台。可以实现对不同语言(java、python、php、C++、C#等等)的项目代码进行分析,同时可以集成不同的测试工具、代码分析工具,以及持续集成工具(jenkins)。
当前Sonar的最新版本为8.6,由于新版本不支持mysql数据库了,所以本技术文档实现以Sonar 6.7版本为演示版本。下载的链接地址如下:https://www.sonarqube.org/downloads/
Sonar安装
1、安装mysql数据库,版本为5.6版本以上
因为Sonar支持不同的数据库,本文档以mysql为主,所以安装Sonar 6.7版本前需要安装mysql 5.6或者5.6以上的版本,低于5.6的版本,启动Sonar时会报错。关于Mysql数据库的安装,这里不做详细说明。
接下来需要在mysql数据库中新增一个名为sonar的数据库即可(不需要创建数据库表)。
2、下载Sonar压缩包进行安装
第一步:Sonar压缩包可以在下载边接中进行下载。下载完成后进行解压缩操作,解压缩操作完成后,将解压缩的目录移动到一个不包含有中文的目录下。
第二步:找开Sonar压缩目录下conf中的sonar.properties文件(我的文件路径为:D:\Program Files\sonarqube-6.7.7\conf),修改以下配置项并保存:
sonar.jdbc.username=root # 连接Sonar数据库名的配置
sonar.jdbc.password=123456 # 连接Sonar数据库密码的配置
sonar.jdbc.url=jdbc:mysql://localhost:53306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false #连接Sonar数据库的链接地址信息
sonar.web.port=9000 # 设置Sonar连接数据库的端口
第三步:启动Sonar服务:进入到Sonar的bin目录下,在Dos命令行中输入: startsonar.bat即可启动。如果能看到以下信息就说明是成功的。
第四步:访问Sonar服务:
在浏览器中访问: http://localhost:9000即可,如果能显示以下图片就说明Sonar服务已经完全配置OK(登录的用户名和密码默认为 admin/admin)
3、通过Sonar来扫描代码
第一步:由于扫描的是Java的代码,所以需要安装Maven,且需要在Maven的配置文件Settings.xml中增加以下配置项(此项增加在profiles节点中):
<profile>
<id>sonar</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<sonar.jdbc.url>jdbc:mysql://localhost:53306/sonar?useUnicode=true&characterEncoding=utf8</sonar.jdbc.url>
<sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
<sonar.jdbc.username>root</sonar.jdbc.username>
<sonar.jdbc.password>123456</sonar.jdbc.password>
<sonar.host.url>http://localhost:9000</sonar.host.url>
</properties>
</profile>
第二步:针对Java的项目使用mvn进行编译,然后再扫描:
执行第一条命令: mvn clean install
执行第二条 命令: mvn sonar:sonar
执行完这两条命令之后,就可以在Sonar的服务平台web页面查看扫描的结果。由于我所使用的代码非常简单,最终扫描结果没有什么大的问题。