SonarQube部署与使用

于 2024-06-13 12:02:38 发布
阅读量944 收藏 25
点赞数 17
文章标签： 代码规范 低代码 代码复审 单元测试 测试覆盖率
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46517888/article/details/139650712
版权

1. 概述

SonarQube 是一款开源的代码质量管理平台，能够自动进行代码审查并提供详细的报告和建议。它支持多种编程语言，并能与 CI/CD 工具如 Jenkins 无缝集成。本文档将详细指导你如何从零开始部署、配置和使用 SonarQube 9.9.5。

2. 前提条件

• 操作系统: 推荐使用 Linux 发行版（如 Ubuntu、CentOS），也支持 Windows。

• Java 环境: 需要 JDK 11 或以上版本。

• 数据库: 支持 PostgreSQL、MySQL、Oracle 或 MS SQL Server，推荐使用 PostgreSQL。（现在的稳定版本已经不支持MySQL）

• 硬件要求:

• 内存：至少 2GB（建议 4GB 以上，以便处理大型项目）

• CPU：至少 2 核

• 硬盘：至少 1GB 可用空间，视项目大小和扫描频率而定。

3. 安装 SonarQube 9.9.5

3.1 下载 SonarQube 9.9.5

首先，前往 SonarQube 官方网站下载适合你操作系统的 SonarQube 9.9.5 版本。

# 下载 SonarQube 9.9.5

wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.9.5.zip

# 解压下载的文件

unzip sonarqube-9.9.5.zip -d /opt

解压后，你会在 /opt 目录下看到一个名为 sonarqube-9.9.5 的文件夹，里面包含了 SonarQube 的所有文件。

3.2 安装并配置数据库

以 PostgreSQL 为例，按照以下步骤安装和配置数据库：

# 更新软件包列表并安装 PostgreSQL

sudo apt-get update

sudo apt-get install postgresql postgresql-contrib

安装完成后，切换到 PostgreSQL 用户并创建数据库和用户：

# 切换到 postgres 用户

sudo -i -u postgres

# 进入 PostgreSQL 命令行

psql

# 创建数据库

CREATE DATABASE sonar;

# 创建用户并设置密码

CREATE USER sonar WITH ENCRYPTED PASSWORD 'sonar_password';

# 授权用户对数据库的完全访问权限

GRANT ALL PRIVILEGES ON DATABASE sonar TO sonar;

# 退出 PostgreSQL 命令行

\q

# 退出 postgres 用户

exit

配置完数据库后，记得记录下数据库名称、用户名和密码，以便后续配置 SonarQube。

3.3 安装并配置 SonarQube 9.9.5

编辑 SonarQube 配置文件 sonar.properties，配置数据库连接：

# 打开配置文件进行编辑

vim /opt/sonarqube-9.9.5/conf/sonar.properties

找到并修改以下配置：

# 数据库配置

sonar.jdbc.username=sonar

sonar.jdbc.password=sonar_password

sonar.jdbc.url=jdbc:postgresql://localhost/sonar

# 配置 web 服务器

sonar.web.host=0.0.0.0

sonar.web.port=9000

保存并关闭配置文件。

3.4 启动 SonarQube 9.9.5

创建一个新的系统用户来运行 SonarQube 服务：

# 创建 sonarqube 用户组和用户

sudo adduser --system --no-create-home --group --disabled-login sonarqube

# 修改 SonarQube 目录的权限

sudo chown -R sonarqube:sonarqube /opt/sonarqube-9.9.5

使用新创建的用户启动 SonarQube：

# 切换到 SonarQube 目录

cd /opt/sonarqube-9.9.5/bin/linux-x86-64/

# 启动 SonarQube

sudo -u sonarqube ./sonar.sh start

检查 SonarQube 是否启动成功：

# 查看 SonarQube 日志

sudo tail -f /opt/sonarqube-9.9.5/logs/sonar.log


如果日志中显示 SonarQube is up，说明 SonarQube 已成功启动。

4. 配置 SonarQube

