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规则禁用后为何仍触发
在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