一个新项目准备上线提测了,为了在提测之前做一下代码走查,同时了解项目目前的质量情况,就在本地搭建了一套sonar环境。搭建的过程中遇到了很多问题,sonar官方已不再维护Eclipse的svn插件,所以之前很多网上的教程都存在问题了。通过自己的摸索,最后还是成功搭建好了环境。下面我们开始搭建吧。
1 准备阶段
(1)下载MySQL,地址:http://dev.mysql.com/downloads/installer/ (2)下载SonarQube,地址:http://www.sonarqube.org/downloads/ (3) 下载SonarQube中文插件,地址:http://download.csdn.net/detail/u010218242/9272667
1.2 环境准备 (1)确保本机已经安装JDK (2)安装数据库 由于sonar需要数据库支持,我们首先安装数据库,这里使用mysql(当然你也可以安装其他数据库)。
第一步:安装mysql,安装流程就不说了,这里特别需要注意的是选择编码格式的时候一定要选择utf8.
第二步:使用命令创建数据库,名字为sonar:
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
第三步:创建一个sonar用户并把这个用户的密码设置为soanr:
CREATE USER ‘sonar’ IDENTIFIED BY ‘sonar’;
第四步:将第二步中创建的sonar数据库的所有权限赋给第三步中创建的sonar用户:
GRANT ALL ON sonar.* TO ‘sonar’@’%’ IDENTIFIED BY ‘sonar’; GRANT ALL ON sonar.* TO ‘sonar’@’localhost’ IDENTIFIED BY ‘sonar’; FLUSH PRIVILEGES;
至此数据库已经建好了。
第二步:修改配置文件,打开conf目录下的日志文件,然后加入以下信息:
sonar.jdbc.username=sonar sonar.jdbc.password=sonar sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
第三步:bin目录下会有各种平台的启动脚本,我用的windows-x86-32的:
点击StartSonar.bat,开始启动。第一次启动需要初始化数据库,需要等一会儿:
第四步:在浏览器中打开http://localhost:9000/,正常安装的情况会显示如下界面:
至此,我们的SonarQube已经安装成功了,如果想要使用SonarQube平台管理我们的代码质量,还需要安装代码解析工具。通常我们使用maven来集成sonar的解析,请看下小节。
<profile>
<id>sonar</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<sonar.jdbc.url>jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true</sonar.jdbc.url>
<sonar.jdbc.username>sonar</sonar.jdbc.username>
<sonar.jdbc.password>sonar</sonar.jdbc.password>
<sonar.host.url>http://localhost:9000</sonar.host.url>
</properties>
</profile>
第二步:接下来在sonarqube启动的情况下,进入maven项目中,执行mvn sonar:sonar命令,等待结束。那么在http://localhost:9000下就可以查看sonar分析的结果了。
对于开发者来说,如果我们能够在Eclipse中直接集成sonar那是更加方便了,我们可以直接在Eclipse中查看sonar问题。接下来我们演示如何在Eclipse中集成sonar。
第一步:安装sonar插件,打开Help > Install New Software… ,输入下面这个网址 (http://downloads.sonarsource.com/eclipse/eclipse/),接下来就会显示下面这个界面内容
然后点击next安装就OK了,完成安装之后会提示你重新启动。
第二步:Eclipse上运行sonar,Eclipse执行maven命令:sonar:sonar:
再去locahost:9000下面查看,已经ok:
如果我们想直接在Eclipse中查看sonar问题,我们点击工程右键,如下图:
然后再次右击工程,进行解析,如下图:
分析结果:
到这里,sonar本地环境搭建已经完全ok!
总结: 在本地搭建sonar环境的过程当中,经历了各种问题,版本问题、官方sonar插件不维护问题…通过各种尝试终于搞定,如果你安装的过程当中出现了什么问题可以联系我。