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 Webhook怎么配置 SonarQube Webhook推送失败怎么排查
SonarQube Webhook的配置,和推送失败时的排查,重点并不只是填进去一个回调地址就完成了,而是要去确认这个地址,能够被SonarQube的服务器正常访问到,并且接收的那一端,也能够正确地识别出推送过来的内容。Webhook这个东西,通常是用来把扫描完成、质量门禁的状态这一类结果,推送给Jenkins、GitLab、企业微信、钉钉,或者是公司内部的平台。SonarQube它支持项目这一级,和全局这一级的Webhook配置,项目级的,是可以在项目的设置里面去配,全局级的,则是可以在系统的管理里面去配。
2026-06-30
SonarQube新代码周期怎么设置 SonarQube新代码周期影响门禁结果怎么看
SonarQube新代码周期的设置,以及新代码周期对门禁结果的影响,是很多团队在配置质量门禁时容易忽略的问题。新代码周期并不是一个单纯的日期设置,它决定了哪些代码会被SonarQube当作“新增或修改的代码”来评估。如果质量门禁主要看的是新代码指标,那么新代码周期的设置一旦不同,同一份代码的门禁结果,也就可能会跟着不同。在SonarQube里面,新代码的定义可以按照全局、项目,或者是分支的层级来进行配置,而且它会影响到新代码问题,以及相关质量指标的计算。
2026-06-30
SonarQube安全热点怎么审查 SonarQube安全热点状态怎么同步
SonarQube安全热点的审查,以及安全热点状态的同步,是安全扫描被接入研发流程以后,经常会碰到的问题。安全热点并不是已经被确认的漏洞,它是在提示这一段代码涉及到了安全方面比较敏感的逻辑,需要由开发人员,或者是安全人员,去进一步做出判断。在SonarQube的文档里面,也明确地把安全热点和漏洞区分了开来:安全热点需要经过人工的审查以后,再去判断是不是要进行修复;而漏洞通常代表的是已经影响到应用安全,应当被优先去修复的问题。所以,在处理安全热点的时候,不能只是看它的数量有多少,也不能简单地就把它一键关掉。
2026-06-30
SonarQube项目权限怎么设置 SonarQube项目权限导致成员看不到代码怎么办
SonarQube项目权限的设置,和因为权限问题导致成员看不到代码的处理,需要先分清楚项目到底是Public还是Private。公开的项目,一般来说更容易被访问到,私有的项目,则需要明确地去给用户,或者用户组进行授权。在SonarQube的官方说明里面,私有项目是需要去配置Browse Project和See Source Code这些权限的;如果要查看项目的结构和代码,私有项目的用户,就需要同时具备Browse和See Source Code这两项权限。
2026-06-30
SonarQube怎么管理项目权限 SonarQube项目权限继承关系怎么检查
在SonarQube里,项目权限这件事最容易被理解错的地方,不是按钮在哪里,而是“继承”到底指什么。按官方口径,项目创建时会先套用一套Permission Template,也就是模板默认权限;但模板套上去以后,项目和模板之间并不存在持续联动关系,后面你手工改项目权限、或者再去改模板,本来就不会自动互相跟着变。再加上SonarQube的项目权限本身又不是累加关系,所以很多人看到“模板明明给了权限,项目里却不对”,本质上往往是把“初始化套用”误当成了“持续继承”。
2026-04-29
SonarQube怎么做分支分析 SonarQube分支分析结果怎么和主干对比
很多团队把SonarQube接进流水线以后,主干分析通常很快就能跑起来,但一到分支分析,问题就会集中在两处。一处是不确定分支到底怎么建出来,另一处是不知道分支结果和主干该按什么口径去比。按SonarSource当前官方文档,分支分析从Developer Edition起才提供,分支是在分析时传入sonar.branch.name后创建出来的;而分支和主干的对比,本质上又不是靠手工看两份报告,而是靠Reference branch也就是参考分支,配合New Code口径去做差异判断。把这两层先分清,后面配置和看结果都会顺很多。
2026-04-29

读者也喜欢这些内容:

咨询热线 18015636924