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

Java中Apache日志扩展模块自定义格式的配置与实践

风浩吖_9592

风浩吖_9592

发布时间:2026-03-26 14:27:12

|

963人浏览过

|

来源于php中文网

原创

Apache Commons Logging 仅为日志门面,不提供格式化功能,日志格式需在Log4j2、Logback或JUL等具体实现中配置;其自动绑定优先级为Log4j2→Log4j1→SLF4J→JUL,未引入实现时回退至功能较弱的JUL。

apache commons logging 本身不提供日志格式化功能,也不支持自定义输出格式——它只是一个日志门面(facade),负责桥接底层日志实现(如 log4j、logback、jul)。真正控制日志格式的是你实际使用的日志框架。因此,“apache 日志扩展模块自定义格式”这个说法容易引起误解,实践中需明确:配置日志格式,要落在 log4j2、logback 或 jul 等具体实现上,而非 commons logging。

确认底层日志实现是关键一步

Commons Logging 会自动发现并绑定 classpath 中可用的日志实现,优先级一般为:Log4j2 → Log4j1 → SLF4J → JUL。若未显式引入任何实现,它将回退到 JDK 自带的 java.util.logging(JUL),而 JUL 的格式定制能力较弱、配置繁琐。

  • 检查项目依赖,确认实际生效的是哪个日志框架(例如 Maven 中是否有 log4j-core、log4j-api 或 logback-classic)
  • 在类路径下查找对应配置文件:Log4j2 对应 log4j2.xml 或 log4j2.json;Logback 对应 logback.xml;JUL 对应 logging.properties
  • 可通过代码验证:System.out.println(LogManager.getFactory()); 查看实际工厂类型

Log4j2 中自定义 PatternLayout(最常用场景)

Log4j2 提供强大灵活的 PatternLayout,通过 pattern 字符串控制每行日志内容与样式。常见占位符包括 %d(日期)、%p(级别)、%c(Logger 名)、%m(日志消息)、%ex(异常栈)等。

  • 示例 pattern:%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5p %c{1} - %m%n
  • 支持 ANSI 颜色(需启用 ConsoleAppender 的 follow="true" 和系统支持):%d %highlight{%p}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green, DEBUG=blue, TRACE=black}
  • 可嵌入 MDC(Mapped Diagnostic Context)字段,如 %X{traceId} %X{userId},前提是业务代码已调用 MDC.put("traceId", "xxx")

Logback 中使用 PatternLayoutEncoder

Logback 同样以 pattern 为核心,但配置结构略有不同:需在 appender 内嵌套 encoder 并指定 pattern。

  • 典型配置片段:
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
      <encoder>
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
      </encoder>
    </appender>
  • 支持转换器(converter)扩展,例如自定义时间格式、脱敏手机号:%replace(%msg){'1[3-9]\d{9}', '***'}
  • 结合 AsyncAppender 可提升高并发下的日志性能,但注意异步上下文(如 MDC)需显式设置 includeCallerData="true" 或使用 LoggingEventAsyncDisruptor

避免踩坑:Commons Logging 的典型误区

开发者常因混淆门面与实现,导致格式配置无效或行为异常。

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

  • 只引入 commons-logging 而未添加任意日志实现 → 实际走 JUL,pattern 配置被忽略
  • 同时引入 Log4j2 和 Logback → 类路径冲突,可能触发警告甚至绑定失败,应排除其中一个
  • 使用 LogFactory.getLog(Class) 获取 logger,却误以为能直接调用 setLevel() 或 addAppender() → 这些方法属于具体实现,Commons Logging 接口不提供
  • MDC 在多线程/异步场景(如 CompletableFuture、@Async)中不自动传递 → 需借助 ThreadLocal 手动复制,或使用框架适配器(如 Spring 的 ThreadPoolTaskExecutor 设置 copyInheritableThreadLocals=true)

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

AionClaw
AionClaw Hot

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

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

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

更多
java
java

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

10897

2023.06.15

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

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

8022

2023.07.05

java自学难吗
java自学难吗

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

6952

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1416

2023.08.02

java有什么用
java有什么用

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

2869

2023.08.02

java在线网站
java在线网站

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

20151

2023.08.03

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

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

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