代码质量管理sonarqube部署使用

2021 年 12 月 30 日
笔记
idea, Sonar, sonarlint, sonarqube, 代码质量, 编程工具相关

一、sonarqube的部署

1.下载sonaqube：//www.sonarqube.org/downloads/

根据需要下载特定版本：

2.如果通过sonar-scanner进行代码扫描的话需要下载sonar-scanner的安装包，如果通过maven或者sonarlint进行则不需要。

sonar-scanner下载地址：//docs.sonarqube.org/latest/analysis/scan/sonarscanner/

下载完成后的文件如下：

sonarqube是代码质量管理的平台。

sonar-scanner是代码扫描的命令行工具。

3.配置文件：

D:\sonarqube\sonarqube-7.9.1\conf\sonar.properties

配置数据库连接属性，以MySQL为例（sonarqube自7.9.版本开始不支持MySQL数据库，其他数据库连接与MySQL只有url稍微有区别）：

# 数据库连接属性
sonar.jdbc.driverClassName=com.mysql.jdbc.Driver
sonar.jdbc.url=jdbc:mysql://10.255.23.4:30218/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=root
sonar.jdbc.password=Gbom@654321

# sonar服务绑定的主机和端口（0.0.0.0表示所有IP都可访问）
sonar.web.host=0.0.0.0
sonar.web.port=9000

# sonar 默认编码和登录账号
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

配置 sonar-scanner 扫描工具：

D:\sonarqube\sonar-scanner-cli\conf\sonar-scanner.properties

# 配置scanner连接的sonar服务地址
sonar.host.url=//localhost:9000
# 配置默认编码
#sonar.sourceEncoding=UTF-8
# 配置sonar服务器连接的数据库
sonar.jdbc.url=jdbc:mysql://10.255.23.4:30218/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=root
sonar.jdbc.password=Gbom@654321

二、服务启动

启动sonarqube：

进入安装目录的bin目录下执行命令StartSonar.bat：

D:\sonarqube\sonarqube-7.9.1\bin\windows-x86-64>StartSonar

出现下面信息，服务启动成功：

访问：//127.0.0.1:9000/ 进行登录，默认账号密码：admin/admin

三、代码扫描：

扫描代码需要新建并配置代码扫描属性文件sonar-project.properties，将文件放在项目根目录下：

sonar-project.properties配置内容如下：

#projectKey是项目的唯一标识，不能出现重复，可随意起
sonar.projectKey=bom-mgmt-service
# SonarQube UI上显示的项目名称，不能是中文
sonar.projectName=bom-mgmt-service
# 项目的版本号
sonar.projectVersion=0.1
# 项目的代码的编码格式
sonar.sourceEndcoding=UTF-8
# 项目的语言
sonar.language=java
# 项目的源代码目录
sonar.sources=src
# 项目的编译生成的class文件的所在目录
sonar.java.binaries=./target/classes

1.通过scanner进行扫描：

首先进入项目根目录

执行命令：D:\workspace\xx-service>sonar-scanner

出现如下提示后表示扫描成功。

登录sonarqube服务进行查看扫描结果：

2.通过maven插件进行扫描：

首先在maven的配置文件C:\apache-maven-3.8.1\conf\settings.xml 添加sonarqube插件支持，并配置sonar服务器信息：

<pluginGroups>
  <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
</pluginGroups>

<profiles>
    <profile>
       <id>sonar</id>
       <activation>
           <activeByDefault>true</activeByDefault>
       </activation>
       <properties>
           <sonar.host.url>
             http://localhost:9000
           </sonar.host.url>
           <sonar.login>admin</sonar.login>
           <sonar.password>admin</sonar.password>
        </properties>
    </profile>
</profiles>

然后在项目的pom.xml 文件中引入maven的sonar插件

<build>
    <plugins>
        <plugin>
            <groupId>org.sonarsource.scanner.maven</groupId>
            <artifactId>sonar-maven-plugin</artifactId>
            <version>3.6.0.1398</version>
        </plugin>
    </plugins>
</build>

刷新maven依赖后，在idea右侧的maven菜单框中可以看到sonar的插件，双击就可以进行代码扫描，扫描过后可以在sonarqube的界面看到扫描的结果。