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规则集怎么调整 SonarQube规则禁用后为何仍触发
在SonarQube里,所谓“规则集”对应的其实是Quality Profile,也就是按语言生效的一组启用规则。真正容易出问题的地方,通常不是不会点启用和禁用,而是项目绑错了Profile、子Profile继承了父Profile、改完以后没有重新分析,结果看起来像是“规则明明关了却还在触发”。官方文档也明确说明,问题是在分析时根据项目关联的Quality Profile被产生出来的。
2026-03-25
SonarQube覆盖率为0怎么排查 SonarQube覆盖率报告路径怎么填
SonarQube里覆盖率显示为0,很多时候不是测试根本没跑,而是覆盖率报告没有在扫描前生成、扫描器没找到文件、报告格式和参数名不匹配,或者报告里的路径和当前项目根目录对不上。官方文档写得很明确,SonarQube本身不会生成覆盖率报告,它只负责导入外部工具生成的报告,所以排查顺序一定要先看报告有没有生成,再看扫描器有没有正确读到。
2026-03-25
SonarQube扫描结果为空怎么办 SonarQube扫描日志怎么定位原因
SonarQube扫描结果为空,先不要急着重跑。更常见的原因不是平台坏了,而是扫描范围没有真正命中代码文件,或者代码被排除规则、源码管理忽略规则、主代码与测试代码分类错误一起过滤掉了。Sonar官方文档明确说明,扫描器会先根据分析范围决定要分析哪些文件,而调试日志会直接打印哪些源文件和测试文件被索引,所以排查顺序应先看范围,再看日志。
2026-03-25
SonarQube质量门禁怎么设置 SonarQube质量门禁不生效怎么办
在SonarQube里做质量门禁,最容易出问题的不是条件不会填,而是门禁条件、项目绑定和流水线阻断没有放在同一条链路里看。SonarSource官方说明很明确,质量门禁本质上是一组条件,既可以基于新代码,也可以基于整体代码;实例里还有默认质量门禁,未单独绑定的项目会先继承默认门禁。
2026-03-25
SonarQube怎么导入新项目 SonarQube项目Key怎么填写
在SonarQube里,新项目导入本质上有两条路,一条是先在平台里手工创建项目,再接扫描;另一条是第一次分析时直接把项目带上来,服务器会在收到一个不存在的项目Key后自动创建项目。官方文档也明确说明,手工创建时项目名和项目Key是本地项目创建的必要参数,而首次分析同样依赖项目Key完成识别。
2026-03-25
SonarQube质量门禁怎么配置 SonarQube质量门禁不触发怎么排查
质量门禁的价值不在于看板上多一个红绿灯,而在于它能把代码扫描结果变成可执行的准入规则。配置时要先把门禁规则定清楚,再把项目和门禁绑定好,最后在流水线里把门禁结果接回来并决定是否中断构建,否则你会看到门禁已经失败但流水线照样放行的情况。
2026-03-02

读者也喜欢这些内容:

咨询热线 18015636924