代码质量管理平台SonarQube的安装、配置与使用

素颜马尾好姑娘i 2022-04-05 05:24 197阅读 0赞

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数据库（不再介绍）

# 一、安装篇 #

1.下载好sonarqube后，解压打开bin目录，启动相应OS目录下的StartSonar。如本文演示使用的是win的64位系统，则打开D:\\software\\sonarqube-7.4\\bin\\windows-x86-64\\StartSonar.bat

2.启动浏览器，访问http://localhost:9000，如出现下图则表示安装成功。登录admin、admin。

![759305-20160307103028616-417108759.png][]

# 二、配置篇 #

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

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

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

sonar.jdbc.url=jdbc:mysql://localhost:3306/base?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
    sonar.jdbc.username=root
    sonar.jdbc.password=root@123
    sonar.sorceEncoding=UTF-8
    sonar.login=admin
    sonar.password=admin

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

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

5.数据库初始化成功后，登录

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

![759305-20160307103854554-1070526910.png][]

7.搜索chinese Pack，安装中文语言包

![759305-20160307104026960-1973799322.png][]

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

![759305-20160307104459382-199007556.png][]

# 三、使用篇 #

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

3.配置环境变量

a.新建变量，name=SONAR\_RUNNER\_HOME。value=D:\\sonar\\sonar-scanner-2.5

b.打开path，输入%SONAR\_RUNNER\_HOME%\\bin;

c.sonar-runner -version，出现以下信息，则表示环境变量设置成功

![759305-20160307104935944-685580471.png][]

4.打开要进行代码分析的项目根目录，新建sonar-project.properties文件

5.输入以下信息

# 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是源文件所在的目录

6.设置成功后，启动sonarqube服务，并启动cmd

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

![759305-20160307105739647-1554930493.png][]

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

![759305-20160307105850288-184794670.png][]

9.我们点击项目，选择问题链接，会看到分析代码的bug，哇，好多

![759305-20160307110003460-507397638.png][]

10.选择一个最严重的bug，看看

![759305-20160307110139179-1776324035.png][]

更多使用，请登录官网自行学习。

http://www.sonarqube.org/

http://docs.sonarqube.org/display/SONAR/Analyzing+with+SonarQube+Scanner

[759305-20160307103028616-417108759.png]: /images/20220405/a8f9ed84bf0040f885cdd90bcc398436.png
[759305-20160307103854554-1070526910.png]: /images/20220405/a05cbdb954594d429058cb1e4128de7b.png
[759305-20160307104026960-1973799322.png]: /images/20220405/dc2f64549cb14807b8555975656cccbe.png
[759305-20160307104459382-199007556.png]: /images/20220405/b065cecc83ff48648bea488d5e18ffd1.png
[759305-20160307104935944-685580471.png]: /images/20220405/1189455310264fa6ac04be1be200b81e.png
[759305-20160307105739647-1554930493.png]: /images/20220405/fc9b002c309245c7be225db1e908693a.png
[759305-20160307105850288-184794670.png]: /images/20220405/2a7430fd798b47819b89817814bc87e9.png
[759305-20160307110003460-507397638.png]: /images/20220405/fd88b777602643a3b221c6312ad349ef.png
[759305-20160307110139179-1776324035.png]: /images/20220405/88f3c4acc1fb483eba9110d4b87e04a6.png