SonarQube中文网站 > 售前问题 > SonarQube如何创建项目 SonarQube如何生成报告

SonarQube如何创建项目 SonarQube如何生成报告

发布时间:2025-05-16 14: 39: 13

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

SonarQube是一款支持多种编程语言,包括Java、C#、Python等的代码质量检测工具,能帮助我们检测项目代码中的漏洞以及潜在的维护性问题,并生成全面的代码检测报告,同时报告从多个维度给出直观评级,帮助我们快速定位问题根源。在本文中,将系统教大家SonarQube如何创建项目,SonarQube如何生成报告,全面了解SonarQube的使用流程。

一、SonarQube如何创建项目

SonarQube中以项目为基础单元进行检测管理,只有先创建项目,才能进行后续的检测和生成报告操作,以下是在SonarQube中创建项目的具体步骤:

1、首先,打开SonarQube的网页端界面,在默认情况下SonarQube服务绑定9000端口,我们可以在启动SonarQube服务后,通过浏览器访问本地地址“http://localhost:9000”,输入默认用户名admin和默认密码admin后,进入SonarQube的仪表盘。

登录SonarQube
图1:登录SonarQube

2、点击网页顶部的Projects菜单,打开项目界面,再点击“Create Project”展开创建项目下拉框,下拉框中有“Local project”和“Import from DevOps Platforms”两个选项,分别可以创建本地项目和导入远程平台项目。

这里点击Local project进入下图的创建本地项目界面,输入项目名称和唯一标识符key,点击Next进入下一步。

创建本地项目
图2:创建本地项目

3、在此阶段要设置项目对于新旧代码的区分方式,帮助用户聚焦新代码质量,降低对老旧代码的关注度。主要有三种设置方式:

①Previous version:适合按照版本发布的项目,以最近版本为区分标准。

②Number of days:以最近多少天为区分,超过指定天数以上为旧代码。

③Reference branch:以提交分支为基准,指定某个分支为新代码,其余分支为旧代码。

我们根据需要设定好模式后,点击Create projects按钮即可完成项目创建。

选择项目区分方式
图3:选择项目区分方式

二、SonarQube如何生成报告

创建项目后,接下来就要使用SonarQube检测代码质量,生成详细的报告,以帮助项目团队快速定位问题,跟踪项目修改进度。以下是SonarQube生成报告的完整流程:

1、下载SonarScanner。进入SonarQube Server文档中,找到Analyzing source code下的Scanners选项,点击其中的SonarScanner CLI查看相关文档,在如图文档界面中,点击对应的操作系统,下载对应系统的代码扫描脚本。

下载SonarScanner CLI
图4:下载SonarScanner CLI

2、添加环境变量。解压下载压缩包,打开文件夹的bin目录,复制bin目录路径,将该路径添加到系统的PATH环境变量中。

添加系统路径
图5:添加系统路径

3、项目根目录下添加扫描配置文件。在要扫描的本地项目根目录下,添加名为“sonar-project.properties”的配置文件,文件内容按照官方文档建议的默认配置进行配置。

添加项目配置文件
图6:添加项目配置文件

4、启动Sonar Scanner服务生成报告。在项目根目录下打开终端程序,输入命令“sonar-scanner.bat”启动代码扫描检测程序,等待检测完成后打开SonarQube网页端即可查看到本次检测生成的检测报告。

开始扫描生成报告
图7:开始扫描生成报告

现在,我们已经掌握了SonarQube如何创建项目,SonarQube如何生成报告的相关操作方法,相信通过SonarQube的这些强大功能,我们的项目不仅能持续提升代码质量,更能建立起透明可追溯的质量改进机制,让代码质量管理从被动检查转变为主动预防,最终打造出更健壮、更安全的软件产品。

 

 

展开阅读全文

标签:

读者也访问过这里:
SonarQube
从一开始就生成高质量的代码
立即购买
最新文章
SonarQube常见错误 SonarQube报告解读
软件开发过程中,许多测试团队均使用SonarQube来精准帮助开发人员评测代码质量,该工具可以以报告形式呈现扫描结果,并以此推动团队针对性地优化代码。但是,对于初次使用SonarQube的新手用户,很多人都看不懂报告中的各项指标。因此,在本篇文章中,我们将一起探索SonarQube常见错误,SonarQube报告解读,以便能够更好地利用这一工具优化代码。
2025-12-19
SonarQube质量门如何设置 SonarQube质量门条件阈值配置
SonarQube的质量门功能为我们提供了定义和强制执行代码质量标准的有效途径,它通过设置各项指标的合理检测阈值,帮助我们系统地检测代码质量并进行多项指标的量化评估,只有这些指标都符合预设标准,质量门才能顺利通过,从而确保交付的代码具备良好的可维护性、可靠性和安全性。在本文中,我们将一起学习SonarQube质量门如何设置,SonarQube质量门条件阈值配置,借助质量门为代码“保驾护航”。
2025-11-01
SonarQube代码扫描如何配置 SonarQube扫描规则选择与项目绑定步骤
随着技术不断革新发展,如今的软件质量监测,早已告别二十年前的人工审查模式,而是采用一系列质量检测插件或工具进行自动化扫描。SonarQube作为代码质量检测方面的佼佼者,内置了数千条检测规则,且整合了一系列检测工具,我们无需再自己繁琐地整合,它还可生成网页检测报告,让质量检测成为一项快速、精准、简单的工作。那么,SonarQube代码扫描如何配置,SonarQube扫描规则选择与项目绑定步骤是什么呢?
2025-11-01
SonarQube规则引擎怎么配置 SonarQube规则引擎自定义规则
优秀的开发团队都知道,统一的代码规范和质量标准是项目成功的重要保障,SonarQube规则引擎的强大之处不仅在于其丰富的多语言内置规则库,更在于它允许我们根据实际需求创建完全定制化的检查规则。本文将带领各位读者全面了解SonarQube规则引擎怎么配置,SonarQube规则引擎自定义规则的相关技巧,帮助大家开发出针对性强、效果显著的规则。
2025-11-01
SonarQube CI/CD集成是什么 SonarQube CI/CD集成流水线插件配置方法
随着测试自动化理念和相关工具的逐步普及,CI/CD集成已经成为软件开发中十分重要的一环,在这个过程中,如何确保代码质量不因快速交付而下降,成为每个开发团队必须面对的问题。SonarQube作为代码质量检查的一大利器,提供了一种优雅的集成方案,它能够在自动化构建流程中嵌入代码质量检查,实现提交代码、质量检查、发布上线的全自动化。本文将全面解析SonarQube CI/CD集成是什么,SonarQube CI/CD集成流水线插件配置方法,让代码质量管理真正融入开发工作流。
2025-11-01
SonarQube规则库管理是什么 SonarQube规则库管理怎么做
SonarQube通过扫描代码来发现代码中存在的BUG问题、安全漏洞、重复代码,但我们是否想过它是如何发现的呢?这一切依赖于SonarQube内置的规则库,这些规则库存储了数千条经过精心设计的检测规则,涵盖了代码安全性和可维护性等多个维度,通过静态代码分析技术,能够精准识别出代码中的潜在问题,因此我们要做好规则库管理,具体SonarQube规则库管理是什么,SonarQube规则库管理怎么做,我们会在下面进行讲解。
2025-11-01

读者也喜欢这些内容:

咨询热线 18015636924