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页面却没有显示用例数量,问题可能出在报告路径、格式或分析状态上。“SonarQube怎么导入测试执行报告SonarQube测试执行数据导入后没有显示如何检查”需要结合测试工具和扫描方式处理。下面以Python项目、pytest和SonarScanner CLI为例,说明配置与排查步骤。测试执行报告记录用例结果和耗时,与覆盖率报告需要分别导入。
2026-09-30
SonarQube怎么查看认知复杂度 SonarQube认知复杂度过高如何定位具体代码
SonarQube中的Cognitive Complexity用于衡量代码控制流程的理解难度,与Cyclomatic Complexity侧重统计执行路径不同。项目中的认知复杂度可以在Measures中查看,并逐步下钻到目录和文件;如果要继续定位具体函数,则需要结合认知复杂度规则产生的Issue进行检查。项目指标很高却找不到对应Issue时,还要区分“累计指标”和“单个函数规则阈值”这两种计算结果。
2026-08-31
SonarQube怎么导入外部Issue报告 SonarQube外部Issue导入后不显示如何排查
SonarQube可以把第三方静态分析工具产生的问题导入项目,与自身检测出的Issue一起查看。对于已经适配SonarQube的工具,可以使用对应的报告参数;其他分析器可以转换成Generic Issue格式或SARIF格式再导入。报告文件已经生成但SonarQube页面没有显示问题时,要先确认Scanner实际读取到了报告,再检查报告格式、源码路径、分析范围和当前查看的分支,不能只看报告文件是否存在。
2026-08-31
SonarQube后台任务怎么查看 SonarQube后台任务执行失败怎么排查
SonarScanner显示EXECUTION SUCCESS,项目页面却迟迟没有新结果,这种情况并不少见。扫描器只是把分析报告上传到服务器,后续还要交给Compute Engine处理。后台任务没跑完,结果就不会正式进入项目。
2026-07-30
SonarQube质量配置怎么复制 SonarQube质量配置复制后规则数量不一致怎么办
SonarQube里的“质量配置”通常指Quality Profile,它决定某种编程语言启用哪些检查规则。团队想给新项目沿用现有标准时,复制一份很方便。麻烦也常出在这里。明明从同一个配置复制,过一段时间再看,规则数量却对不上。遇到这种情况,别急着一条条手工补,先确认用的是复制、继承,还是跨服务器导入。
2026-07-30
SonarQube Webhook怎么配置 SonarQube Webhook推送失败怎么排查
SonarQube Webhook的配置,和推送失败时的排查,重点并不只是填进去一个回调地址就完成了,而是要去确认这个地址,能够被SonarQube的服务器正常访问到,并且接收的那一端,也能够正确地识别出推送过来的内容。Webhook这个东西,通常是用来把扫描完成、质量门禁的状态这一类结果,推送给Jenkins、GitLab、企业微信、钉钉,或者是公司内部的平台。SonarQube它支持项目这一级,和全局这一级的Webhook配置,项目级的,是可以在项目的设置里面去配,全局级的,则是可以在系统的管理里面去配。
2026-06-30

读者也喜欢这些内容:

咨询热线 18015636924