SONAR 使用教程
V1.00
2016-05-18
文件状态:
【 】草
稿
【 】修 改 稿
【√】正式发布
文档编号
TFRY-SONAR-01
保密等级
秘密
作者
审核人员
XX
XX
制作日期
2016-05-14
审核日期
2016-05-18
密级:秘密
版权所有 不得复制
Sonar 使用教程
变更记录
版本号
日期
内容
0.2
0.8
1.0
2016-05-14 建立初始版本
2016-05-17 继续补充相关内容,修改部分内容
2016-05-18 格式、内容最终修订,定版
页
1-4
4-5
1-6
作者
确认
XX
XX
XX
XX
迟峰
XX
秘密
版权所有 不得复制
Sonar 使用教程
一、版本
onarqube 版本:5.4
sonar-runner 版本:2.4
汉化包版本:sonar-l10n-zh-plugin-1.9
数据库版本:oracle 11g
操作系统版本:centos7.0
jdk 版本:jdk1.7
二、环境要求
1、oracle 数据库的安装,这里不在赘述,创建 oracle 数据库用户 sonar,密码 sonar。
2、创建 linux 系统用户 sonar,密码 sonar。
3、安装 jdk 并配置环境变量,这里不再赘述。
三、 sonar 安装
3.1 ftp 以下文件到/home/sonar 目录下:
sonarqube-5.4.zip
sonar-runner-dist-2.4.zip
3.2 解压 sonarqube 与 sonar-runner
[sonar@my33 ~]$ unzip sonarqube-5.4
[sonar@my33 ~]$ unzip sonar-runner-dist-2.4.zip
3.3 配置 sonar 用户的环境变量:
[sonar@my33 ~]$ vi .bash_profile
增加如下内容:
export SONAR_HOME=/home/sonar/sonarqube-5.4
export SONAR_RUNNER_HOME=/home/sonar/sonar-runner-2.4
export PATH=$PATH:$SONAR_HOME/bin:$SONAR_RUNNER_HOME/bin
3.4 修改 sonar-runner 配置文件
[sonar@my33 ~]$ vi /home/sonar/sonar-runner-2.4/conf/sonar-runner.properties
未注释的内容为所需要配置的内容:
sonar.host.url:sonar 管理系统的访问地址和端口
sonar.jdbc.url:sonar 连接数据库的方式、地址、端口和实例名
sonar.jdbc.username:连接数据库的用户名(此用户在数据库中必须已存在)
sonar.jdbc.password:连接数据库的密码
秘密
第 3 页 共 6 页
版权所有 不得复制
sonar.sourceEncoding:代码字符集
sonar.login:登录管理系统的用户名
sonar.password:登录管理系统的密码
Sonar 使用教程
3.5 修改 sonarqube 配置文件
[sonar@my33 ~]$ vi /home/sonar/sonarqube-5.4/conf/sonar.properties
未注释的内容为所需要配置的内容:
sonar.jdbc.url:sonar 连接数据库的方式、地址、端口和实例名
sonar.jdbc.username:连接数据库的用户名(此用户在数据库中必须已存在)
sonar.jdbc.password:连接数据库的密码
sonar.jdbc.driverClassName:连接数据库的驱动
3.6 加载 oracle jdbc 驱动
ftp“ojdbc6.jar”到/home/sonar/sonarqube-5.4/extensions/jdbc-driver/oracle 目录下
3.7 启动 sonar
1、 启动 oracle 数据库实例,不再详述
2、 启动 sonar
[sonar@my33 ~]$cd /home/sonar/sonarqube-5.4/bin/linux-x86-64
[sonar@my33 ~]$./sonar.sh start
秘密
第 4 页 共 6 页
版权所有 不得复制
Sonar 使用教程
3、 关闭 sonar
[sonar@my33 ~]$./sonar.sh stop
4、 重启 sonar
[sonar@my33 ~]$./sonar.sh restar
3.8 查看日志
Sonar 日志文件在/home/sonar/sonarqube-5.4/logs 目录下
3.9 验证
在浏览器中输入 http://192.168.10.33:9000 出现如下界面表示成功:地址为 sonar 安装服务器地
址
3.11 登录
点击右上角“登录”,出现登录界面,输入用户名:admin,密码:admin 登录即可。
四、 汉化
4.1 上传汉化包
ftp “sonar-l10n-zh-plugin-1.9.jar”到/home/sonar/sonarqube-5.4/extensions/plugins 目录
4.2 重启
汉化后需要重启 sonarqube 才能生效,重启方式见 3.7 节。
五、 代码检查
5.1 上传源码
在/home/sonar 目录下创建源码检核目录 例如:mkdir codes
在 codes 目录下创建工程目录,例如:mkdir tfsso
ftp 源码到 tfsso 下,例如 src 是我 tfsso 工程的源码
5.2 配置源码属性文件
在/home/sonar/codes/tfsso 下新建 sonar-project.properties 文件
[sonar@my33 ~]$vi sonar-project.properties 加入如下内容:
Sonar.projectKey:多个工程之间互相却别的唯一名字
Sonar.projectName:工程名称
Sonar.projectVersion:工程本次检索的版本号
秘密
第 5 页 共 6 页
版权所有 不得复制
Sonar.sources:源码路径
其余参数暂时不做过多讲述。
Sonar 使用教程
5.3 执行检查
[sonar@my33 ~]$cd /home/sonar/codes/tfsso
[sonar@my33 ~]$sonar-runner
控制台会出现检核的日志,成功会提示成功信息,错误会提示错误信息
六、 查看检查结果
在浏览器地址栏中输入 http://192.168.10.33:9000 回车后点击右上角“登录”,输入用户名、密
码登录后会看到如下界面:
点击上图红色部分的工程名,会进入如下界面,显示出此工程的检查结果,包含各维度的统计结
果,点击红色标注的“问题”,会看到不符合代码检核规则的所有问题列表和更详细的信息。
秘密
第 6 页 共 6 页
版权所有 不得复制