1. 日志系统简介

1.1 什么是日志

日志是应用程序运行时产生的记录信息，它类似于程序的"黑匣子"，记录了程序运行过程中的各种状态、事件和错误。日志对于程序开发、调试、监控和维护都有着至关重要的作用。

在软件开发生命周期中，日志系统承担着以下关键职责：

• 问题诊断：帮助开发人员定位和修复程序错误
• 系统监控：了解应用程序的运行状态和性能
• 安全审计：记录关键操作和安全事件
• 用户行为分析：了解用户如何使用应用程序
• 性能分析：识别性能瓶颈和优化机会

1.2 为什么使用日志框架

在早期的开发中，程序员通常使用System.out.println()或System.err.println()打印信息到控制台。然而，这种方法存在明显缺点：

1. 无法分级：无法区分错误、警告、信息等不同级别
2. 难以配置：无法轻松改变日志的输出目标
3. 性能问题：即使在生产环境中不需要这些信息，也会执行字符串拼接操作
4. 格式不统一：每个开发者可能使用不同的格式记录信息
5. 难以过滤：无法根据需要筛选特定类型的日志

日志框架解决了这些问题，提供了一套完整的日志记录机制，使开发者可以：

• 定义不同的日志级别
• 配置多种输出目标（控制台、文件、数据库等）
• 自定义日志格式
• 运行时动态调整日志行为
• 提高日志记录的性能

1.3 Java中的常见日志框架

Java生态系统中的主要日志框架包括：

1. Log4j：Apache的经典日志框架，广泛使用
2. Log4j 2：Log4j的重写版本，提供了更好的性能和特性
3. Logback：由Log4j创始人开发，旨在替代Log4j
4. java.util.logging (JUL)：Java标准库自带的日志系统
5. Simple Logging Facade for Java (SLF4J)：不是具体实现，而是日志框架的抽象层
6. Commons Logging：Apache的另一个日志抽象层

本指南将重点介绍Log4j框架，它是Java世界中最流行和成熟的日志框架之一。

2. Log4j概述

2.1 Log4j简介

Log4j（Log for Java）是Apache软件基金会的一个开源项目，由Ceki Gülcü于1996年创建。作为Java平台上最早和最成熟的日志框架之一，Log4j为众多Java应用程序提供了强大的日志功能。

Log4j的设计基于三个核心概念：

1. Logger：日志记录器，负责捕获日志信息
2. Appender：日志输出目标，决定日志信息发送到哪里
3. Layout：日志格式化器，控制日志信息的格式

这种模块化设计使Log4j非常灵活，可以适应各种日志需求。

2.2 Log4j的版本历史

Log4j的主要版本包括：

• Log4j 1.x：原始版本，现已不再维护（自2015年8月起）
• Log4j 2.x：完全重写的新版本，提供更好的性能和功能

值得注意的是，2021年12月爆发了严重的Log4j漏洞（CVE-2021-44228，也称为"Log4Shell"），这促使许多应用升级到了更安全的版本。目前，建议使用Log4j 2的最新版本。

2.3 Log4j与Log4j 2的主要区别

Log4j 2相比Log4j 1.x有以下主要改进：

1. 性能提升：使用了更高效的锁机制和垃圾回收友好的设计
2. 更强的API：提供了lambda表达式支持，减少不必要的字符串构建
3. 插件架构：可以更容易地扩展功能
4. 自动重载配置：配置文件修改后自动重新加载
5. Java 8支持：利用Java 8的新特性
6. 更丰富的过滤选项：可以更精细地控制日志输出
7. 无垃圾记录模式：可以显著减少垃圾收集压力

在本指南中，我们将同时介绍Log4j 1.x和Log4j 2.x，但会更加侧重于推荐使用的Log4j 2.x。

3. Log4j架构与核心组件

3.1 Logger（日志记录器）

Logger是Log4j的入口点，应用程序通过Logger对象记录日志信息。每个Logger都有一个名称，通常与类的全限定名相对应，形成一个层次结构。

例如，名为"com.example.MyApp"的Logger是名为"com.example"的Logger的子Logger。这种层次结构允许配置从父Logger继承到子Logger。

获取Logger实例的典型方式：

Log4j 1.x:

import org.apache.log4j.Logger;public class MyClass {// 获取与当前类关联的Loggerprivate static final Logger logger = Logger.getLogger(MyClass.class);public void doSomething() {logger.debug("Debug message");logger.info("Info message");logger.warn("Warning message");logger.error("Error message");}
}

Log4j 2.x:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;public class MyClass {// 获取与当前类关联的Loggerprivate static final Logger logger = LogManager.getLogger(MyClass.class);public void doSomething() {logger.debug("Debug message");logger.info("Info message");logger.warn("Warning message");logger.error("Error message");}
}

3.2 日志级别（Level）

Log4j定义了几个日志级别，用于控制日志输出的详细程度：

级别	说明
ALL	最低级别，启用所有日志记录
TRACE	比DEBUG更详细的信息（Log4j 2中引入）
DEBUG	调试信息，开发环境中使用
INFO	普通信息，程序正常运行状态的信息
WARN	警告信息，潜在的问题
ERROR	错误信息，不会导致程序终止的错误
FATAL	致命错误，会导致程序终止的严重问题
OFF	最高级别，关闭所有日志记录

日志级别的优先级：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

当设置Logger的级别后，只有等于或高于该级别的日志消息才会被记录。例如，如果设置级别为INFO，则DEBUG和TRACE级别的日志会被忽略。

3.3 Appender（输出目标）

Appender负责将日志消息发送到目标位置。Log4j支持多种Appender，可以同时向多个目标输出日志：

• ConsoleAppender：输出到控制台
• FileAppender：输出到文件
• RollingFileAppender：输出到文件，并按照一定规则进行日志滚动
• DailyRollingFileAppender：按日期滚动日志文件
• JDBCAppender：输出到数据库
• SMTPAppender：通过电子邮件发送日志
• SocketAppender：输出到远程服务器
• SyslogAppender：输出到系统日志
• AsyncAppender：异步处理日志（提高性能）

Log4j 2增加了更多Appender类型，如Kafka Appender、NoSQL Appender等。

3.4 Layout（布局）

Layout控制日志消息的格式。Log4j提供了几种内置的Layout：

• SimpleLayout：简单格式，只包含日志级别和消息
• PatternLayout：使用类似于C语言printf函数的模式字符串自定义格式
• HTMLLayout：输出为HTML表格格式
• XMLLayout：输出为XML格式
• JSONLayout（Log4j 2）：输出为JSON格式

PatternLayout是最常用的布局，它允许使用转换模式（如%d表示日期，%p表示日志级别）来格式化日志消息。

3.5 Filter（过滤器）

Filter用于对日志事件进行细粒度控制，决定是否接受或拒绝某个日志事件。Log4j 2的过滤器功能特别强大，提供了多种内置过滤器：

• ThresholdFilter：基于日志级别过滤
• TimeFilter：基于时间过滤
• BurstFilter：限制短时间内的日志数量
• RegexFilter：基于正则表达式过滤
• MarkerFilter：基于日志标记过滤

3.6 组件之间的关系

Log4j的组件之间的关系可以简化为：

Logger -> Appender -> Layout

1. 应用程序调用Logger记录日志消息
2. Logger检查消息的级别，决定是否继续处理
3. 如果继续处理，Logger将消息传递给所有关联的Appender
4. 每个Appender使用关联的Layout格式化消息
5. 格式化后的消息被输出到Appender指定的目标

在Log4j 2中，Filter可以在这个流程的不同阶段进行干预，提供更精细的控制。

4. Log4j基本使用

4.1 添加Log4j依赖

