SonarQube中文网站 > 技术问题 > SonarQube代码扫描如何启动 SonarQube代码扫描参数配置步骤

SonarQube代码扫描如何启动 SonarQube代码扫描参数配置步骤

发布时间:2025-09-25 08: 00: 00

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

SonarQube提供的代码质量检测功能,在当今“两天一个版本”的快节奏开发环境中,已从“锦上添花”变成了“开发必需”,让我们摆脱传统的“先上线再修复”的恶性循环,它能在代码提交后精准捕捉潜在漏洞和安全问题,将质量问题扼杀在萌芽阶段。检测前我们需先启动扫描程序,下面讲解一下SonarQube代码扫描如何启动,SonarQube代码扫描参数配置步骤。

一、SonarQube代码扫描如何启动

SonarQube下载后并不携带扫描程序,我们要自行在官方文档中下载Sonar Scanner扫描仪程序,要扫描时便可按照下列步骤进行启动。

1、添加到环境变量中。为了在项目根目录下随时随地启动扫描程序,首先需要将扫描程序“sonar-scanner.bat”所在路径添加到系统Path环境变量中,如图所示。

加入扫描环境变量
图1:加入扫描环境变量

2、添加项目配置文件。扫描需要在项目的根目录下,添加名为“sonar-project.properties”的配置,在其中注明要扫描的文件路径、扫描版本号、扫描项目名等关键信息。

项目扫描配置
图2:项目扫描配置

3、命令行启动。在项目根目录下打开终端,输入命令“sonar-scanner.bat -D"sonar.projectKey=你的项目名" -D"sonar.sources=." -D"sonar.host.url=你的网页地址" -D"sonar.token=你的token"”,回车即可运行程序开始扫描,如图3所示。

扫描启动命令
图3:扫描启动命令

二、SonarQube代码扫描参数配置步骤

在“sonar-project.properties”配置文件中设置扫描配置,优点在于无需每次都重复配置,缺点是不够灵活,有部分配置需要手动修改。因此我们可以使用扫描参数+配置文件的形式进行扫描,将不会变动的参数放在配置文件中,将经常变动的参数,如版本号放在扫描参数中。以下是扫描参数的配置步骤:

1、扫描参数相比于配置文件参数,在参数名上多了“-D”,如配置文件参数为“sonar.projectName=demo”,则扫描命令参数为“-D”sonar.projectName=demo””,使用时只需配置在“sonar-scanner.bat”命令的后方即可。

扫描参数对比
图4:扫描参数对比

2、一些经常修改的扫描参数有:sonar.projectVersion(版本号)、​​sonar.sources(扫描目录)、sonar.exclusions(排除目录)、sonar.sourceEncoding(编码)、sonar.scanner.javaOpts(内存),具体可选参数可在“https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/analysis-parameters/”网站上查阅。

扫描参数文档
图5:扫描参数文档

3、扫描参数可在四个地方进行配置,分别是全局参数配置、项目配置文件、扫描仪工具配置、扫描参数,它们的使用优先级从左到右逐渐增加,扫描参数的优先级是最高的,相同的参数会优先采用,覆盖前面三项配置的相同参数值。

参数优先顺序
图6:参数优先顺序

通过本文的介绍,我们详细了解了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