讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 日志系统中怎么通过自定义 Layout 过滤并脱敏敏感字段(如手机号)

小辰姑娘_1454

小辰姑娘_1454

发布时间:2026-08-01 09:52:05

|

216人浏览过

|

来源于php中文网

原创

Java日志脱敏核心是拦截格式化过程,在序列化前精准处理:Log4j2重写toSerializable()获取结构化参数,Logback覆盖doLayout()解析argumentArray或MDC,推荐用StructuredArgument传递键值对并按schema脱敏,避免正则误伤。

java 日志系统中怎么通过自定义 layout 过滤并脱敏敏感字段(如手机号)

Java 日志系统中,通过自定义 Layout 实现敏感字段(如手机号)的过滤与脱敏,核心在于拦截日志事件的格式化过程,在序列化为字符串前对日志内容做针对性处理。Log4j2 和 Logback 是主流框架,实现方式略有不同,但思路一致:不修改业务代码,也不依赖正则全局替换(易误伤、难维护),而是基于结构化日志上下文或日志参数本身做精准识别与替换。

Log4j2 中继承 PatternLayout 并重写 toSerializable

Log4j2 的 PatternLayout 负责将 LogEvent 转为字符串。你可以继承它,在 toSerializable() 方法中获取日志参数(Object[])或上下文数据(ThreadContext),对含敏感信息的字段进行脱敏。

  • 重写 toSerializable(LogEvent event),先调用父类生成原始字符串,再对关键字段(如 JSON body、Map 参数)做解析和替换
  • 更推荐方式:使用 event.getContextData().toMap() 或 event.getMessage().getParameters() 获取结构化数据,避免字符串解析风险
  • 例如手机号匹配规则:1[3-9]\d{9},脱敏为 138****1234;注意仅在明确标记为“敏感”或字段名匹配(如 "phone"、"mobile")时才处理,防止误脱敏
  • 需配合 PatternLayout 的 %m(消息)、%X(上下文)等占位符,确保原始结构可被程序识别

Logback 中扩展 LayoutBase 并覆盖 doLayout

Logback 的 Layout 是抽象类,自定义时通常继承 LayoutBase 或直接实现 Layout<ILoggingEvent>。关键是在 doLayout(ILoggingEvent event) 中介入日志渲染流程。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 从 event.getArgumentArray() 获取方法参数,或用 event.getMDC() 提取 MDC 中的敏感键(如 "userPhone")
  • 若日志消息是 JSON 字符串(如 SLF4J 的 logger.info("req:{}", jsonStr)),可用轻量 JSON 解析器(如 Jackson TreeModel)定位并替换字段值,再序列化回字符串
  • 避免在 doLayout 中做耗时操作(如网络请求、复杂正则遍历全文),否则拖慢整个日志链路
  • 建议将脱敏逻辑封装为独立工具类,支持白名单字段、掩码规则配置(如保留前3后4位),便于测试和复用

统一推荐:用 StructuredArguments + 自定义 Appender 配合 Layout

比起在 Layout 层硬解析字符串,更健壮的方式是让业务主动传递结构化数据,并由 Layout 或 Appender 按 schema 处理。SLF4J 3.x 支持 StructuredArgument,Log4j2/Logback 均可识别。

立即学习“Java免费学习笔记(深入)”;

  • 业务侧写法:logger.info("user login", keyValue("phone", "13812345678"), keyValue("id", 1001))
  • 自定义 Layout 可检查 event.getMessage() 是否为 StructuredArgument 类型,直接遍历键值对,对已知敏感 key("phone"、"idCard")应用脱敏函数
  • 这种方式无需猜测字段位置,不依赖字符串格式,也规避了正则误匹配问题,适合微服务间日志标准化场景
  • 配合日志采集端(如 Filebeat、Logstash)做二次校验,形成“编码层脱敏 + 传输层过滤”双保险

注意事项与避坑点

实际落地时,几个细节决定是否可靠:

  • 脱敏不能影响日志可读性和排错能力——比如把所有数字都替成 ****,会掩盖真实问题;应只针对明确语义的字段
  • 多线程环境下,确保脱敏工具类无共享可变状态,避免脏数据或并发异常
  • 异步日志(AsyncAppender)中,LogEvent 可能被复用,不要在 Layout 中修改原始 event 对象
  • 测试必须覆盖边界情况:空值、null 字段、嵌套 JSON、超长手机号(如带国际码 +86138...)、非十一位数字等

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9877

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7022

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6192

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1064

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

888

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1296

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2589

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19911

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn