sonar使用手册
1.sonar安装 (2)
1.1 环境要求 (2)
1.2 sonar安装 (2)
2.jenkins集成sonar (7)
2.1安装sonar.phi插件 (7)
2.2.jenkins的sonar配置 (7)
3.配置sonar事遇到的问题及解决方法 (8)
1.sonar安装
1.1 环境要求
a).JDK
环境变量的设置：
JAVA_HOME=D:\Program Files\Java\jdk1.7.0_67\
PATH=%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin
CLASSPATH=%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar
1.2 sonar安装
作为一个代码分析平台，sonar主要由一下3部分构成：
a.一个数据库：存放配置信息和分析结果信息；（mysql）
b.一个web服务器：发布应用，在线浏览、配置分析（sonarqube-4.5.4）
c.一个客户端：执行源代码分析（sonar-runner-2.4）
1.2.1数据库安装
sonar支持的数据库类型有apache derby，h2,sql server,mysql.orcale.postgreSQL等多种数据库，如果只做测试可以使用sonar自带的h2,或derby。他们不需要任何安装。
如果使用其他数据库，仅仅需要创建一个数据库或表空间，提供sonar增删该查数据库权限的账号即可。表和索引将在sonar第一次运行的时候创建。
在这里我们使用的是mysql数据库。创建语句如下：
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'sonar' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
FLUSH PRIVILEGES;
1.2.2安装及配置sonar
在https://www.doczj.com/doc/525985376.html,/downloads/下下载相关应用解压即可。
1.2.2.1sonar安装服务器端sonarqube-4.5.4
1.配置sonarqube-4.5.4
在sonarqube解压包下编辑conf/sonar.properties文件，该文件中所有注释掉的数据库连接模板都是支持的，只需要去掉注释更改为自己的数据库连接即可。同时将默认的自带数据库
连接注释去掉。
一般需要配置一下属性：
sonar.jdbc.url：数据库连接地址
sonar.jdbc,driver：驱动类
https://www.doczj.com/doc/525985376.html,er：数据库用户名
sonar.jdbc.password：密码
图1.1：sonarqube数据库配置
如果使用orcale数据库，那么将orcale驱动包放到sonarqube-4.5.4\extensions\jdbc-driver \oracle文件夹下即可，其他数据库的驱动包已经放到默认的路径下。
2.启动sonarqube
在E:\sonar\sonarqube-4.5.4\sonarqube-4.5.4\bin\windows-x86-64文件下运行StartSonar.bat 文件即可。
图1.2：sonarqube启动
启动成功后在浏览器地址栏输入http://localhost:9000即可访问snoarQube.
图1.3：snoarQube访问页面
3.修改snoar端口
sonar应用默认监听9000端口。通过http://localhost:9000访问
可以在conf/sonar.properties文件中更改：
sonar.web.host=0.0.0.0
sonar.web.port=9000
sonar.web.context=/sonar
4.sonar汉化
下载sonar-l10n-zh-plugin-1.6.jar包放入到sonarqube-4.5.4\extensions\plugins文件夹下，重启sonar server服务，刷新浏览器即可。
1.2.2.1 sonar客户端sonar-runner
1.sonar-runner安装过程
a.将下载包解压到一个本地路径下。
b.将解压路径设置为环境变量
SONAR_HOME=E:\sonar\sonar-runner-2.4
c.更改配置文件：$SONAR_HOME/conf/sonar-runner.porperties
主要是数据源的配置，sonar-runner会将分析的结果存放在数据库中。如图所示，只需将注释的模板适当位置去掉注释并更改为自己对应的sonar配置即可。
图1.4：snoar-runner数据库配置
d.将%SONAR_HOME%\bin;添加到Path环境变量中。
2..sonar-runner demo实例：
在要测试的项目的根目录下添加sonar的配置文件sonar-projet.properties文件。sonar-runner 执行分析时，会读取该文件。
图1.5：snoar-project.properties配置文件在cmd下进入到sonar测试项目下，启动sonar-runner服务。
图1.6：启动sonar-runner
在浏览器中输入http://localhost:9000查看分析结果:
图1.7：sonar-runner分析结果
2.jenkins集成sonar
2.1安装sonar.phi插件
启动jenkins服务后。在jenkins的首页中依次点击系统管理---插件管理--高级中安装下载的sonar.phi插件。具体方法见jenkins使用手册。此处省略配图。
2.2.jenkins的sonar配置
a.添加sonarqube runner
在jenkins的首页中依次点击系统管理---系统设置后配置sonarqube-runner。即SONAR_HOME 的路径。
图2.1：SonarQube Runner配置
b.添加sonarqube
在jenkins的首页中依次点击系统管理---系统设置后配置sonarqube。具体配置如下图：
图2.2：SonarQube Runner配置
图中的配置和sonar-runner的配置文件$SONAR_HOME/conf/sonar-runner.porperties中的内容一致。当不知道文本框中的输入形式时，可以点击文本框旁边的帮助查看具体的填写模式。
c.配置项目的sonarqube
点击jenkins部署的项目，然后进入配置页面，按照下图配置即可。
图2.3：项目配置SonarQube分析工具
配置成功后点击立即构建，就可以查看控制台是否构建成功。如果构建成功就可以在sonar 客户端查看相应分析结果。
3.配置sonar事遇到的问题及解决方法
1.问题一：
启动sonar-runner时会报以下错误：
图3.1：问题一
解决办法：查看sonarqube解压包下的conf/sonar.properties文件。查看用户名和密码是否正确。然后再在$SONAR_HOME/conf/sonar-runner.porperties下查看数据库的用户名和密码是否正确。或者连接数据库看是否能连接成功。
查看
2.问题二：
启动sonarqube时出现以下错误：
图3.2：问题二
解决办法：
出现以上错误说明是数据库链接的问题，这个时候就需要查看sonar-runner.porperties配置中的数据库配置是否正确。查看配置的数据库是否能连接成功。除了orcale数据库需要加相应的驱动包之外，其他类型的数据库都不需要添加相应的数据库驱动包。
3.问题三：
点击sonarqube启动文件后出现如下界面，然后doc文件一闪而过，自动关闭。
图3.3：问题三
解决办法:
出现此问题还是数据库配置问题。查看sonarqube解压包下的conf/sonar.properties文件。查看此文件数据库的配置是否正确，是否能连接成功。修改为正确的地址即可。