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如何配置SAML
软件代码质量管理从以前到现在经历了翻天覆地的变化,从最初的手工代码审查,到自动化测试工具的出现,再到如今SonarQube等综合检测应用的兴起,软件代码检测越来越正规、专业,带来的是软件市场水平整体的提高。并且SonarQube平台后续还支持通过SAML协议单点登录,大大便利了各大企业内部使用,成为如今众多企业进行代码检测的主要工具。那么SonarQube是代码测试工具吗,SonarQube如何配置SAML,接下来一起来了解一下。
2025-09-22
SonarQube分支分析是什么 SonarQube分支扫描配置与差异报告生成方法
在团队协作开发项目中,多分支并行开发已成为常态,每个不同的团队成员各自负责一部分功能或模块开发,最终由团队Leader统一审阅代码并合并分支。在此过程中,如何把控分支代码质量是一项重难点工作,如果全部代码由Leader人为查看,很容易出现错漏,因此常常需要结合SonarQube等带有分支分析的自动化代码检测工具进行。本文将重点向大家说明SonarQube分支分析是什么,SonarQube分支扫描配置与差异报告生成方法,帮助大家解决这一难点。
2025-09-22
SonarQube代码扫描如何启动 SonarQube代码扫描参数配置步骤
SonarQube提供的代码质量检测功能,在当今“两天一个版本”的快节奏开发环境中,已从“锦上添花”变成了“开发必需”,让我们摆脱传统的“先上线再修复”的恶性循环,它能在代码提交后精准捕捉潜在漏洞和安全问题,将质量问题扼杀在萌芽阶段。检测前我们需先启动扫描程序,下面讲解一下SonarQube代码扫描如何启动,SonarQube代码扫描参数配置步骤。
2025-09-22
SonarQube代码扫描显示cwe吗 SonarQube代码扫描怎么手动上传
互联互通的网络时代,安全性成为软件的主要检测项目之一,越多人使用的应用,它的安全性就越需要被保障,因为任何潜在的漏洞都可能被恶意利用,导致数据泄露、服务中断甚至更严重的系统性风险。因此,我们需要使用SonarQube等检测工具,它们既能帮助开发团队在早期发现代码BUG,还能识别CWE标准的安全漏洞。本文将详细回答大家关于SonarQube代码扫描显示cwe吗,SonarQube代码扫描怎么手动上传的疑问,帮助大家提升代码质量与安全等级。
2025-09-22
SonarQube扫描检测不到新代码 SonarQube扫描规则和检查点
SonarQube的代码扫描主要分为旧代码扫描和新代码扫描两部分,并会在报告中清晰呈现新代码与旧代码的对比分析结果,利用新旧代码的区分,帮助我们将注意力更多放在新代码中,而不被历史遗留问题分散注意力。但是,根据SonarQube设置不同,大家可能会遇到新代码未被正确识别或扫描规则和检查点未正确匹配等情况,因此本文将深入探讨SonarQube扫描检测不到新代码,SonarQube扫描规则和检查点的问题,确保大家得到的扫描结果全面可靠。
2025-09-22
SonarQube扫描原理 SonarQube扫描一定要先build么
什么是静态代码分析?静态代码分析指无需运行代码便可通过分析、检查代码的语法、结构、依赖等来检查代码的正确性,SonarQube的代码检测功能正是建立在静态代码分析原理之上。既然是分析静态代码,那SonarQube扫描前需要先编译代码吗?这个问题看似简单,实际涉及SonarQube扫描底层原理。想要获取正确代码检测结果,建议读者一起跟随本文,了解SonarQube扫描原理,SonarQube扫描一定要先build么的问题答案。
2025-09-22

读者也喜欢这些内容:

咨询热线 18015636924