要在项目中使用Log4j，首先需要添加相应的依赖。

Maven依赖（Log4j 1.x）:

<dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>1.2.17</version>
</dependency>

Maven依赖（Log4j 2.x）:

<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId><version>2.19.0</version>
</dependency>
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-core</artifactId><version>2.19.0</version>
</dependency>

Gradle依赖（Log4j 1.x）:

implementation 'log4j:log4j:1.2.17'

Gradle依赖（Log4j 2.x）:

implementation 'org.apache.logging.log4j:log4j-api:2.19.0'
implementation 'org.apache.logging.log4j:log4j-core:2.19.0'

4.2 创建并使用Logger

Log4j 1.x示例:

import org.apache.log4j.Logger;public class LogExample {// 获取Logger实例private static final Logger logger = Logger.getLogger(LogExample.class);public static void main(String[] args) {// 记录不同级别的日志logger.trace("这是一条TRACE日志"); // Log4j 1.x没有TRACE级别logger.debug("这是一条DEBUG日志");logger.info("这是一条INFO日志");logger.warn("这是一条WARN日志");logger.error("这是一条ERROR日志");logger.fatal("这是一条FATAL日志");// 捕获异常并记录try {int result = 10 / 0; // 故意引发异常} catch (Exception e) {logger.error("计算过程中发生错误", e);}}
}

Log4j 2.x示例:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;public class LogExample {// 获取Logger实例private static final Logger logger = LogManager.getLogger(LogExample.class);public static void main(String[] args) {// 记录不同级别的日志logger.trace("这是一条TRACE日志");logger.debug("这是一条DEBUG日志");logger.info("这是一条INFO日志");logger.warn("这是一条WARN日志");logger.error("这是一条ERROR日志");logger.fatal("这是一条FATAL日志");// 捕获异常并记录try {int result = 10 / 0; // 故意引发异常} catch (Exception e) {logger.error("计算过程中发生错误", e);}// Log4j 2支持lambda表达式（避免不必要的字符串构建）logger.debug(() -> "当前用户数量: " + getUserCount());}private static int getUserCount() {// 假设这是一个耗时的操作return 42;}
}

4.3 日志配置简介

Log4j的配置主要通过配置文件实现，它定义了Logger、Appender和Layout之间的关系，以及它们的具体属性。

Log4j 1.x支持的配置文件格式:

• Properties文件（log4j.properties）
• XML文件（log4j.xml）

Log4j 2.x支持的配置文件格式:

• XML文件（log4j2.xml）
• JSON文件（log4j2.json或log4j2.jsn）
• YAML文件（log4j2.yaml或log4j2.yml）
• Properties文件（log4j2.properties）
• 编程方式配置

配置文件会在下一节详细介绍。

5. Log4j配置详解

5.1 Log4j 1.x配置

5.1.1 Properties文件配置（log4j.properties）

Properties文件是Log4j 1.x最常用的配置方式，下面是一个基本的示例：

# 设置根Logger的级别和输出目标
log4j.rootLogger=INFO, console, file# 控制台输出配置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n# 文件输出配置
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=logs/myapp.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n# 为特定包设置日志级别
log4j.logger.com.example.dao=DEBUG
log4j.logger.org.hibernate=WARN

配置说明：

• log4j.rootLogger定义了根Logger的级别（INFO）和两个输出目标（console和file）
• 接下来定义了两个Appender（console和file）及其属性
• 最后为特定的包（com.example.dao和org.hibernate）配置了日志级别

5.1.2 XML文件配置（log4j.xml）

同样的配置以XML格式表示：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration debug="false"><!-- 控制台输出配置 --><appender name="console" class="org.apache.log4j.ConsoleAppender"><layout class="org.apache.log4j.PatternLayout"><param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" /></layout></appender><!-- 文件输出配置 --><appender name="file" class="org.apache.log4j.RollingFileAppender"><param name="File" value="logs/myapp.log" /><param name="MaxFileSize" value="10MB" /><param name="MaxBackupIndex" value="10" /><layout class="org.apache.log4j.PatternLayout"><param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" /></layout></appender><!-- 为特定包设置日志级别 --><logger name="com.example.dao"><level value="DEBUG" /></logger><logger name="org.hibernate"><level value="WARN" /></logger><!-- 设置根Logger --><root><level value="INFO" /><appender-ref ref="console" /><appender-ref ref="file" /></root>
</log4j:configuration>

5.2 Log4j 2.x配置

5.2.1 XML文件配置（log4j2.xml）

Log4j 2.x最常用的是XML配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN"><Appenders><!-- 控制台输出配置 --><Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/></Console><!-- 文件输出配置 --><RollingFile name="RollingFile" fileName="logs/app.log"filePattern="logs/app-%d{MM-dd-yyyy}-%i.log.gz"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy /><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="20"/></RollingFile></Appenders><Loggers><!-- 为特定包设置日志级别 --><Logger name="com.example.dao" level="debug" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Logger><Logger name="org.hibernate" level="warn" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Logger><!-- 设置根Logger --><Root level="info"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Root></Loggers>
</Configuration>

配置说明：

• <Configuration>是根元素，status属性定义了Log4j内部日志的级别
• <Appenders>部分定义输出目标
• <Loggers>部分定义日志记录器及其级别和输出目标
• additivity属性控制是否将日志事件传递给父Logger

5.2.2 其他配置方式

JSON配置示例（log4j2.json）:

{"configuration": {"status": "warn","appenders": {"Console": {"name": "Console","target": "SYSTEM_OUT","PatternLayout": {"pattern": "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"}},"RollingFile": {"name": "RollingFile","fileName": "logs/app.log","filePattern": "logs/app-%d{MM-dd-yyyy}-%i.log.gz","PatternLayout": {"pattern": "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"},"Policies": {"TimeBasedTriggeringPolicy": {},"SizeBasedTriggeringPolicy": {"size": "10 MB"}},"DefaultRolloverStrategy": {"max": "20"}}},"loggers": {"logger": [{"name": "com.example.dao","level": "debug","additivity": "false","appender-ref": [{"ref": "Console"},{"ref": "RollingFile"}]},{"name": "org.hibernate","level": "warn","additivity": "false","appender-ref": [{"ref": "Console"},{"ref": "RollingFile"}]}],"root": {"level": "info","appender-ref": [{"ref": "Console"},{"ref": "RollingFile"}]}}}
}

YAML配置示例（log4j2.yaml）:

Configuration:status: warnAppenders:Console:name: Consoletarget: SYSTEM_OUTPatternLayout:pattern: "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"RollingFile:name: RollingFilefileName: logs/app.logfilePattern: "logs/app-%d{MM-dd-yyyy}-%i.log.gz"PatternLayout:pattern: "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"Policies:TimeBasedTriggeringPolicy: {}SizeBasedTriggeringPolicy:size: "10 MB"DefaultRolloverStrategy:max: "20"Loggers:Logger:- name: com.example.daolevel: debugadditivity: falseAppenderRef:- ref: Console- ref: RollingFile- name: org.hibernatelevel: warnadditivity: falseAppenderRef:- ref: Console- ref: RollingFileRoot:level: infoAppenderRef:- ref: Console- ref: RollingFile