4.1 初始配置

在浏览器中访问 http://your_server_ip:9000，使用默认管理员账户登录：

• 用户名: admin

• 密码: admin

首次登录后，系统会提示你修改默认密码。建议设置一个强密码以确保安全。

4.2 安装插件

根据项目需求，可以在 SonarQube 中安装不同的插件。导航到 “Administration -> Marketplace”，搜索并安装所需插件。例如：

• SonarJava: 用于 Java 项目分析

• SonarPython: 用于 Python 项目分析

• SonarJS: 用于 JavaScript 项目分析

安装完成后，重新启动 SonarQube 以使插件生效：

# 停止 SonarQube

sudo -u sonarqube ./sonar.sh stop

# 干掉所有SonarQube进程

ps aux | grep sonar | awk '{print $2}' | xargs kill -9

# 启动 SonarQube

sudo -u sonarqube ./sonar.sh start

4.3 配置质量阈

质量阈用于定义代码质量的标准，可以根据项目需求进行配置。导航到 “Quality Gates”，点击 “Create” 创建新的质量阈，并添加相应的条件，例如：

• 代码覆盖率: 至少 80%

• 关键问题: 不允许存在

• 阻塞问题: 不允许存在

• 重复代码: 不超过 3%

配置完成后，点击 “Set as Default” 将其设为默认质量阈。

5. 使用 SonarQube

5.1 创建项目

在管理控制台中导航到 “Projects -> Create Project”，输入项目名称和项目密钥。项目密钥是该项目的唯一标识符，用于扫描配置。

5.2 生成项目令牌

在创建项目时，系统会生成一个项目令牌。此令牌用于配置 SonarQube Scanner 以进行项目扫描。务必保存该令牌，以便在配置扫描器时使用。

5.3 配置扫描器

下载并配置 SonarQube Scanner，以便在本地或 CI 服务器上进行代码扫描。

# 下载 SonarQube Scanner

wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.7.0.2747-linux.zip

# 解压文件

unzip sonar-scanner-cli-4.7.0.2747-linux.zip -d /opt

# 配置环境变量

echo 'export PATH=$PATH:/opt/sonar-scanner-4.7.0.2747-linux/bin' >> ~/.bashrc

# 加载环境变量

source ~/.bashrc

5.4 配置 sonar-project.properties

在项目根目录创建 sonar-project.properties 文件，定义扫描配置：

# 项目标识符

sonar.projectKey=my_project_key

# SonarQube 服务器地址

sonar.host.url=http://your_server_ip:9000

# 项目令牌

sonar.login=your_project_token

# 代码目录

sonar.sources=src

# 编译目录（针对 Java 项目）

sonar.java.binaries=target

# 日志级别（可选）

sonar.verbose=true

5.5 运行扫描

在项目根目录执行以下命令以运行SonarQube扫描

sonar-scanner

扫描完成后，可以在 SonarQube 管理控制台查看详细的代码质量报告。

6. 集成 Jenkins

6.1 安装 SonarQube 插件

在 Jenkins 管理控制台中导航到 “Manage Jenkins -> Manage Plugins”，在 “Available” 选项卡中搜索并安装 “SonarQube Scanner” 插件。

6.2 配置 SonarQube

在 Jenkins 系统配置中添加 SonarQube 服务器：

导航到 “Manage Jenkins -> Configure System -> SonarQube servers”，点击 “Add SonarQube”，输入以下信息：

• Name: SonarQube

• Server URL: http://your_server_ip:9000

• Server authentication token: 使用前面生成的项目令牌

配置 SonarQube Scanner：

导航到 “Manage Jenkins -> Global Tool Configuration -> SonarQube Scanner”，点击 “Add SonarQube Scanner”，输入以下信息：

• Name: SonarScanner

• Install automatically: 选择合适的版本或手动配置路径

6.3 配置 Jenkins 任务

在 Jenkins 中创建或配置一个任务，在 “Build” 步骤中添加 “Execute SonarQube Scanner” 步骤，配置相应的扫描参数：

