Logback 日志文档导航

📚 Glowxq Base 项目 Logback 日志框架完整文档集

📖 文档清单

1. Logback 核心概念解析 ⭐ 新手必读

适合人群： 初学者、对 Logback 不熟悉的开发者

内容概要：

✅ ConsoleAppender 详解（控制台输出）
✅ RollingFileAppender 详解（滚动文件输出）
✅ Filter 过滤器中的 onMatch 和 onMismatch
✅ 完整配置示例和最佳实践
✅ 常见问题解答

何时查阅：

不知道 ConsoleAppender 和 RollingFileAppender 的区别
不理解 onMatch、onMismatch 的作用
需要快速上手 Logback 配置

2. Logback 转换字符完整参考手册 📋 速查工具

适合人群： 所有开发者（查字典式使用）

内容概要：

📋 完整的转换字符对照表（%d、%p、%t、%m 等）
🎨 彩色日志配置
🔐 日志脱敏示例
📊 MDC 使用示例
⚡ 性能优化建议
🎯 8种实战配置场景

何时查阅：

想知道 %d、%p、%t 等格式符的含义
需要自定义日志输出格式
想实现彩色日志、日志脱敏
不知道如何使用 MDC 上下文

快速查找：

基础转换字符 → 第一章
MDC 使用 → 第四章
彩色日志 → 第六章第2节
日志脱敏 → 第七章（%replace 示例）
性能优化 → 第九章

3. Logback 日志框架完整技术文档 📚 深度指南

适合人群： 进阶开发者、架构师、需要深入理解的人

内容概要：

🏗️ Logback 架构和核心组件
📤 所有 Appender 类型详解
🎭 Layout 和 Encoder 详解
🔍 Filter 过滤器完整说明
🔄 Logger 继承和配置
🎯 MDC 多线程处理
🚀 高级特性（条件配置、变量定义、JMX）
⚡ 性能优化完整方案
🛠️ 故障排查和监控

何时查阅：

需要深入理解 Logback 工作原理
需要配置异步日志、邮件告警
需要实现复杂的过滤逻辑
需要解决生产环境的日志问题
需要进行性能优化

章节导航：

入门 → 第一章、第二章
Appender 完整说明 → 第三章
Filter 详解 → 第五章
MDC 深度使用 → 第七章
异步日志 → 第三章第4节、第九章
性能优化 → 第九章
故障排查 → 第十一章

🎯 快速导航

按需求查找

我想...	推荐文档	章节
快速上手 Logback	核心概念解析	全文
了解日志格式符号	转换字符参考手册	第一~三章
配置文件日志滚动	核心概念解析	第二章第2节
实现彩色日志	转换字符参考手册	第六章第2节
配置异步日志	技术文档	第三章第4节
使用 MDC 追踪	转换字符参考手册	第四章
分离不同级别的日志	核心概念解析	第三章第5节
日志脱敏	转换字符参考手册	第七章
性能优化	技术文档	第九章
故障排查	技术文档	第十一章

按角色查找

角色	推荐阅读顺序
初级开发	1️⃣ 核心概念解析 → 2️⃣ 转换字符参考手册（前6章）
中级开发	1️⃣ 转换字符参考手册 → 2️⃣ 技术文档（第三、六、七章）
高级开发/架构师	1️⃣ 技术文档（全文） → 2️⃣ 转换字符参考手册（第九、十章）
运维人员	1️⃣ 核心概念解析（第二章） → 2️⃣ 技术文档（第十一章）

📁 项目中的 Logback 配置文件

本项目包含三个模块，每个模块都有自己的 logback.xml 配置文件（已添加详细注释）：

1. infr-base-job（定时任务模块）

路径： infr-base-job/src/main/resources/logback.xml

特点：

控制台输出
EagleEye 链路追踪
SpanId 支持
BaseRRLogFilter DEBUG 级别

2. infr-base-admin（管理后台模块）

路径： infr-base-admin/src/main/resources/logback.xml

特点：

控制台输出
双重追踪ID（自定义 tid + EagleEye）
包含文件名和行号（⚠️ 性能影响）
BaseRRLogFilter DEBUG 级别

3. infr-base-service（业务服务模块）

路径： infr-base-service/src/main/resources/logback.xml

特点：