编程方式配置示例:

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.ConsoleAppender;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.ConfigurationFactory;
import org.apache.logging.log4j.core.config.ConfigurationSource;
import org.apache.logging.log4j.core.config.builder.api.*;
import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration;public class Log4jConfiguration {public static void main(String[] args) {ConfigurationBuilder<BuiltConfiguration> builder = ConfigurationBuilderFactory.newConfigurationBuilder();// 创建控制台AppenderAppenderComponentBuilder console = builder.newAppender("Console", "CONSOLE").addAttribute("target", ConsoleAppender.Target.SYSTEM_OUT);console.add(builder.newLayout("PatternLayout").addAttribute("pattern", "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"));builder.add(console);// 创建文件AppenderLayoutComponentBuilder layoutBuilder = builder.newLayout("PatternLayout").addAttribute("pattern", "%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n");ComponentBuilder triggeringPolicy = builder.newComponent("Policies").addComponent(builder.newComponent("TimeBasedTriggeringPolicy")).addComponent(builder.newComponent("SizeBasedTriggeringPolicy").addAttribute("size", "10MB"));AppenderComponentBuilder rollingFile = builder.newAppender("RollingFile", "RollingFile").addAttribute("fileName", "logs/app.log").addAttribute("filePattern", "logs/app-%d{MM-dd-yyyy}-%i.log.gz").add(layoutBuilder).addComponent(triggeringPolicy);builder.add(rollingFile);// 创建Loggerbuilder.add(builder.newLogger("com.example.dao", Level.DEBUG).add(builder.newAppenderRef("Console")).add(builder.newAppenderRef("RollingFile")).addAttribute("additivity", false));// 设置根Loggerbuilder.add(builder.newRootLogger(Level.INFO).add(builder.newAppenderRef("Console")).add(builder.newAppenderRef("RollingFile")));// 激活配置Configuration config = builder.build();LoggerContext ctx = (LoggerContext) LogManager.getContext(false);ctx.start(config);}
}

5.3 常用配置模式和最佳实践

5.3.1 多环境配置

项目通常需要在不同环境（开发、测试、生产）使用不同的日志配置。可以通过以下方式实现：

使用系统属性或环境变量:

在Log4j 2.x配置中，可以使用占位符引用系统属性或环境变量：

<Configuration status="WARN"><Appenders><RollingFile name="RollingFile" fileName="${sys:logPath}/app.log"filePattern="${sys:logPath}/app-%d{MM-dd-yyyy}-%i.log.gz"><!-- ... --></RollingFile></Appenders><Loggers><Root level="${env:LOG_LEVEL:-info}"><!-- ... --></Root></Loggers>
</Configuration>

在启动应用时设置系统属性：

java -DlogPath=/var/log/myapp -DLOG_LEVEL=debug -jar myapp.jar

使用不同的配置文件:

为每个环境创建单独的配置文件，例如：

• log4j2-dev.xml
• log4j2-test.xml
• log4j2-prod.xml

然后在启动时指定要使用的配置文件：

java -Dlog4j.configurationFile=log4j2-prod.xml -jar myapp.jar

5.3.2 异步日志配置

对于高性能应用，使用异步日志可以避免日志操作阻塞主业务线程：

使用AsyncAppender (Log4j 1.x):

<appender name="async" class="org.apache.log4j.AsyncAppender"><param name="BufferSize" value="500"/><appender-ref ref="file"/>
</appender><root><level value="INFO"/><appender-ref ref="async"/>
</root>

使用Async Loggers (Log4j 2.x):

<!-- 全异步配置 -->
<Configuration status="WARN"><Properties><Property name="disruptor">WORKER</Property></Properties><!-- ... -->
</Configuration>

或者在启动时设置系统属性：

java -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -jar myapp.jar

混合异步（部分Logger异步）:

<Configuration status="WARN"><Appenders><!-- ... --></Appenders><Loggers><!-- 异步Logger --><AsyncLogger name="com.example.dao" level="debug" additivity="false"><AppenderRef ref="RollingFile"/></AsyncLogger><!-- 同步Logger --><Logger name="org.hibernate" level="warn" additivity="false"><AppenderRef ref="Console"/></Logger><Root level="info"><AppenderRef ref="Console"/></Root></Loggers>
</Configuration>

5.3.3 日志滚动策略

合理的日志滚动策略可以避免单个日志文件过大，便于管理和分析：

基于大小滚动:

<RollingFile name="RollingFile" fileName="logs/app.log"filePattern="logs/app-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="20"/>
</RollingFile>

基于时间滚动:

<RollingFile name="RollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/></Policies><DefaultRolloverStrategy max="30"/>
</RollingFile>

组合策略:

<RollingFile name="RollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}-%i.log.gz"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="100"/>
</RollingFile>

6. Layout与日志格式

6.1 PatternLayout详解

PatternLayout是最常用的布局，它允许使用模式字符串灵活定义日志格式。以下是常用的转换说明符：

转换符	描述
%c, %logger	输出日志事件的Logger名称
%C, %class	输出发出日志请求的类名
%d, %date	输出日志事件的日期时间，可以指定格式如%d{yyyy-MM-dd HH:mm:ss.SSS}
%F, %file	输出发出日志请求的文件名
%l, %location	输出日志事件的位置信息（类名、方法、文件名、行号）
%L, %line	输出发出日志请求的行号
%m, %msg, %message	输出日志消息
%n	输出平台相关的换行符
%p, %level	输出日志事件的级别
%r, %relative	输出自应用启动到创建日志事件所经过的毫秒数
%t, %thread	输出产生日志事件的线程名
%T, %tid, %threadId	输出线程ID（Log4j 2）
%x, %NDC	输出与日志事件关联的嵌套诊断上下文（NDC）
%X, %MDC	输出与日志事件关联的映射诊断上下文（MDC），格式为%X{key}
%%	输出百分号

Log4j 1.x的PatternLayout示例:

# 基本日期、级别、Logger名、消息格式
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c - %m%n# 包含线程名和类位置的详细格式
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c{1}:%L - %m%n# 带有MDC信息的格式
log4j.appender.file.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{1} [%X{userId}] - %m%n

Log4j 2.x的PatternLayout示例:

<!-- 基本格式 -->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><!-- 高亮控制台输出 -->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %highlight{%-5level} %c{1.} - %msg%n"/><!-- 彩色控制台输出 -->
<PatternLayout><Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight{%-5level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green, DEBUG=blue, TRACE=bg_white} [%t] %logger{36} - %msg%n</Pattern>
</PatternLayout><!-- 格式化JSON日志 -->
<PatternLayout pattern="%d{ISO8601} %-5p [%t] %c{1} %notEmpty{[RequestId=%X{requestId}]} %notEmpty{[UserId=%X{userId}]} - %m%n"/>

6.2 其他常用Layout

HTMLLayout:

输出为HTML表格格式，方便在浏览器中查看。

<!-- Log4j 1.x -->
<appender name="html" class="org.apache.log4j.FileAppender"><param name="File" value="logs/application.html" /><layout class="org.apache.log4j.HTMLLayout"><param name="Title" value="Application Log" /><param name="LocationInfo" value="true" /></layout>
</appender><!-- Log4j 2.x -->
<Appenders><File name="HTML" fileName="logs/application.html"><HTMLLayout charset="UTF-8" title="Application Log" locationInfo="true"/></File>
</Appenders>

JSONLayout (Log4j 2):

输出为JSON格式，便于日志采集和分析系统处理。

<Appenders><File name="JSON" fileName="logs/application.json"><JSONLayout complete="false" compact="true" eventEol="true" properties="true" stacktraceAsString="true"/></File>
</Appenders>

示例输出:

{"instant" : {"epochSecond" : 1591277876,"nanoOfSecond" : 123456000},"thread" : "main","level" : "INFO","loggerName" : "com.example.MyApp","message" : "Application started","endOfBatch" : false,"loggerFqcn" : "org.apache.logging.log4j.spi.AbstractLogger","contextMap" : {"userId" : "12345"},"threadId" : 1,"threadPriority" : 5
}

XMLLayout:

输出为XML格式。

<!-- Log4j 1.x -->
<appender name="xml" class="org.apache.log4j.FileAppender"><param name="File" value="logs/application.xml" /><layout class="org.apache.log4j.xml.XMLLayout"><param name="LocationInfo" value="true" /></layout>
</appender><!-- Log4j 2.x -->
<Appenders><File name="XML" fileName="logs/application.xml"><XMLLayout complete="true" compact="false" properties="true" locationInfo="true"/></File>
</Appenders>

6.3 自定义Layout

如果内置的Layout不能满足需求，可以创建自定义Layout。

Log4j 1.x自定义Layout示例:

import org.apache.log4j.Layout;
import org.apache.log4j.spi.LoggingEvent;public class CustomLayout extends Layout {@Overridepublic String format(LoggingEvent event) {StringBuilder sb = new StringBuilder();sb.append("[").append(event.getLevel().toString()).append("] - ").append(event.getRenderedMessage()).append(" {").append(event.getLoggerName()).append("} ").append(new java.util.Date(event.getTimeStamp())).append("\n");return sb.toString();}@Overridepublic boolean ignoresThrowable() {return false;}@Overridepublic void activateOptions() {// 初始化布局的选项}
}

Log4j 2.x自定义Layout示例:

import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.*;
import org.apache.logging.log4j.core.layout.AbstractStringLayout;import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;@Plugin(name = "CustomLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE)
public class CustomLayout extends AbstractStringLayout {protected CustomLayout(Charset charset) {super(charset);}@Overridepublic String toSerializable(LogEvent event) {StringBuilder sb = new StringBuilder();sb.append("[").append(event.getLevel().toString()).append("] - ").append(event.getMessage().getFormattedMessage()).append(" {").append(event.getLoggerName()).append("} ").append(new java.util.Date(event.getTimeMillis())).append("\n");return sb.toString();}@PluginFactorypublic static CustomLayout createLayout(@PluginAttribute(value = "charset", defaultString = "UTF-8") Charset charset) {return new CustomLayout(charset != null ? charset : StandardCharsets.UTF_8);}
}

7. 高级特性

7.1 MDC与NDC

MDC（Mapped Diagnostic Context）和NDC（Nested Diagnostic Context）是Log4j提供的两种上下文机制，用于在日志中包含额外的上下文信息。

MDC（映射诊断上下文）:

MDC是一个键值对映射，通常用于记录与当前线程相关的信息，如用户ID、请求ID等。

// Log4j 1.x
import org.apache.log4j.Logger;
import org.apache.log4j.MDC;public class MdcExample {private static final Logger logger = Logger.getLogger(MdcExample.class);public void processRequest(String userId, String requestId) {// 设置MDCMDC.put("userId", userId);MDC.put("requestId", requestId);try {logger.info("开始处理请求");// 业务逻辑...logger.info("请求处理完成");} finally {// 清理MDCMDC.remove("userId");MDC.remove("requestId");// 或者清除所有MDC: MDC.clear();}}
}

// Log4j 2.x
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;  // ThreadContext是Log4j 2中MDC的实现public class MdcExample {private static final Logger logger = LogManager.getLogger(MdcExample.class);public void processRequest(String userId, String requestId) {// 设置ThreadContextThreadContext.put("userId", userId);ThreadContext.put("requestId", requestId);try {logger.info("开始处理请求");// 业务逻辑...logger.info("请求处理完成");} finally {// 清理ThreadContextThreadContext.remove("userId");ThreadContext.remove("requestId");// 或者清除所有ThreadContext: ThreadContext.clearAll();}}
}

在PatternLayout中引用MDC值：

%X{userId} - 输出MDC中键为"userId"的值

NDC（嵌套诊断上下文）:

NDC是一个栈结构，用于记录嵌套的上下文信息。

// Log4j 1.x
import org.apache.log4j.Logger;
import org.apache.log4j.NDC;public class NdcExample {private static final Logger logger = Logger.getLogger(NdcExample.class);public void processRequest() {NDC.push("Request-Start");logger.info("开始处理请求");try {// 进入更深层次的处理processPayment();} finally {NDC.pop();  // 移除"Request-Start"logger.info("请求处理完成");NDC.remove();  // 清空整个NDC栈}}private void processPayment() {NDC.push("Payment-Processing");logger.info("正在处理支付");// 支付处理逻辑...NDC.pop();  // 移除"Payment-Processing"logger.info("支付处理完成");}
}

// Log4j 2.x
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;  // ThreadContext也用于NDCpublic class NdcExample {private static final Logger logger = LogManager.getLogger(NdcExample.class);public void processRequest() {ThreadContext.push("Request-Start");logger.info("开始处理请求");try {// 进入更深层次的处理processPayment();} finally {ThreadContext.pop();  // 移除"Request-Start"logger.info("请求处理完成");ThreadContext.clearStack();  // 清空整个NDC栈}}private void processPayment() {ThreadContext.push("Payment-Processing");logger.info("正在处理支付");// 支付处理逻辑...ThreadContext.pop();  // 移除"Payment-Processing"logger.info("支付处理完成");}
}

在PatternLayout中引用NDC：

%x - 输出完整的NDC堆栈

7.2 过滤器（Filter）

过滤器允许对日志事件进行精细控制，决定是否接受、拒绝或中立地处理日志事件。

Log4j 1.x中的过滤器:

Log4j 1.x中，过滤器主要通过实现org.apache.log4j.spi.Filter接口并添加到Appender中来实现。

import org.apache.log4j.spi.Filter;
import org.apache.log4j.spi.LoggingEvent;public class UserIdFilter extends Filter {private String acceptedUserId;public void setAcceptedUserId(String acceptedUserId) {this.acceptedUserId = acceptedUserId;}@Overridepublic int decide(LoggingEvent event) {String userId = (String) event.getMDC("userId");if (userId != null && userId.equals(acceptedUserId)) {return Filter.ACCEPT;  // 接受日志事件} else {return Filter.NEUTRAL;  // 交给下一个过滤器决定}}
}

配置示例：

log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=logs/user123.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n# 添加自定义过滤器
log4j.appender.file.filter.1=com.example.UserIdFilter
log4j.appender.file.filter.1.acceptedUserId=123

Log4j 2.x中的过滤器:

Log4j 2中的过滤器更为强大，可以在不同级别应用（Logger、Appender、Configuration）。

ThresholdFilter示例:

<Appenders><Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/></Console>
</Appenders>

RegexFilter示例:

<Appenders><File name="ErrorFile" fileName="logs/errors.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><RegexFilter regex=".*ERROR.*" onMatch="ACCEPT" onMismatch="DENY"/></File>
</Appenders>

时间过滤器示例:

<Appenders><Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><TimeFilter start="00:00:00" end="08:59:59" onMatch="ACCEPT" onMismatch="DENY"/></Console>
</Appenders>

自定义过滤器示例:

@Plugin(name = "CustomFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE)
public class CustomFilter extends AbstractFilter {private final String requiredMdcKey;private final String requiredValue;private CustomFilter(String requiredMdcKey, String requiredValue, Result onMatch, Result onMismatch) {super(onMatch, onMismatch);this.requiredMdcKey = requiredMdcKey;this.requiredValue = requiredValue;}@Overridepublic Result filter(LogEvent event) {String mdcValue = event.getContextData().getValue(requiredMdcKey);if (mdcValue != null && mdcValue.equals(requiredValue)) {return onMatch;}return onMismatch;}@PluginFactorypublic static CustomFilter createFilter(@PluginAttribute("requiredMdcKey") String requiredMdcKey,@PluginAttribute("requiredValue") String requiredValue,@PluginAttribute("onMatch") String match,@PluginAttribute("onMismatch") String mismatch) {Result onMatch = Result.toResult(match, Result.NEUTRAL);Result onMismatch = Result.toResult(mismatch, Result.DENY);return new CustomFilter(requiredMdcKey, requiredValue, onMatch, onMismatch);}
}

配置使用自定义过滤器：

<Appenders><Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><CustomFilter requiredMdcKey="userId" requiredValue="123" onMatch="ACCEPT" onMismatch="DENY"/></Console>
</Appenders>

7.3 参数化日志

参数化日志是一种高效的日志记录方式，它避免了不必要的字符串拼接，只有当日志级别满足输出条件时才会执行格式化操作。

Log4j 1.x中的参数化日志:

Log4j 1.x本身不提供参数化日志，通常使用条件判断避免字符串拼接：

if (logger.isDebugEnabled()) {logger.debug("User " + user.getName() + " logged in from " + user.getIpAddress());
}

Log4j 2.x中的参数化日志:

Log4j 2提供了内置的参数化日志功能：

// 推荐的参数化日志方式
logger.debug("User {} logged in from {}", user.getName(), user.getIpAddress());// 带异常的参数化日志
try {// 业务逻辑...
} catch (Exception e) {logger.error("Failed to process transaction for user {}", userId, e);
}// 使用lambda表达式（仅在日志级别符合时计算结果）
logger.debug("User statistics: {}", () -> calculateExpensiveStatistics(user));

这种方式在日志级别不满足条件时，不会执行参数计算和字符串格式化，从而提高性能。

7.4 异步日志

异步日志可以显著提高应用程序性能，尤其是在日志量大的情况下。

Log4j 1.x中的AsyncAppender:

# 定义文件Appender
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=logs/app.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n# 定义异步Appender
log4j.appender.async=org.apache.log4j.AsyncAppender
log4j.appender.async.BufferSize=500
log4j.appender.async.appender-ref=file# 使用异步Appender
log4j.rootLogger=INFO, async

Log4j 2.x中的异步日志:

Log4j 2提供了三种异步日志方案：

1. AsyncAppender：将其他Appender包装为异步

<Appenders><File name="File" fileName="logs/app.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/></File><Async name="Async"><AppenderRef ref="File"/><BufferSize>500</BufferSize></Async>
</Appenders><Loggers><Root level="info"><AppenderRef ref="Async"/></Root>
</Loggers>

2. 异步Logger：部分Logger使用异步方式

<Configuration><Appenders><File name="File" fileName="logs/app.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/></File></Appenders><Loggers><!-- 异步Logger --><AsyncLogger name="com.example.async" level="debug"><AppenderRef ref="File"/></AsyncLogger><!-- 同步根Logger --><Root level="info"><AppenderRef ref="File"/></Root></Loggers>
</Configuration>

3. 全异步Loggers：所有Logger都使用异步方式

在启动时设置系统属性：

java -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -jar myapp.jar

或者在配置文件中：

<Configuration status="WARN"><Properties><Property name="Log4jContextSelector">org.apache.logging.log4j.core.async.AsyncLoggerContextSelector</Property></Properties><!-- 其他配置... -->
</Configuration>

异步日志的性能调优:

<Async name="Async"><AppenderRef ref="File"/><BufferSize>1024</BufferSize><DiscardingThreshold>INFO</DiscardingThreshold><BlockingQueueFactory class="org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory"><WaitStrategy class="com.lmax.disruptor.SleepingWaitStrategy"/></BlockingQueueFactory>
</Async>

• BufferSize：队列大小，默认为256
• DiscardingThreshold：当队列剩余容量小于阈值时，丢弃低于特定级别的事件
• BlockingQueueFactory：队列实现，默认使用Disruptor
• WaitStrategy：等待策略，影响性能和CPU使用率

7.5 日志分割与归档

合理的日志分割和归档策略可以避免单个日志文件过大，并保留历史日志以供分析。

Log4j 1.x中的日志分割:

# 基于大小的滚动日志
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=logs/app.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n# 基于日期的滚动日志
log4j.appender.daily=org.apache.log4j.DailyRollingFileAppender
log4j.appender.daily.File=logs/app.log
log4j.appender.daily.DatePattern='.'yyyy-MM-dd
log4j.appender.daily.layout=org.apache.log4j.PatternLayout
log4j.appender.daily.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

Log4j 2.x中的日志分割:

Log4j 2提供了更灵活的滚动策略：

<Appenders><!-- 基于大小的滚动 --><RollingFile name="SizeRollingFile" fileName="logs/app.log"filePattern="logs/app-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="10"/></RollingFile><!-- 基于时间的滚动 --><RollingFile name="TimeRollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/></Policies><DefaultRolloverStrategy max="30"/></RollingFile><!-- 组合策略 --><RollingFile name="CombinedRollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}-%i.log.gz"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="100"><!-- 删除30天前的日志 --><Delete basePath="logs" maxDepth="1"><IfFileName glob="app-*.log.gz"/><IfLastModified age="30d"/></Delete></DefaultRolloverStrategy></RollingFile>
</Appenders>

高级归档策略:

<RollingFile name="AdvancedRollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}-%i.log.gz"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies><DefaultRolloverStrategy max="100"><!-- 分层删除策略 --><Delete basePath="logs" maxDepth="2"><IfFileName glob="*/app-*.log.gz"><IfLastModified age="60d"/></IfFileName></Delete></DefaultRolloverStrategy>
</RollingFile>

8. 性能优化

8.1 日志性能的影响因素

日志操作可能对应用程序性能产生显著影响，主要受以下因素影响：

1. I/O操作: 写入文件系统或网络的I/O操作是日志性能瓶颈的主要来源。
2. 字符串格式化: 大量的字符串拼接和格式化会增加CPU和内存开销。
3. 线程竞争: 多线程环境下对共享资源的竞争可能导致性能下降。
4. 垃圾回收: 过多的临时对象创建会增加GC压力。

8.2 性能优化策略

8.2.1 选择合适的日志级别

在生产环境中，通常不应开启DEBUG或TRACE级别的日志，除非是为了临时排查问题。

// 不好的实践 - 无论日志级别如何，都会执行字符串拼接
logger.debug("User profile data: " + user.generateLargeProfileData());// 更好的实践 - 检查日志级别
if (logger.isDebugEnabled()) {logger.debug("User profile data: " + user.generateLargeProfileData());
}// 最佳实践 (Log4j 2) - 使用参数化日志
logger.debug("User profile data: {}", user.generateLargeProfileData());// 更进一步 (Log4j 2) - 使用lambda表达式延迟计算
logger.debug("User profile data: {}", () -> user.generateLargeProfileData());

8.2.2 使用异步日志

如前所述，使用异步日志可以显著提高应用程序性能，尤其是在I/O密集型场景下。

8.2.3 减少临时对象创建

使用参数化日志格式可以减少临时字符串对象的创建：

// 不好的实践 - 创建多个临时字符串对象
logger.debug("Processing order " + orderId + " for customer " + customerId);// 好的实践 - 减少临时对象创建
logger.debug("Processing order {} for customer {}", orderId, customerId);

8.2.4 使用缓冲写入

对于文件写入，使用缓冲可以减少I/O操作次数：

<Appenders><File name="File" fileName="logs/app.log" bufferedIO="true" bufferSize="8192"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/></File>
</Appenders>

8.2.5 避免过度日志

记录过多的日志不仅会影响性能，还会导致有用信息被淹没。应该仅记录对问题诊断和系统监控有价值的信息。

8.2.6 使用日志批处理

在某些高性能场景下，可以考虑批量处理日志：

// 创建批量日志实体
List<LogEvent> eventBatch = new ArrayList<>();
for (Transaction tx : transactions) {if (tx.needsLogging()) {eventBatch.add(createLogEvent(tx));}
}// 批量写入日志
logBatch(eventBatch);

8.2.7 性能测试对比

以下是一个简单的日志性能测试对比：

日志方式	操作/秒	内存使用	CPU使用
同步文件日志	50,000	中等	中等
异步文件日志	450,000	低	低
同步控制台日志	150,000	低	高
非参数化日志	200,000	高	高
参数化日志	600,000	低	低

8.3 性能监控

Log4j 2提供了内置的性能监控机制：

<Configuration status="warn" name="MyApp"><Appenders><!-- 其他Appender... --><!-- JMX监控Appender --><JMX name="JMX"/></Appenders><Loggers><!-- 监控Log4j 2内部状态 --><Logger name="org.apache.logging.log4j.status" level="trace" additivity="false"><AppenderRef ref="Console"/></Logger><Root level="info"><AppenderRef ref="File"/><AppenderRef ref="JMX"/></Root></Loggers>
</Configuration>

使用JConsole或VisualVM可以监控Log4j的性能指标。

9. Log4j与其他框架集成

9.1 与Spring Boot集成

Spring Boot默认使用Logback作为日志框架，但可以配置为使用Log4j 2。

步骤1: 排除Spring Boot的默认日志依赖并添加Log4j 2依赖。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions>
</dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

步骤2: 在src/main/resources目录下创建log4j2.xml或log4j2.properties配置文件。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN"><Appenders><Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"/></Console><RollingFile name="RollingFile" fileName="logs/app.log"filePattern="logs/app-%d{yyyy-MM-dd}-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy/><SizeBasedTriggeringPolicy size="10 MB"/></Policies></RollingFile></Appenders><Loggers><Logger name="org.springframework" level="info" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Logger><Logger name="com.example.myapp" level="debug" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Logger><Root level="warn"><AppenderRef ref="Console"/><AppenderRef ref="RollingFile"/></Root></Loggers>
</Configuration>

步骤3: 在Spring Boot应用中使用Log4j 2:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class MyApplication {private static final Logger logger = LogManager.getLogger(MyApplication.class);public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);logger.info("Application started");}
}

9.2 与SLF4J集成

SLF4J (Simple Logging Facade for Java) 是一个日志门面，允许在部署时绑定到不同的日志实现。

Log4j 1.x与SLF4J集成:

<!-- SLF4J API -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.36</version>
</dependency><!-- SLF4J适配器 -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId><version>1.7.36</version>
</dependency><!-- Log4j实现 -->
<dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>1.2.17</version>
</dependency>

Log4j 2.x与SLF4J集成:

<!-- SLF4J API -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.36</version>
</dependency><!-- Log4j 2 API 和 Core -->
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId><version>2.17.2</version>
</dependency>
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-core</artifactId><version>2.17.2</version>
</dependency><!-- Log4j 2的SLF4J绑定 -->
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-slf4j-impl</artifactId><version>2.17.2</version>
</dependency>

使用SLF4J记录日志:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class MyService {private static final Logger logger = LoggerFactory.getLogger(MyService.class);public void doSomething() {logger.debug("Doing something...");try {// 业务逻辑...logger.info("Operation completed successfully");} catch (Exception e) {logger.error("Failed to process transaction", e);}}
}

9.3 与Log4j 1.x迁移到Log4j 2.x

如果需要从Log4j 1.x迁移到Log4j 2.x，可以使用兼容层来简化过程：

<!-- Log4j 2 API 和 Core -->
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId><version>2.17.2</version>
</dependency>
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-core</artifactId><version>2.17.2</version>
</dependency><!-- Log4j 1.x 兼容层 -->
<dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-1.2-api</artifactId><version>2.17.2</version>
</dependency>

这允许使用Log4j 1.x API的代码在Log4j 2.x环境中运行，同时可以逐步更新代码以使用新的API。

配置转换:

Log4j 2提供了一个工具可以将Log4j 1.x的log4j.properties或log4j.xml配置转换为Log4j 2.x的XML配置：

java -cp log4j-core-2.17.2.jar org.apache.logging.log4j.core.config.ConfigurationConverter path/to/log4j.properties path/to/log4j2.xml

9.4 与其他常见框架集成

9.4.1 与Hibernate集成

Hibernate可以配置为使用Log4j进行日志记录：

# 对于Log4j 1.x
hibernate.show_sql=false
hibernate.format_sql=true
hibernate.use_sql_comments=true
hibernate.connection.autocommit=true
hibernate.dialect=org.hibernate.dialect.MySQLDialect
hibernate.connection.driver_class=com.mysql.jdbc.Driver
hibernate.connection.url=jdbc:mysql://localhost:3306/mydatabase
hibernate.connection.username=username
hibernate.connection.password=password# 日志配置
log4j.logger.org.hibernate=INFO
log4j.logger.org.hibernate.SQL=DEBUG
log4j.logger.org.hibernate.type=TRACE
log4j.logger.org.hibernate.cache=DEBUG

对于Log4j 2.x，在XML配置中添加：

<Loggers><Logger name="org.hibernate" level="info" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="File"/></Logger><Logger name="org.hibernate.SQL" level="debug" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="File"/></Logger><Logger name="org.hibernate.type" level="trace" additivity="false"><AppenderRef ref="Console"/><AppenderRef ref="File"/></Logger>
</Loggers>

9.4.2 与MyBatis集成

MyBatis可以配置为使用Log4j记录SQL语句和参数：

<!-- MyBatis配置 -->
<configuration><settings><!-- 对于Log4j 1.x --><setting name="logImpl" value="LOG4J"/><!-- 对于Log4j 2.x --><setting name="logImpl" value="LOG4J2"/><setting name="logPrefix" value="MyBatis-"/></settings><!-- 其他配置... -->
</configuration>

对于Log4j配置：

<Loggers><Logger name="org.apache.ibatis" level="info" additivity="false"><AppenderRef ref="Console"/></Logger><Logger name="java.sql" level="debug" additivity="false"><AppenderRef ref="Console"/></Logger><Logger name="MyBatis-com.example.mapper" level="trace" additivity="false"><AppenderRef ref="Console"/></Logger>
</Loggers>

9.4.3 与Apache HttpClient集成

配置Apache HttpClient使用Log4j记录请求和响应：

import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.client.HttpClient;public class HttpClientConfig {public HttpClient createHttpClient() {// 为了启用DEBUG级别的日志，请配置Log4j:// log4j.logger.org.apache.http=DEBUG// log4j.logger.org.apache.http.wire=DEBUG (请求/响应内容)PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager();cm.setMaxTotal(100);cm.setDefaultMaxPerRoute(20);return HttpClients.custom().setConnectionManager(cm).build();}
}

对应的Log4j配置：

<Loggers><Logger name="org.apache.http" level="info" additivity="false"><AppenderRef ref="Console"/></Logger><!-- 记录请求和响应内容时使用 --><Logger name="org.apache.http.wire" level="debug" additivity="false"><AppenderRef ref="Console"/></Logger>
</Loggers>

10. 常见问题与解决方案

10.1 日志文件不生成

问题：配置了文件Appender，但日志文件没有生成。

解决方案：

1. 检查文件路径是否存在并具有写入权限
2. 检查Logger级别是否设置得太高，导致日志没有输出
3. 检查Appender引用是否正确
4. 检查配置文件是否正确加载

// 检查配置是否正确加载
LoggerContext context = (LoggerContext) LogManager.getContext(false);
Configuration config = context.getConfiguration();
System.out.println("Loaded configuration: " + config.getName());
System.out.println("Configured appenders: " + config.getAppenders().keySet());

10.2 日志级别不生效

问题：修改了日志级别配置，但没有生效。

解决方案：

1. 对于Log4j 2.x，尝试使用Configurator动态修改日志级别
2. 检查是否有多个配置文件冲突
3. 对于Spring应用，检查是否通过application.properties覆盖了配置

// 动态修改日志级别
Configurator.setLevel("com.example", Level.DEBUG);
Configurator.setRootLevel(Level.INFO);

10.3 日志性能问题

问题：日志记录导致应用性能下降。

解决方案：

1. 使用异步日志
2. 确保使用参数化日志格式
3. 在生产环境中调整合适的日志级别
4. 考虑使用缓冲写入
5. 优化日志格式，减少不必要的信息

10.4 内存泄漏

问题：应用出现内存泄漏，怀疑与日志相关。

解决方案：

1. 检查是否存在大量字符串拼接导致的临时对象
2. 确保正确关闭日志资源
3. 检查ThreadLocal使用是否正确清理
4. 使用堆分析工具（如JProfiler、MAT）定位内存泄漏

// 正确关闭日志上下文
LogManager.shutdown();

10.5 找不到配置文件

问题：应用无法找到Log4j配置文件。

解决方案：

1. 确保配置文件位于classpath中的正确位置
2. 手动指定配置文件位置
3. 检查文件名是否正确（默认支持log4j2.xml, log4j2.properties, log4j2.json, log4j2.yaml）

// 手动指定配置文件位置
System.setProperty("log4j.configurationFile", "path/to/log4j2.xml");

10.6 日志信息不完整

问题：异常堆栈跟踪不完整或被截断。

解决方案：

1. 确保使用正确的方法记录异常
2. 检查是否有字符数限制
3. 对于异步日志，增加缓冲区大小

// 正确记录异常
try {// 业务逻辑...
} catch (Exception e) {// 错误方式 - 只记录异常消息logger.error("Error: " + e.getMessage());// 正确方式 - 记录完整异常堆栈logger.error("Error occurred", e);
}

10.7 日志重复输出

问题：同一条日志信息出现多次。

解决方案：

1. 检查Logger的additivity属性（默认为true，会导致日志向上传递）
2. 确保没有多次配置相同的Appender
3. 检查多个日志框架是否共存并产生冲突

<!-- 设置additivity为false防止日志向上传递 -->
<Logger name="com.example" level="debug" additivity="false"><AppenderRef ref="Console"/>
</Logger>

10.8 Log4j安全漏洞

问题：关于Log4j漏洞（例如log4shell）的安全担忧。

解决方案：

1. 确保使用最新版本的Log4j（特别是Log4j 2.x >= 2.17.0）
2. 在旧版本中禁用JNDI查找功能
3. 实施网络层安全措施
4. 定期检查并应用安全补丁

// 禁用JNDI查找（对于不能升级的老系统）
System.setProperty("log4j2.formatMsgNoLookups", "true");

11. 最佳实践总结

11.1 日志内容最佳实践

1. 包含上下文信息：

   // 不好的实践
   logger.info("User login failed");// 好的实践
   logger.info("User login failed for userId: {}, from IP: {}, reason: {}", userId, ipAddress, reason);
   

2. 避免敏感信息：

   // 不好的实践 - 记录敏感信息
   logger.debug("Credit card number: {}, CVV: {}", cardNumber, cvv);// 好的实践 - 隐藏敏感信息
   logger.debug("Processing payment for masked card: {}", maskCreditCard(cardNumber));
   

3. 使用合适的日志级别：

   • ERROR：表示错误事件，可能导致应用程序终止
   • WARN：表示潜在的有害情况
   • INFO：表示提供信息性的消息，突出显示应用程序的进度
   • DEBUG：表示在调试过程中有用的信息
   • TRACE：表示最详细的信息

11.2 日志配置最佳实践

1. 分环境配置：
   为开发、测试和生产环境使用不同的日志配置。

   # 启动应用时指定环境
   java -Dlog4j.configurationFile=log4j2-prod.xml -jar myapp.jar
   

2. 定期归档和清理：
   配置自动归档和删除旧日志，防止磁盘空间耗尽。

3. 使用异步日志：
   在高性能要求的场景中使用异步日志。

4. 配置监控：
   配置健康检查和监控以及时发现日志系统问题。

11.3 开发实践

1. 使用静态Logger：

   // 推荐方式
   private static final Logger logger = LogManager.getLogger(MyClass.class);// 不推荐每次创建新的Logger实例
   Logger logger = LogManager.getLogger(MyClass.class);  // 避免这种写法
   

2. 区分开发和生产日志：

   // 开发环境详细日志
   if (isDevelopmentEnvironment()) {logger.debug("Detailed object state: {}", object);
   }
   

3. 结构化日志：
   使用结构化格式如JSON便于后续分析。

4. 一致的命名约定：
   为类和方法日志使用一致的命名和格式约定。

11.4 日志管理建议

1. 集中化日志管理：
   使用ELK栈（Elasticsearch, Logstash, Kibana）或类似系统集中管理日志。

2. 实施日志分析：
   定期分析日志以发现模式和问题。

3. 自动化警报：
   配置基于日志的自动警报系统以检测关键问题。

4. 日志审计：
   实施定期日志审计以确保合规和安全。

12. Log4j与数据安全

12.1 避免记录敏感信息

应避免记录以下类型的敏感信息：

• 密码和身份验证令牌
• 信用卡信息
• 社会安全号码
• 健康相关信息
• 个人身份信息
• 敏感的业务数据

使用掩码或散列技术保护敏感数据：

public class DataMasker {public static String maskCreditCard(String cardNumber) {if (cardNumber == null || cardNumber.length() < 4) {return cardNumber;}return "XXXX-XXXX-XXXX-" + cardNumber.substring(cardNumber.length() - 4).replaceAll("[- ]", "");}public static String maskEmail(String email) {if (email == null || !email.contains("@")) {return email;}String[] parts = email.split("@");if (parts[0].length() > 2) {return parts[0].substring(0, 2) + "..." + "@" + parts[1];}return email;}
}

12.2 自定义掩码布局

创建自定义Layout来自动掩码敏感信息：

@Plugin(name = "MaskingPatternLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE)
public class MaskingPatternLayout extends PatternLayout {private static final Pattern CREDIT_CARD_PATTERN = Pattern.compile("\\d{4}[- ]?\\d{4}[- ]?\\d{4}[- ]?\\d{4}");private static final Pattern SSN_PATTERN = Pattern.compile("\\d{3}[- ]?\\d{2}[- ]?\\d{4}");public MaskingPatternLayout(Configuration config, RegexReplacement replace, String pattern,PatternSelector selector, Charset charset, boolean alwaysWriteExceptions,boolean noConsoleNoAnsi, String headerPattern, String footerPattern) {super(config, replace, pattern, selector, charset, alwaysWriteExceptions,noConsoleNoAnsi, headerPattern, footerPattern);}@Overridepublic String toSerializable(LogEvent event) {String message = super.toSerializable(event);message = maskCreditCards(message);message = maskSSNs(message);return message;}private String maskCreditCards(String message) {Matcher matcher = CREDIT_CARD_PATTERN.matcher(message);StringBuffer sb = new StringBuffer();while (matcher.find()) {String match = matcher.group();String masked = "XXXX-XXXX-XXXX-" + match.substring(match.length() - 4).replaceAll("[- ]", "");matcher.appendReplacement(sb, masked);}matcher.appendTail(sb);return sb.toString();}private String maskSSNs(String message) {Matcher matcher = SSN_PATTERN.matcher(message);StringBuffer sb = new StringBuffer();while (matcher.find()) {String match = matcher.group();String masked = "XXX-XX-" + match.substring(match.length() - 4).replaceAll("[- ]", "");matcher.appendReplacement(sb, masked);}matcher.appendTail(sb);return sb.toString();}@PluginFactorypublic static MaskingPatternLayout createLayout(...) {// 创建布局的工厂方法}
}

12.3 安全审计日志

实现安全审计日志记录关键操作：

public class SecurityAuditLogger {private static final Logger auditLogger = LogManager.getLogger("SECURITY_AUDIT");public static void logLogin(String userId, String ipAddress, boolean success) {ThreadContext.put("eventType", "LOGIN");ThreadContext.put("userId", userId);ThreadContext.put("ipAddress", ipAddress);if (success) {auditLogger.info("Successful login");} else {auditLogger.warn("Failed login attempt");}ThreadContext.clearAll();}public static void logDataAccess(String userId, String dataType, String operation) {ThreadContext.put("eventType", "DATA_ACCESS");ThreadContext.put("userId", userId);ThreadContext.put("dataType", dataType);ThreadContext.put("operation", operation);auditLogger.info("Data access operation performed");ThreadContext.clearAll();}public static void logPermissionChange(String adminId, String targetUserId, String permission, String action) {ThreadContext.put("eventType", "PERMISSION_CHANGE");ThreadContext.put("adminId", adminId);ThreadContext.put("targetUserId", targetUserId);ThreadContext.put("permission", permission);ThreadContext.put("action", action);auditLogger.info("Permission changed");ThreadContext.clearAll();}
}

对应的配置，确保审计日志与普通日志分开：

<Appenders><!-- 普通日志Appender --><RollingFile name="ApplicationLog" fileName="logs/application.log"filePattern="logs/application-%d{yyyy-MM-dd}-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies></RollingFile><!-- 安全审计日志Appender，确保写入单独的文件 --><RollingFile name="SecurityAuditLog" fileName="logs/security-audit.log"filePattern="logs/security-audit-%d{yyyy-MM-dd}-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%X{eventType}] [User:%X{userId}] [IP:%X{ipAddress}] - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies></RollingFile>
</Appenders><Loggers><!-- 安全审计Logger单独配置 --><Logger name="SECURITY_AUDIT" level="info" additivity="false"><AppenderRef ref="SecurityAuditLog"/></Logger><!-- 应用普通Logger --><Root level="info"><AppenderRef ref="ApplicationLog"/></Root>
</Loggers>

13. Log4j相关资源和工具

以下是一些有用的Log4j相关资源和工具：

13.1 官方资源

• Log4j 2官方网站
• Log4j 2 GitHub仓库
• Log4j 2用户指南
• Log4j 2 API文档

13.2 日志分析工具

• ELK栈：Elasticsearch、Logstash和Kibana，用于日志聚合和分析
• Graylog：开源日志管理平台
• Splunk：商业日志分析解决方案
• Loki：轻量级日志聚合系统，与Grafana集成
• Papertrail：基于云的日志管理服务

13.3 日志可视化

• Kibana：可视化ELK栈中的日志数据
• Grafana：时间序列数据和日志可视化
• Datadog：云监控和日志分析平台

13.4 日志管理最佳实践

• 实施集中式日志管理
• 标准化日志格式以便于解析
• 设置适当的日志轮换策略
• 定期审核日志配置
• 监控日志系统健康状况

13.5 Log4j替代品

• Logback：Ceki Gülcü（Log4j的原始作者）开发的Log4j继任者
• Java Util Logging (JUL)：Java标准库中的日志工具
• SLF4J：简单日志门面，可以绑定到不同的日志实现
• tinylog：轻量级日志框架
• Apache Commons Logging：另一个日志门面

14. 总结

Log4j是Java生态系统中最流行的日志框架之一，提供了灵活、可配置且高性能的日志解决方案。本指南涵盖了从基础概念到高级特性的全面内容，包括：

• 核心组件：了解Logger、Appender、Layout和Filter如何协同工作
• 配置选项：掌握不同的配置方法和格式
• 高级特性：异步日志、MDC/NDC上下文、参数化日志等
• 性能优化：提高日志系统性能的关键策略
• 与其他框架集成：如何与Spring Boot、SLF4J等集成
• 最佳实践：编写高效、有用且安全的日志
• 安全考虑：避免日志中的敏感信息泄露
• 常见问题与解决方案：解决日常开发中遇到的日志问题

无论是初学者还是有经验的开发人员，掌握这些知识都能帮助您更有效地使用Log4j，提高应用程序的可维护性、可调试性和性能。

pattern=“%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n”/>

<!-- 安全审计日志Appender，确保写入单独的文件 -->
<RollingFile name="SecurityAuditLog" fileName="logs/security-audit.log"filePattern="logs/security-audit-%d{yyyy-MM-dd}-%i.log"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%X{eventType}] [User:%X{userId}] [IP:%X{ipAddress}] - %msg%n"/><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true"/><SizeBasedTriggeringPolicy size="10 MB"/></Policies>
</RollingFile>

<!-- 应用普通Logger -->
<Root level="info"><AppenderRef ref="ApplicationLog"/>
</Root>

```

13. Log4j相关资源和工具

以下是一些有用的Log4j相关资源和工具：

13.1 官方资源

• Log4j 2官方网站
• Log4j 2 GitHub仓库
• Log4j 2用户指南
• Log4j 2 API文档

13.2 日志分析工具

• ELK栈：Elasticsearch、Logstash和Kibana，用于日志聚合和分析
• Graylog：开源日志管理平台
• Splunk：商业日志分析解决方案
• Loki：轻量级日志聚合系统，与Grafana集成
• Papertrail：基于云的日志管理服务

13.3 日志可视化

• Kibana：可视化ELK栈中的日志数据
• Grafana：时间序列数据和日志可视化
• Datadog：云监控和日志分析平台

13.4 日志管理最佳实践

• 实施集中式日志管理
• 标准化日志格式以便于解析
• 设置适当的日志轮换策略
• 定期审核日志配置
• 监控日志系统健康状况

13.5 Log4j替代品

• Logback：Ceki Gülcü（Log4j的原始作者）开发的Log4j继任者
• Java Util Logging (JUL)：Java标准库中的日志工具
• SLF4J：简单日志门面，可以绑定到不同的日志实现
• tinylog：轻量级日志框架
• Apache Commons Logging：另一个日志门面

14. 总结

Log4j是Java生态系统中最流行的日志框架之一，提供了灵活、可配置且高性能的日志解决方案。本指南涵盖了从基础概念到高级特性的全面内容，包括：

• 核心组件：了解Logger、Appender、Layout和Filter如何协同工作
• 配置选项：掌握不同的配置方法和格式
• 高级特性：异步日志、MDC/NDC上下文、参数化日志等
• 性能优化：提高日志系统性能的关键策略
• 与其他框架集成：如何与Spring Boot、SLF4J等集成
• 最佳实践：编写高效、有用且安全的日志
• 安全考虑：避免日志中的敏感信息泄露
• 常见问题与解决方案：解决日常开发中遇到的日志问题

无论是初学者还是有经验的开发人员，掌握这些知识都能帮助您更有效地使用Log4j，提高应用程序的可维护性、可调试性和性能。

记住，好的日志实践不仅仅是配置框架，而是一种思维方式，要考虑什么信息值得记录，如何记录，以及如何从这些信息中获取价值。通过遵循本指南中的最佳实践，您的日志将成为应用程序监控、调试和维护的强大工具。