# 配置 SonarQube 服务器和扫描器

SonarQube installation: SonarQube

Scanner installation: SonarScanner

# 项目密钥

sonar.projectKey=my_project_key

# SonarQube 服务器地址

sonar.host.url=http://your_server_ip:9000

# 项目令牌

sonar.login=your_project_token


配置完成后，保存并构建项目。构建完成后，可以在 SonarQube 管理控制台查看详细的代码质量报告。

7. 使用 Maven 构建和分析项目

7.1 配置 Maven

确保已安装 Maven 并正确配置 settings.xml 文件，包含 SonarQube 的相关配置：

<settings>

  <profiles>

    <profile>

      <id>sonar</id>

      <properties>

        <sonar.host.url>http://your_server_ip:9000</sonar.host.url>

        <sonar.login>your_project_token</sonar.login>

      </properties>

    </profile>

  </profiles>

  <activeProfiles>

    <activeProfile>sonar</activeProfile>

  </activeProfiles>

</settings>

7.2 配置 Maven 的 pom.xml 文件

确保项目的 pom.xml 文件中包含基本的构建配置和依赖。

<project xmlns="http://maven.apache.org/POM/4.0.0"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>

    <artifactId>my-project</artifactId>

    <version>1.0-SNAPSHOT</version>

     

    <!-- 其他配置和依赖 -->

</project>

7.3 使用 Maven 运行 SonarQube 扫描

在项目根目录执行以下命令以使用 Maven 进行代码扫描：

mvn clean verify sonar:sonar

8. 常见问题与解决方案

8.1 SonarQube 无法启动

• 检查配置文件: 确保 sonar.properties 文件中的数据库配置正确。

• 查看日志: 检查 /opt/sonarqube-9.9.5/logs/sonar.log 日志文件，获取详细错误信息。

• 端口冲突: 确保 SonarQube 使用的端口（默认 9000）没有被其他应用程序占用。

8.2 扫描失败

• 配置错误: 确保 sonar-project.properties 文件中的配置信息正确无误。

• 依赖问题: 确保项目中所有依赖已经解决，编译没有错误。

• 网络问题: 确保可以访问 SonarQube 服务器。

SonarQube官方文档：https://docs.sonarsource.com/sonarqube/9.9/

SonarQube自定义插件文档：sonar-java/README.md at 7.28.0.33738 · SonarSource/sonar-java · GitHub

SonarQube官方论坛：https://community.sonarsource.com

SonarQube官方练习文档：GitHub - SonarSource/sonar-scanning-examples: Shows how to use the Scanners

阿里P3C插件Java11：p3c/README.md at master · alibaba/p3c · GitHub

阿里P3C插件Java17：GitHub - Leibnizhu/sonar-pmd-p3c-jdk17: 新版sonar-pmd + 新版p3c，支持jdk17

