代码质量难评估?一文带你用 SonarQube 分析代码质量!

无论是架构师还是研发经理,代码质量都是必须要关注的重点。Sonar(没错,是 Sonar,不是 SonarQube)是一个用于代码质量管理的开源平台,用于管理代码的质量。

它通过插件形式可以支持二十几种语言的代码质量检测,通过多个维度的检查了快速定位代码中潜在的或者明显的错误。千里之行始于足下,今天就让我带大家用一个简单的例子,看看怎么使用 SonarQube 进行代码质量管理。

基础概念

SonarQube

SonarQube 是 Sonar 的服务端,相当于一个 web 服务器中的 tomcat,用来发布应用,在线浏览分析等。

Sonar Scanner

Sonar Scanner 是对源码进行扫描的工具,它可以将结果保存到数据库以便用上面的 SonarQube 进行分析。关于 Sonar Scanner 更多的内容,见官方文档:Analyzing source code overview https://docs.sonarqube.org/latest/analyzing-source-code/overview/

环境配置

JDK 配置

SonarQube 最新版本需要 JDK11 以上,需要先配置好 JDK 开发环境。配置好之后再命令行运行java -version查看,如果运行没报错说明配置成功,如下代码所示。

$ java -version
java version "17.0.6" 2023-01-17 LTS
Java(TM) SE Runtime Environment (build 17.0.6+9-LTS-190)
Java HotSpot(TM) 64-Bit Server VM (build 17.0.6+9-LTS-190, mixed mode, sharing)

Maven 配置

后续将会使用 Sonar Scanner for Maven 来分析项目,因此需要有安装 Maven 并配置好对应的环境变量。配置好之后运行mvn -version查看,如果运行没报错说明配置成功,如下代码所示。

[~]$ mvn -version
Java HotSpot(TM) 64-Bit Server VM warning: Ignoring option MaxPermSize; support was removed in 8.0
Apache Maven 3.3.3 (7994120775791599e205a5524ec3e0dfe41d4a06; 2015-04-22T19:57:37+08:00)
Maven home: /Users/xxxx/Yosemite/Alpha/maven
Java version: 11.0.18, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk-11.jdk/Contents/Home
Default locale: en_GB, platform encoding: UTF-8
OS name: "mac os x", version: "11.4", arch: "x86_64", family: "mac"

数据库支持

SonarQube 最新版本支持 SQLServer、Oracle、H2 等数据库来存储数据,但并不支持 MySQL 数据库。SonarQube 默认会使用 H2 内存数据库来临时存储数据,可能查看数据的时候会比较不方便。

安装启动 SonarQube

到 Sonar 官方网站下载 SonarQube:Clean Code | Developer First | Sonar,这里我们选择社区版,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第1张图片

下载完成之后解压可以看到如下图所示目录,其中bin是运行应用的目录、conf是配置文件的目录、logs是日志的目录。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第2张图片

这里我们打开bin文件夹,可以看到有多个不同目录对应不同系统。我这里是 Windows 系统就打开macosx-universal-64目录,随后运行./sonar.sh start命令运行。运行之后,会启动 SonarQube 所需要的各个服务,包括 ElasticSearch 等。如果一切正常,那么日志会提示SonarQube is operational,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第3张图片

随后,打开 SonarQube 的管理后台地址:http://127.0.0.1:9000,输入默认的账号密码:admin/admin,点击登录之后会要求你修改密码。修改密码之后就进入了 SonarQube 管理后台,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第4张图片

SonarQube 也提供了 Docker 启动的方式,镜像地址为:sonarqube - Official Image | Docker Hub。用 Docker 的好处就是:你可以省去上面所有的配置,一个命令就启动 SonarQube,真的是太方便了!

扫描简单项目

SonarQube 启动完成之后,这里用我之前的 chenyurong/quick-start-of-spock: help you to learn spock quickly. 项目来体验下 SonarQube 的代码扫描功能。

首先,我们选择手工导入项目的方式,来导入我们的本地项目,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第5张图片

接着,我们设置好显示名等信息,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第6张图片

接着,选择本地导入项目信息,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第7张图片

接着,创建一个 token 令牌,点击创建按钮,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第8张图片

接着,我们选择 Maven 构建技术,随后 SonarQube 会自动为我们生成对应的命令,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第9张图片

我们直接复制上面生成的 mvn 命令代码,直接到 quick-start-of-spock 项目的根目录运行。正常情况下,其是可以运行成功的,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第10张图片

随后,我们直接回到 SonarQube 页面,可以看到 quick-start-of-spock 项目有数据了,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第11张图片

扫描多模块项目

如果你的项目是多模块的结构,那么在运行分析命令之前需要先运行mvn install命令。同样在 SonarSource / sonar-scanning-examples 下面有 Sonar 官方提供的maven-multimodule示例项目,我们以这个项目为例来讲讲如何扫描多模块项目。

首先,在项目根目录下运行mvn install命令,成功后再运行 Sonar Scanner Maven 插件的分析命令,如下所示。

mvn clean verify sonar:sonar -Dsonar.login=sqxxxxxxxxxxxxxxd222e7adc

如果正常的话,那么命令行会输出成功的日志信息,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第12张图片

此时再打开 SonarQube 管理后台,可以看到多了一个名为maven-multimodule的项目,如下图所示。

代码质量难评估?一文带你用 SonarQube 分析代码质量!_第13张图片

如果你想要在 Gradle、Ant 等构建的项目中使用 Sonar Scanner,可以参考官网的文档:Analyzing source code overview https://docs.sonarqube.org/latest/analyzing-source-code/overview/

你可能感兴趣的:(java,数据库,开发语言)