控制台输出
EagleEye 链路追踪
SpanId 支持
MyBatis Plus 工具包日志开启
BaseRRLogFilter DEBUG 级别

🔥 常见场景快速入口

场景1：我要配置生产环境日志

步骤：

场景2：日志格式需要调整

步骤：

查阅：转换字符参考手册 - 第一~三章
复制模板：转换字符参考手册 - 第八章

场景3：需要实现分布式追踪

步骤：

场景4：日志文件占用太多磁盘空间

解决方案：

配置滚动策略：核心概念解析 - 第二章第2节
启用压缩和自动清理
优化日志级别：技术文档 - 第九章第5节

场景5：日志中有敏感信息需要脱敏

步骤：

查看脱敏示例：转换字符参考手册 - 第七章
实现自定义 Converter：技术文档 - 第十章第3节

场景6：日志性能影响了系统

优化步骤：

检查性能杀手：转换字符参考手册 - 第九章
配置异步日志：技术文档 - 第三章第4节
完整优化方案：技术文档 - 第九章

🆘 遇到问题？

常见问题快速查找

问题	解决方案文档	位置
日志不输出	技术文档	第十一章第2节
日志重复输出	技术文档	第十一章第2节
日志文件不滚动	核心概念解析	第七章 Q4
中文乱码	技术文档	第十一章第2节
性能问题	技术文档	第九章 + 第十一章第2节

调试技巧

启用 Logback 调试模式：

xml

<configuration debug="true">
    <!-- 会打印配置解析过程，帮助排查问题 -->
</configuration>

或使用启动参数：

bash

java -Dlogback.debug=true -jar app.jar

📊 文档统计

文档	字数	章节数	示例数	难度
核心概念解析	~8000	7	15+	⭐⭐ 入门
转换字符参考手册	~12000	11	30+	⭐⭐⭐ 中级
技术文档	~15000	11	40+	⭐⭐⭐⭐ 高级

🔗 外部资源

📝 文档维护

创建日期： 2025-12-08
最后更新： 2025-12-08
维护团队： Glowxq 技术团队
适用项目： infr-base（所有模块）

💡 使用建议

首次使用： 按顺序阅读"核心概念解析" → "转换字符参考手册"
日常开发： 将"转换字符参考手册"作为速查工具书
深度学习： 完整阅读"技术文档"
问题排查： 直接跳转到"故障排查"章节

祝编码愉快！🎉

Logback 日志文档导航 ​

📖 文档清单 ​

1. Logback 核心概念解析 ⭐ 新手必读 ​

2. Logback 转换字符完整参考手册 📋 速查工具 ​

3. Logback 日志框架完整技术文档 📚 深度指南 ​

🎯 快速导航 ​

按需求查找 ​

按角色查找 ​

📁 项目中的 Logback 配置文件 ​

1. infr-base-job（定时任务模块） ​

2. infr-base-admin（管理后台模块） ​

3. infr-base-service（业务服务模块） ​

🔥 常见场景快速入口 ​

场景1：我要配置生产环境日志 ​

场景2：日志格式需要调整 ​

场景3：需要实现分布式追踪 ​

场景4：日志文件占用太多磁盘空间 ​

场景5：日志中有敏感信息需要脱敏 ​

场景6：日志性能影响了系统 ​

🆘 遇到问题？ ​

常见问题快速查找 ​

调试技巧 ​

📊 文档统计 ​

🔗 外部资源 ​

📝 文档维护 ​

💡 使用建议 ​

Logback 日志文档导航

📖 文档清单

1. Logback 核心概念解析 ⭐ 新手必读

2. Logback 转换字符完整参考手册 📋 速查工具

3. Logback 日志框架完整技术文档 📚 深度指南

🎯 快速导航

按需求查找

按角色查找

📁 项目中的 Logback 配置文件

1. infr-base-job（定时任务模块）

2. infr-base-admin（管理后台模块）

3. infr-base-service（业务服务模块）

🔥 常见场景快速入口

场景1：我要配置生产环境日志

场景2：日志格式需要调整

场景3：需要实现分布式追踪

场景4：日志文件占用太多磁盘空间

场景5：日志中有敏感信息需要脱敏

场景6：日志性能影响了系统

🆘 遇到问题？

常见问题快速查找

调试技巧

📊 文档统计

🔗 外部资源

📝 文档维护

💡 使用建议