-HQ?
关注
  • 17
    点赞
  • 踩
  • 25
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
SonarQube安装及使用
Scluis的博客
05-07 1705
前言 最近需要使用SonarQube分析一下项目，简单记录一下下载安装和使用过程。 下载安装 7.4版本下载地址： 链接：https://pan.baidu.com/s/1TBrO0kSy_5HOpbRUxzeDRw 提取码：4ajt 下载SonarQube之前，需要已经配好了JDK和MySQL的环境（数据库也可以不用MySQL） 我这里使用的是JDK8和MySQL5.6.40，SonarQube使用的是7.4版本，一开始下载了最新版本（8.9），发现需要JDK11才能使用，果断放弃了，下载了支持JDK8的
SonarQube 安装、部署及配置使用
乔木的博客
04-20 1935
通过本文的介绍，您应该已经掌握了如何安装、部署和配置使用SonarQube。作为一款强大的代码质量管理平台，SonarQube能够帮助您及时发现并解决潜在的代码问题，提高代码质量和开发效率。希望这篇文章对您有所帮助！
6.Devops实战篇之——代码测试（SonarQube）
最新发布
PSYCHO0921的博客
05-22 886
Jenkins整合Sonarqube进行代码质量检测
启动SonarQube软件
buling_bulink的博客
08-09 996
启动SonarQube软件 我使用的是SonarQube9.0版本的软件，下载这个zip文件，解压至c盘路径下；本地要安装好java11，9.0版本的需要java11支持。Java环境变量配置好后，按win+r输入cmd，出现命令行，输入Java -version和javac检查java11环境是否配置好（下载jdk11并安装哦配置环境变量）。打开%SonarQube_home%/bin文件夹下对应系统下的StartSonar.bat，启动StartSonar，同时打开localhost:9000就可以进到
SonarQube开机自启动
Gblfy_Blog
05-27 2196
5
Centos7 Sonarqube配置自启动
qq_31564573的博客
04-18 2369
Centos7 Sonarqube配置自启动 手动能启动--配置自启动启动失败的解决办法
SonarQube使用教程分享
m0_73291751的博客
06-02 2340
根据你使用的构建工具（如Maven、Gradle等），在项目的构建配置文件中添加SonarQube插件或命令，以在构建过程中执行SonarQube扫描。在SonarQube的Web界面上，导航到你的项目，并查看扫描结果。在你的项目中，添加一个名为`sonar-project.properties`（或使用其他支持的配置文件格式）的文件。在该文件中，指定SonarQube扫描的配置选项，例如项目的键、名称、源代码路径等。在SonarQube的Web界面上，使用管理员账号登录，并创建一个新的项目。
持续集成与持续部署-SonarQube使用教程
11-19
此外，SonarQube能够无缝集成到持续集成/持续部署(CI/CD)流程中，例如Jenkins和Azure DevOps。当开发者提交代码时，SonarQube会自动运行分析，即时反馈质量检查的结果，这有助于快速修复问题，提升软件的稳定性和...
sonarqube安装以及使用指南
01-22
SonarQube是一款开源的代码质量管理工具...总结，SonarQube的安装和使用涉及系统配置、数据库设置、服务管理以及与开发流程的集成。通过这个指南，你应该能够成功地在CentOS 7上部署SonarQube并开始提升你的代码质量。
SonarQube中文使用手册
04-03
以下是对SonarQube中文使用手册的详细解读： 一、SonarQube简介 SonarQube由SonarSource公司开发，它支持多种编程语言，如Java、C#、Python、JavaScript等。它的核心功能包括代码质量分析、代码覆盖率报告、代码...
SonarQube使用手册.zip
09-22
SonarQube是一款强大的静态代码分析工具，用于代码质量管理，旨在通过自动化的方式发现代码中的问题，包括漏洞、代码异味和...这份"SonarQube使用手册.pdf"将详细解答所有相关问题，是学习和使用SonarQube的宝贵资源。
搭建jenkens+Nexus+sonarqube自动化部署
07-28
本篇文章将详细介绍如何搭建基于Jenkins、Nexus、SonarQube的自动化部署环境，以便开发团队进行协作开发，并方便公司进行数字资产的管理与审计。 标题：搭建Jenkins+Nexus+SonarQube自动化部署 描述：搭建基于...
SonarQube安装、出现启动出错并解决记录、配合idea配置使用，gradle项目配置
qq_37432174的博客
11-10 4513
Sonarqube是一个功能非常强大的代码质量检查、管理的开源工具。它通过插件的形式能够识别常见的多种编程语言（例如Java, C++, Pythod等）代码质量问题。修改默认端口9000，sonar.web.port。直接解压缩，然后进入对应系统的文件夹。
SonarQube的安装使用
ths512的博客
04-07 395
SonarQube是管理代码质量一个开放平台，可以快速的定位代码中潜在的或者明显的错误，本文将会介绍一下这个工具的安装、配置以及使用。 一、SonarQube的安装使用： 下载地址：http://www.sonarqube.org/downloads/ 本文下载的版本是sonarqube-6.7.6。 下载完之后，选择进入具体的版本，本文作者的环境是：D:\sonarqube-6.7.6\bin\windows-x86-64 然后点击：StartSonar.bat启动SonarQube。
sonarqube在cr服务器上如何重启
weixin_46453070的博客
08-23 423
检查SonarQube是否已成功重启，您可以尝试访问SonarQube的Web界面或查看SonarQube的日志文件。请注意，上述命令可能因操作系统和SonarQube版本而有所不同。请根据您的实际情况进行调整。等待一段时间，确保SonarQube服务已完全停止。等待一段时间，确保SonarQube服务已完全启动。sonarqube在cr服务器上如何重启。登录到CR服务器的操作系统。打开终端或命令提示符窗口。
SonarQube安装指导
awen8307的专栏
08-31 1万+
Sonarqube的安装部署指导，以及使用scanner进行代码扫描方法说明
SonarQube介绍
热门推荐
zzhongcy的专栏
10-26 3万+
SonarQube 是一个开源的代码分析平台, 用来持续分析和评测项目源代码的质量。 通过SonarQube我们可以检测出项目中重复代码， 潜在bug， 代码规范，安全性漏洞等问题， 并通过SonarQube web UI展示出来。 1 Sonar简介 1.1 sonarQube是什么？ 1、代码质量和安全扫描和分析平台。 2、多维度分析代码：代码量、安全隐患、编写规范隐患、重复度、复杂度、代码增量、测试覆盖率等。 3、支持25+编程语言的代码扫描和分析，包含java\python\C#\jav.
【SonarQube】SonarQube 指标解读
书山有路，学海无涯。记录成长，追逐梦想
11-28 3184
SonarQube 是一种自动代码审查工具，可以检测出重复代码、代码漏洞、代码规范和安全性漏洞的问题。它可以与您现有的工作流程集成，以实现跨项目分支和提取请求的连续代码检查。Sonar Qube 可以与多种软件整合进行代码扫描，比如 Maven，Gradle，Git，Jenkins 等，并且会将代码检测结果推送回 SonarQube，并且在系统提供的 UI 界面上显示出来。
【sonarQube部署安装】
qq_31360283的博客
07-27 1419
sonarQube部署安装
如何部署sonarqube并使用
04-06
SonarQube是一个开源的代码质量管理平台，它能够检查代码的质量，提供关于代码的统计信息和可视化报告，以及支持团队协作和管理。下面是部署SonarQube并使用的步骤： 1. 下载SonarQube SonarQube可以在官方网站上下载，也可以从其他的下载站点下载。下载后解压缩到合适的目录。 2. 配置数据库 SonarQube需要一个数据库来存储数据。官方推荐使用MySQL或PostgreSQL数据库。在安装并配置好数据库后，需要创建一个新的数据库并授权给SonarQube。 3. 修改SonarQube配置文件 修改配置文件sonar.properties，将数据库的连接信息配置好。例如： sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance sonar.jdbc.username=sonar sonar.jdbc.password=sonar 4. 启动SonarQube 在命令行中进入SonarQube的bin目录，并执行以下命令启动SonarQube： ./sonar.sh start 5. 访问SonarQube 在浏览器中输入http://localhost:9000，即可访问SonarQube的Web界面。使用默认用户名admin和密码admin登录。 6. 创建项目 在SonarQube中创建一个新的项目，需要提供项目的名称和编程语言等信息。创建成功后，会生成一个项目的唯一标识符。 7. 集成SonarQube 将SonarQube集成到开发环境中，需要使用SonarQube Scanner或其他支持SonarQube的工具。在项目的根目录中创建一个sonar-project.properties文件，配置项目的信息和SonarQube服务器的地址等信息。例如： sonar.host.url=http://localhost:9000 sonar.projectKey=my-project sonar.projectName=My Project sonar.projectVersion=1.0 sonar.sources=src 8. 运行扫描 在命令行中使用SonarQube Scanner执行扫描操作。例如： sonar-scanner 扫描完成后，可以在SonarQube的Web界面中查看扫描结果和报告。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值