SonarQube中文网站 > 技术问题 > SonarQube如何加白名单功能 SonarQube如何清理数据

SonarQube如何加白名单功能 SonarQube如何清理数据

发布时间:2025-07-27 10: 00: 00

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

白名单可以将部分代码片段或内置规则排除在SonarQube的扫描范围之外,从而避免问题频繁报错或忽略已知但无需修复的问题,通过合理配置白名单,开发人员可以确保扫描结果更加精准,减少不必要的修复工作,同时减少报告数据量,使SonarQube的检查更加贴合实际项目需求。下面本文将向大家讲述SonarQube如何加白名单功能,SonarQube如何清理数据,从而让SonarQube更好地服务于开发流程中。

一、SonarQube如何加白名单功能

有时候,我们在代码中使用了第三方库函数,而这些函数片段中某些代码可能会匹配到SonarQube的规则进而产生问题,但这些问题并不需要告警,此时可以按照以下步骤将它们添加到添加到白名单中。

1、项目配置。在项目中添加“sonar-project.properties”扫描配置文件,并在配置中添加相关配置,如“sonar.exclusions=**/test/**, **/libs/**”,这个配置的作用在于使项目下的test和libs目录下全部文件不参与代码扫描,星号为通配符,表示全部。

项目文件排除
图1:项目文件排除

2、界面全局设置。打开网页端的Administration管理界面,在“General Settings/Analysis Scope”设置界面中,可以添加全局各项内容的白名单,支持正则表达式匹配。

可以添加的白名单有:“File Exclusions”文件扫描白名单、“Code Coverage Exclusions”代码覆盖率白名单、“Duplication Exclusions”重复率白名单、“Issue Exclusions”问题匹配白名单。

分析范围设置
图2:分析范围设置

3、临时设置。对于已经产生问题的情况,可以在SonarQube的项目Issues界面中,选择对应问题,将状态更改为“False Positive”,表示分析工具误判,问题并不存在,跳过该问题。

标记问题误判
图3:标记问题误判

二、SonarQube如何清理数据

即使为部分代码增加了白名单,但随着扫描次数的不断增加,SonarQube的数据库还是会慢慢存储大量数据,这会导致服务各项性能下降,如搜索变慢、报告加载变慢等,因此对一些历史数据,应当定期清理。

1、进入Administration管理页面,点击Projects导航栏,可以看到当前登录用户可管理的全部项目,勾选想清除的项目,点击“Delete”按钮便可删除该项目的全部扫描数据。

删除项目
图4:删除项目

2、除了项目外,我们还可以在外部调用Web API的“api/project_analyses/delete”和“api/projects/delete”接口,来定期自动清理数据,前者能删除指定项目的旧分析记录,后者能清理长期未使用或已下线的项目,减少资源占用。

删除相关API
图5:删除相关API

白名单的作用在于精细化管理项目扫描配置,将不需要扫描和需要扫描的文件代码分离开来。随着项目的不断迭代,会有越来越多的文件代码需要添加到白名单中,因此白名单和历史数据都需要定期修改或清理。本文对于SonarQube如何加白名单功能,SonarQube如何清理数据的讲解,就能够有效帮助大家实现这一需求。

展开阅读全文

︾

标签:

读者也访问过这里:
SonarQube
从一开始就生成高质量的代码
立即购买
最新文章
SonarQube怎么配置代码扫描 SonarQube扫描任务执行失败怎么解决
在本机能扫,放进CI就失败,先查两边运行环境;日志已经上传报告,项目页面却没更新,就去看后台处理。SonarQube扫描涉及几个连续环节,不能只凭流水线变红判断故障。配置时把项目标识、扫描目录和凭据对应好,出错后再沿日志找到中断位置,通常比反复修改整份配置更有效。
2026-10-30
SonarQube怎么进行代码质量分析 SonarQube代码分析结果异常怎么办
代码提交后,SonarQube里的问题数量突然增加,或者测试已经通过,覆盖率却仍然是零,这些情况未必都由代码修改引起。扫描目录、测试报告和规则配置都会影响结果,扫描成功与质量门禁通过也有区别。使用时应让分析任务对应到明确的代码版本,再查看具体问题。下面以已部署SonarQube、使用SonarScanner CLI分析Python项目为例,界面名称按英文版说明。
2026-10-30
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

读者也喜欢这些内容:

咨询热线 18015636924