SonarQube平台搭建和使用教程

定义

SonarQube是管理代码质量一个开放平台,可以快速的定位代码中潜在的或者明显的错误,下面将会介绍一下这个工具的安装、配置以及使用。

准备工作;

1、jdk(不再介绍)

2、sonarqube:http://www.sonarqube.org/downloads/

3、SonarQube+Scanner:https://sonarsource.bintray.com/Distribution/sonar-scanner-cli/sonar-scanner-2.5.zip

4、mysql数据库(不再介绍)

SonarQube下载

sonar 官网: https://www.sonarqube.org/
sonar 下载地址:https://www.sonarqube.org/downloads/

SonarQube安装

预置条件:
1.Java环境(1.8+)
2.MySql数据库(5.6+)
3.SonarQube 7.6
下载完解压后效果图如下:

进入conf文件,配置sonar.properties,参数信息如下:

1.打开mysql,新建一个数据库。

2.打开sonarqube安装目录下的D:\sonar\sonarqube-5.3\sonarqube-5.3\conf\sonar.properties文件

3.在mysql5.X节点下输入以下信息

4.重启sonarqube服务,再次访问http://localhost:9000,会稍微有点慢,因为要初始化数据库信息

5.数据库初始化成功后,登录
sonar.jdbc.username=root
sonar.jdbc.password=123123
sonar.jdbc.url=jdbc:mysql://localhost:3307/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.web.port=9000

url是数据库连接地址,username是数据库用户名,jdbc.password是数据库密码,login是sonarqube的登录名,sonar.password是sonarqube的密码

进入到bin文件夹,效果如下图: 

里面支持各种操作系统,选择自己当前的操作系统,效果图如下:

按照顺序依次执行,InstallNTService.bat、StartNTService.bat、StartSonar.bat文件,若无错误,启动成功后访问:http://localhost:9000,效果如下:

到此,SonarQube安装成功

SonarQube中文设置

按照下图的点击顺序,进入插件安装页面

搜索chinese Pack,安装中文语言包 

安装成功后,重启sonarqube服务,再次访问http://localhost:9000/,即可看到中文界面

 Sonar-Scanner安装与使用

sonar-scanner插件是用来分析软件的,和SonarQube配合使用

Sonar-Scanner下载

下载地址:https://sonarsource.bintray.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.0.3.778-windows.zip
 

 解压即可使用

 Sonar-Scanner配置与使用

1、打开D:\sonar\sonar-scanner-2.5\conf\sonar-runner.properties文件

2、mysql节点下输入以下信息

--------------------------------------------------------------
sonar.jdbc.url=jdbc:mysql://172.16.30.228:3306/qjfsonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.username=gmsd
sonar.jdbc.password=gmsdtrade
--------------------------------------------------------------

注意:如果测试项目与服务器不在同一台机子,则需要添加服务器的IP:

--------------------------------------------------------------
#----- Default SonarQube server
sonar.host.url=http://XXX.XXX.XXX.XXX:9000
--------------------------------------------------------------

配置环境变量:

1、新建变量,name=SONAR_RUNNER_HOME。value=D:\sonar\sonar-scanner-2.5

2、打开path,输入%SONAR_RUNNER_HOME%\bin;

3、sonar-runner -version,出现以下信息,则表示环境变量设置成功

 数据库配置上面有,再次介绍---》》》

修改conf下sonar-scanner.properties,配置如下:

sonar.host.url=http://localhost:9000(sonar地址)
sonar.sourceEncoding=UTF-8
sonar.jdbc.url=jdbc:mysql://localhost:3307/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=******
sonar.jdbc.password=*******

 在要检测的项目根目录下新建sonar-project.properties,内容如下:

sonar.projectKey=your_project(自己定义)
sonar.projectName=your_project(自己定义)
sonar.projectVersion=1.0
sonar.sources=src(代码目录)
sonar.java.binaries=target(classes文件目录,不加会报错)
sonar.language=java
sonar.sourceEncoding=UTF-8

或者

# must be unique in a given SonarQube instance
sonar.projectKey=my:project
# this is the name displayed in the SonarQube UI
sonar.projectName=apiautocore
sonar.projectVersion=1.0
 
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# Since SonarQube 4.2, this property is optional if sonar.modules is set. 
# If not set, SonarQube starts looking for source code from the directory containing 
# the sonar-project.properties file.
sonar.sources=src
 
# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8

其中:projectName是项目名字,sources是源文件所在的目录

设置成功后,启动sonarqube服务,并启动cmd

在cmd进入项目所在的根目录,输入命令:sonar-runner,分析成功后会出现下图

 

打开http://localhost:9000/,我们会看到主页出现了分析项目的概要图 

我们点击项目,选择问题链接,会看到分析代码的bug

选择一个最严重的bug,看看 

然后,项目根目录下打开命令行,输入sonar-scanner运行,就可以看到检测成功了,在sonar主页可以看到检测结果,效果图如下:

猜你喜欢

转载自blog.csdn.net/bj_chengrong/article/details/103596297