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 Webhook怎么配置 SonarQube Webhook推送失败怎么排查
SonarQube Webhook的配置,和推送失败时的排查,重点并不只是填进去一个回调地址就完成了,而是要去确认这个地址,能够被SonarQube的服务器正常访问到,并且接收的那一端,也能够正确地识别出推送过来的内容。Webhook这个东西,通常是用来把扫描完成、质量门禁的状态这一类结果,推送给Jenkins、GitLab、企业微信、钉钉,或者是公司内部的平台。SonarQube它支持项目这一级,和全局这一级的Webhook配置,项目级的,是可以在项目的设置里面去配,全局级的,则是可以在系统的管理里面去配。
2026-06-30
SonarQube新代码周期怎么设置 SonarQube新代码周期影响门禁结果怎么看
SonarQube新代码周期的设置,以及新代码周期对门禁结果的影响,是很多团队在配置质量门禁时容易忽略的问题。新代码周期并不是一个单纯的日期设置,它决定了哪些代码会被SonarQube当作“新增或修改的代码”来评估。如果质量门禁主要看的是新代码指标,那么新代码周期的设置一旦不同,同一份代码的门禁结果,也就可能会跟着不同。在SonarQube里面,新代码的定义可以按照全局、项目,或者是分支的层级来进行配置,而且它会影响到新代码问题,以及相关质量指标的计算。
2026-06-30
SonarQube安全热点怎么审查 SonarQube安全热点状态怎么同步
SonarQube安全热点的审查,以及安全热点状态的同步,是安全扫描被接入研发流程以后,经常会碰到的问题。安全热点并不是已经被确认的漏洞,它是在提示这一段代码涉及到了安全方面比较敏感的逻辑,需要由开发人员,或者是安全人员,去进一步做出判断。在SonarQube的文档里面,也明确地把安全热点和漏洞区分了开来:安全热点需要经过人工的审查以后,再去判断是不是要进行修复;而漏洞通常代表的是已经影响到应用安全,应当被优先去修复的问题。所以,在处理安全热点的时候,不能只是看它的数量有多少,也不能简单地就把它一键关掉。
2026-06-30
SonarQube项目权限怎么设置 SonarQube项目权限导致成员看不到代码怎么办
SonarQube项目权限的设置,和因为权限问题导致成员看不到代码的处理,需要先分清楚项目到底是Public还是Private。公开的项目,一般来说更容易被访问到,私有的项目,则需要明确地去给用户,或者用户组进行授权。在SonarQube的官方说明里面,私有项目是需要去配置Browse Project和See Source Code这些权限的;如果要查看项目的结构和代码,私有项目的用户,就需要同时具备Browse和See Source Code这两项权限。
2026-06-30
SonarQube怎么管理项目权限 SonarQube项目权限继承关系怎么检查
在SonarQube里,项目权限这件事最容易被理解错的地方,不是按钮在哪里,而是“继承”到底指什么。按官方口径,项目创建时会先套用一套Permission Template,也就是模板默认权限;但模板套上去以后,项目和模板之间并不存在持续联动关系,后面你手工改项目权限、或者再去改模板,本来就不会自动互相跟着变。再加上SonarQube的项目权限本身又不是累加关系,所以很多人看到“模板明明给了权限,项目里却不对”,本质上往往是把“初始化套用”误当成了“持续继承”。
2026-04-29
SonarQube怎么做分支分析 SonarQube分支分析结果怎么和主干对比
很多团队把SonarQube接进流水线以后,主干分析通常很快就能跑起来,但一到分支分析,问题就会集中在两处。一处是不确定分支到底怎么建出来,另一处是不知道分支结果和主干该按什么口径去比。按SonarSource当前官方文档,分支分析从Developer Edition起才提供,分支是在分析时传入sonar.branch.name后创建出来的;而分支和主干的对比,本质上又不是靠手工看两份报告,而是靠Reference branch也就是参考分支,配合New Code口径去做差异判断。把这两层先分清,后面配置和看结果都会顺很多。
2026-04-29

读者也喜欢这些内容:

咨询热线 18015636924