SonarQube中文网站 > 使用技巧 > SonarQube代码扫描如何配置 SonarQube扫描规则选择与项目绑定步骤

SonarQube代码扫描如何配置 SonarQube扫描规则选择与项目绑定步骤

发布时间:2025-11-01 14: 04: 00

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

随着技术不断革新发展,如今的软件质量监测,早已告别二十年前的人工审查模式,而是采用一系列质量检测插件或工具进行自动化扫描。SonarQube作为代码质量检测方面的佼佼者,内置了数千条检测规则,且整合了一系列检测工具,我们无需再自己繁琐地整合,它还可生成网页检测报告,让质量检测成为一项快速、精准、简单的工作。那么,SonarQube代码扫描如何配置,SonarQube扫描规则选择与项目绑定步骤是什么呢?

一、SonarQube代码扫描如何配置

SonarQube在进行代码扫描之前,需要先进行以下配置:

1、获取Token。打开SonarQube网页端,点击右上方头像中的“My Account”菜单,再点击Security进入下图所示界面。在该界面的Generate Tokens中,输入token Name,选择Type为“Project Analysis Token”,选择Project为要分析的项目,再在Expires in中选择Token的过期时间,最后点击“Generate”生成并获取项目扫描所需token。

获取Token
图1:获取Token

2、新增项目配置。在要扫描项目的根目录下,创建一个“sonar-project.properties”的扫描配置文件,在其中按照下图所示填写好“sonar.host.url”、“sonar.sources”、“sonar.sourceEncoding”的配置并保存。

项目配置
图2:项目配置

3、在项目根目录下,右键点击“在此处打开PowerShell窗口”,并输入命令“sonar-scanner.bat -D"sonar.projectKey=test" -D"sonar.projectVersion=1.0" -D"sonar.token=sqp_d5cca9b27686d37bc233524ea18d0fb8c9651eff"”,回车运行即可自动开始对“sonar.sources”指定的代码目录进行扫描,并最终生成报告显示在网页上。

这里命令的项目Key和项目版本号、项目Token大家需根据自身项目进行编辑。

启动扫描
图3:启动扫描

二、SonarQube扫描规则选择与项目绑定步骤

在进行扫描之前,我们还需要将SonarQube的扫描规则和项目进行绑定,合理的规则配置可以避免误报和漏报,而正确的项目绑定则能确保扫描结果与团队的质量标准保持一致。下面介绍如何将扫描规则与项目进行绑定:

1、在网页端点击Quality Profiles菜单,点击Create按钮创建一条质量配置,创建时可以选择扩展已有的配置,也可以选择复制已有的配置,或选择创建空白的配置。我们选择“Extend an existing quality profile”扩展配置,在Language设置代码语言,在Parent选择被扩展的父级配置,最后点击Create完成创建。

新建Quality Profile
图4:新建Quality Profile

2、继承已有的Quality Profile之后,其中对应的规则也会相应继承过来。接下来点击Change Projects按钮,切换到All选项卡,勾选要绑定的项目,点击Close按钮即可将规则绑定该项目,后续便可在项目根目录下进行扫描。

绑定项目
图5:绑定项目

以上就是关于SonarQube代码扫描如何配置,SonarQube扫描规则选择与项目绑定步骤的教程。完成扫描的各项配置以及规则绑定项目只是代码质量管理的起点,要让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