一、Linux安装和配置SonarQube
SonarQube的运行依赖于JDK,安装JDK,参考博客(CI系列之一:JDK安装及配置)
1.sftp上传文件:sonarqube-5.6.6.zip,具体上传过程可以参考博客(CI系列之一:JDK安装及配置)
2.移动sonarqube-5.6.6.zip至安装目录
# mv sonarqube-5.6.6.zip /usr/local
3.切换到安装目录
# cd /usr/local
4.解压zip
# unzip sonarqube-5.6.6.zip
5.更改文件夹名称
# sonarqube-5.6.6 sonarqube
6.修改配置文件sonar.properties,修改的配置项如下
# cd /usr/local/sonarqube/conf
# vi sonar.properties
sonar.jdbc.username=root
sonar.jdbc.password=******
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
# SonarQube的三大服务的JVM配置,如果SonarQube起不开,或是启动缓慢,根据日志文件修改相应的配置
# web服务的JVM配置
sonar.web.javaOpts=
# 计算引擎服务的JVM配置
sonar.ce.javaOpts=
# 搜索引擎服务的JVM配置
sonar.search.javaOpts=
7.启动SonarQube服务
# cd /usr/local/sonarqube/bin/linux-x86-64/
# ./sonar.sh start
8.监控日志文件,查看启动的具体情况
# cd /usr/local/sonarqube/logs
# tail -f sonar.log
9.防火墙开放端口9000,具体情况参照文档:2.MySQL的安装及配置
10.浏览器访问SonarQube服务,用户名和密码均为admin
二、Windows安装和配置sonar-runner-2.4.zip(文件在D盘根目录)
1.解压文件:sonar-runner-2.4.zip至当前文件夹
2.配置系统变量
2.1.新增系统变量SONAR_RUNNER_HOME=D:\sonar-runner-2.4
2.2.编译系统变量PATH,尾部追加“;%SONAR_RUNNER_HOME%\bin;“
3.配置sonar-runner的配置文件sonar-runner.properties,修改以下的内容
sonar.host.url=http://192.168.2.131:9000
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
sonar.jdbc.username=root
sonar.jdbc.password=******
4.任意窗口执行测试命令sonnar-runner -v,出现以下结果,显示配置成功
> sonar-runner -v
D:\sonar-runner-2.4
SonarQube Runner 2.4
Java 1.8.0_121 Oracle Corporation (64-bit)
Windows 10 10.0 amd64
三、sonar-runner配合SonarQube审查一个Java Maven项目
Java Maven项目jdk_design_pattern,所在根目录为E:\workspace\jdk_parent\jdk_design_pattern
1.在项目根目录,创建文件sonar-project.properties并进行简单的配置,配置内容如下(只有注释的部分需要改动):
#项目key
sonar.projectKey=jdk_design_pattern
# 项目value
sonar.projectName=jdk_design_pattern
# 项目版本号
sonar.projectVersion=1.0
# 项目源码路径,多个源码包可用英文逗号隔开
sonar.sources=src
# 项目编译后代码所在路径,多个可用英文逗号隔开
sonar.java.binaries=target/classes
#源码的编程语言,python为py
sonar.language=java
#源码的编码方式
sonar.sourceEncoding=UTF-8
sonar.my.property=value
2.在文件夹jdk_design_pattern右键,点击DOS快速通道,打开CMD,执行如下的命令配合SonarQube进行代码审查:
> sonar-ruuner
3.等待分析完成,即可登录SonarQube服务网址:192.168.2.131:9000,查看项目的代码审查结果