java 日志格式 pattern 通过配置日志框架（如 logback 或 log4j2）中的 patternlayout 来实现，核心是使用以 % 开头的转换词来定义输出内容。例如在 logback.xml 中设置 <pattern>%d{yyyy-mm-dd hh:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> 即可生成包含时间、线程、级别、类名和消息的标准格式。不同的日志框架支持略有差异，但基本逻辑一致。
Logback 中如何配置标准日志格式
在 Logback 中，通过 PatternLayout 的 pattern 属性直接指定字符串模板。常用的转换词包括 %d 表示日期，%t 表示线程名，%level 表示日志级别，%logger 表示 logger 名称，%msg 表示日志消息，%n 表示换行。配置时只需在 <appender></appender> 内部添加 <layout class="ch.qos.logback.classic.PatternLayout"></layout> 并设置 <pattern></pattern> 即可生效。
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
import ch.qos.logback.core.ConsoleAppender;
public class LogbackConfigExample {
public static void main(String[] args) {
LoggerContext context = (LoggerContext) org.slf4j.LoggerFactory.getILoggerFactory();
ConsoleAppender<String> appender = new ConsoleAppender<>();
appender.setContext(context);
PatternLayoutEncoder encoder = new PatternLayoutEncoder();
encoder.setContext(context);
encoder.setPattern("%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n");
encoder.start();
appender.setEncoder(encoder);
appender.start();
org.slf4j.Logger logger = context.getLogger("com.example.Test");
logger.info("Test message with custom pattern");
}
}
上述代码演示了如何在 Java 中动态配置 Logback 的日志格式。运行后控制台将输出类似 "10:00:00.123 [main] INFO c.e.T - Test message with custom pattern" 的日志。其中 %d{HH:mm:ss.SSS} 精确到毫秒，%-5level 左对齐且占5位，%logger{36} 限制类名最大长度为36字符。这种配置方式适用于需要程序化控制日志输出的场景。
立即学习“Java免费学习笔记（深入）”；
Log4j2 中如何配置自定义日志格式
Log4j2 使用 PatternLayout 配合 pattern 属性进行格式化，其语法与 Logback 高度相似但部分转换词不同。例如 %C 表示完整类名，%M 表示方法名，%L 表示行号。在 XML 配置中，需在 <console></console> 或 <file></file> 的 layout 元素下设置 pattern 属性。相比 Logback，Log4j2 还支持更复杂的条件格式和 JSON 布局。
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.Configurator;
public class Log4j2ConfigExample {
public static void main(String[] args) {
String pattern = "%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %class{36}:%L - %msg%n";
Configurator.initialize(null, "<Configuration status=\"WARN\">\n" +
" <Appenders>\n" +
" <Console name=\"Console\" target=\"SYSTEM_OUT\">\n" +
" <PatternLayout pattern=\"" + pattern + "\"/>\n" +
" </Console>\n" +
" </Appenders>\n" +
" <Loggers>\n" +
" <Root level=\"info\">\n" +
" <AppenderRef ref=\"Console\"/>\n" +
" </Root>\n" +
" </Loggers>\n" +
"</Configuration>");
Logger logger = LogManager.getLogger(Log4j2ConfigExample.class);
logger.info("Log4j2 test message");
}
}
该示例展示了 Log4j2 的动态配置方式。运行后输出格式为 "2023-10-01 10:00:00.123 [main] INFO com.example.Log4j2ConfigExample:15 - Log4j2 test message"。其中 %class{36} 截取类名前36个字符，%L 显示源码行号。注意 Log4j2 的 %c 默认行为与 Logback 的 %logger 略有不同，前者显示完整包名+类名，后者默认只显示最后一级类名。实际使用时需根据需求调整转换词组合。
当日志消息中包含特殊字符时 pattern 如何处理
当日志消息中包含 %、{、} 等特殊字符时，Logback 和 Log4j2 会将其视为普通文本处理，不会触发格式转换。但若消息本身包含未转义的 % 符号，可能导致后续字符被误解析为转换词。为避免此问题，建议在消息中使用双 %% 表示单个百分号，或在代码中对消息进行预处理。此外，某些框架支持 %replace() 等函数对消息内容进行正则替换，可进一步增强安全性。
