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如何配置SAML
软件代码质量管理从以前到现在经历了翻天覆地的变化,从最初的手工代码审查,到自动化测试工具的出现,再到如今SonarQube等综合检测应用的兴起,软件代码检测越来越正规、专业,带来的是软件市场水平整体的提高。并且SonarQube平台后续还支持通过SAML协议单点登录,大大便利了各大企业内部使用,成为如今众多企业进行代码检测的主要工具。那么SonarQube是代码测试工具吗,SonarQube如何配置SAML,接下来一起来了解一下。
2025-09-22
SonarQube分支分析是什么 SonarQube分支扫描配置与差异报告生成方法
在团队协作开发项目中,多分支并行开发已成为常态,每个不同的团队成员各自负责一部分功能或模块开发,最终由团队Leader统一审阅代码并合并分支。在此过程中,如何把控分支代码质量是一项重难点工作,如果全部代码由Leader人为查看,很容易出现错漏,因此常常需要结合SonarQube等带有分支分析的自动化代码检测工具进行。本文将重点向大家说明SonarQube分支分析是什么,SonarQube分支扫描配置与差异报告生成方法,帮助大家解决这一难点。
2025-09-22
SonarQube代码扫描如何启动 SonarQube代码扫描参数配置步骤
SonarQube提供的代码质量检测功能,在当今“两天一个版本”的快节奏开发环境中,已从“锦上添花”变成了“开发必需”,让我们摆脱传统的“先上线再修复”的恶性循环,它能在代码提交后精准捕捉潜在漏洞和安全问题,将质量问题扼杀在萌芽阶段。检测前我们需先启动扫描程序,下面讲解一下SonarQube代码扫描如何启动,SonarQube代码扫描参数配置步骤。
2025-09-22
SonarQube代码扫描显示cwe吗 SonarQube代码扫描怎么手动上传
互联互通的网络时代,安全性成为软件的主要检测项目之一,越多人使用的应用,它的安全性就越需要被保障,因为任何潜在的漏洞都可能被恶意利用,导致数据泄露、服务中断甚至更严重的系统性风险。因此,我们需要使用SonarQube等检测工具,它们既能帮助开发团队在早期发现代码BUG,还能识别CWE标准的安全漏洞。本文将详细回答大家关于SonarQube代码扫描显示cwe吗,SonarQube代码扫描怎么手动上传的疑问,帮助大家提升代码质量与安全等级。
2025-09-22
SonarQube扫描检测不到新代码 SonarQube扫描规则和检查点
SonarQube的代码扫描主要分为旧代码扫描和新代码扫描两部分,并会在报告中清晰呈现新代码与旧代码的对比分析结果,利用新旧代码的区分,帮助我们将注意力更多放在新代码中,而不被历史遗留问题分散注意力。但是,根据SonarQube设置不同,大家可能会遇到新代码未被正确识别或扫描规则和检查点未正确匹配等情况,因此本文将深入探讨SonarQube扫描检测不到新代码,SonarQube扫描规则和检查点的问题,确保大家得到的扫描结果全面可靠。
2025-09-22
SonarQube扫描原理 SonarQube扫描一定要先build么
什么是静态代码分析?静态代码分析指无需运行代码便可通过分析、检查代码的语法、结构、依赖等来检查代码的正确性,SonarQube的代码检测功能正是建立在静态代码分析原理之上。既然是分析静态代码,那SonarQube扫描前需要先编译代码吗?这个问题看似简单,实际涉及SonarQube扫描底层原理。想要获取正确代码检测结果,建议读者一起跟随本文,了解SonarQube扫描原理,SonarQube扫描一定要先build么的问题答案。
2025-09-22

读者也喜欢这些内容:

咨询热线 18015636924