Log4j2日志框架详细配置与使用教程

log4j2是java中强大灵活的日志框架，适用于记录程序运行信息、排查问题和分析性能，尤其在分布式系统中表现优异。1. log4j2通过异步机制提升性能，将日志事件生成与写入解耦，采用“生产者-消费者”模式实现非阻塞、高吞吐量的日志处理；2. 配置log4j2需引入maven依赖（log4j-api、log4j-core、log4j-slf4j2-impl），并在classpath下放置log4j2.xml文件定义appenders和loggers；3. 使用slf4j门面调用logger对象输出日志，支持debug、info、warn、error等不同级别；4. 异步日志可通过asyncappender或asynclogger实现，推荐使用前者以获得更细粒度控制；5. 常见配置坑包括依赖冲突、配置文件位置错误、rollingfile策略不当、includelocation设置影响性能及日志级别不合理，需逐一排查优化；6. 与spring boot集成时需排除默认logback依赖并引入spring-boot-starter-log4j2，利用log4j2-spring.xml配合profile特性实现多环境日志配置，也可通过application.properties动态调整日志级别。

Log4j2，在我看来，是Java世界里一套既强大又灵活的日志框架，它能帮助我们把程序运行时的各种信息——从调试细节到严重错误——妥善地记录下来。它不仅仅是个记录器，更是应用健康状况的晴雨表，尤其在复杂分布式系统中，一份配置得当的Log4j2日志，简直是排查问题、分析性能的利器。它的异步特性和丰富的配置选项，让它在处理高并发场景时表现出色，远超一些老旧的日志方案。

解决方案

要让Log4j2在你的项目中跑起来，配置和使用其实并不复杂，但其中的门道却能让你的日志系统事半功倍。

我们通常从Maven或Gradle依赖开始。以Maven为例，你需要在pom.xml中加入核心依赖，通常还会搭配log4j-slf4j2-impl（如果你的项目使用SLF4J作为日志门面）和log4j-api。

<dependencies>
    <!-- Log4j2 API -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.20.0</version>
    </dependency>
    <!-- Log4j2 Core 实现 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.20.0</version>
    </dependency>
    <!-- 如果使用SLF4J作为门面，则需要此桥接 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j2-impl</artifactId>
        <version>2.20.0</version>
    </dependency>
</dependencies>

接下来是核心的配置。Log4j2默认会在classpath下寻找log4j2.xml、log4j2.json或log4j2.yaml文件。XML是最常见的配置格式，它提供了极大的灵活性。

一个典型的log4j2.xml文件结构会包含<Configuration>根元素，其下是<Appenders>和<Loggers>。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
    <Appenders>
        <!-- 控制台输出 -->
        <Console name="ConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>

        <!-- 文件输出，每天滚动一次，最多保留7天 -->
        <RollingFile name="FileAppender"
                     fileName="logs/application.log"
                     filePattern="logs/application-%d{yyyy-MM-dd}.%i.log.gz">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="7"/>
        </RollingFile>

        <!-- 异步文件输出，提升性能 -->
        <Async name="AsyncFileAppender">
            <AppenderRef ref="FileAppender"/>
        </Async>
    </Appenders>

    <Loggers>
        <!-- 特定包的日志级别 -->
        <Logger name="com.example.myapp" level="debug" additivity="false">
            <AppenderRef ref="ConsoleAppender"/>
            <AppenderRef ref="AsyncFileAppender"/>
        </Logger>

        <!-- 根Logger，所有未匹配的日志都走这里 -->
        <Root level="info">
            <AppenderRef ref="ConsoleAppender"/>
            <AppenderRef ref="AsyncFileAppender"/>
        </Root>
    </Loggers>
</Configuration>

在代码中使用Log4j2（通过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("这是一个调试信息。");
        logger.info("业务逻辑正在执行，参数：{}", "some_value");
        logger.warn("检测到潜在问题，请注意。");
        try {
            int result = 1 / 0; // 模拟一个异常
        } catch (Exception e) {
            logger.error("发生了一个严重错误！", e);
        }
    }

    public static void main(String[] args) {
        new MyService().doSomething();
    }
}

通过以上配置和代码，你的应用程序就能将日志输出到控制台和文件中了。monitorInterval属性让Log4j2可以定期检查配置文件变更并自动重新加载，这在生产环境中调试时非常方便。

Log4j2异步日志的魔力在哪里？

异步日志，这简直是Log4j2的一大杀手锏。我记得很多年前，我们还在用同步日志，一旦日志量大，程序性能就会明显下降，因为每次写入日志都可能涉及磁盘I/O，这可是个耗时操作。Log4j2的异步机制彻底改变了这一点。

它的魔力在于，它将日志事件的生成和实际的写入操作解耦了。当你的应用程序调用logger.info()时，日志事件不会立即被同步写入文件或控制台，而是被快速地放入一个内存队列中。然后，有一个或多个独立的后台线程会从这个队列中取出事件，并负责将它们写入到目标位置（比如文件）。

这种“生产者-消费者”模式带来了巨大的性能提升：

1. 非阻塞性：应用程序的主线程几乎不会因为日志写入而阻塞，它只需要把日志事件扔到队列里就行，这个操作非常快。这意味着你的业务逻辑可以更流畅地运行，不会被日志I/O拖累。
2. 吞吐量：通过批量处理和优化I/O操作，异步日志能够以更高的效率处理大量的日志事件，尤其是在高并发、高流量的系统中，它的优势异常明显。
3. 资源利用：它能更好地利用系统资源，例如，在磁盘I/O繁忙时，日志事件可以在内存中缓冲，等待I/O空闲时再写入，避免了I/O瓶颈对应用性能的直接冲击。

Log4j2实现异步日志主要有两种方式：

• AsyncAppender：这是最常见的做法，你可以在log4j2.xml中定义一个Async类型的Appender，然后将其他同步Appender（如RollingFile）作为它的子Appender引用。所有发送到AsyncAppender的日志都会被异步处理。
• AsyncLogger：如果你想让整个Logger体系都是异步的，可以通过设置系统属性Log4jContextSelector为org.apache.logging.log4j.core.async.AsyncLoggerContextSelector来实现。这种方式下，所有的Logger实例都会是异步的，性能提升更显著，但配置上需要更谨慎，因为它会影响所有日志。

我个人更倾向于使用AsyncAppender，因为它提供了更细粒度的控制，你可以选择哪些日志流需要异步化，哪些保持同步（比如一些关键的、必须立即写入的审计日志）。在实际项目中，我们经常会把所有文件输出都配置成异步，而控制台输出则保持同步，方便开发调试。

<!-- AsyncAppender 示例 -->
<Async name="AsyncFile" includeLocation="false"> <!-- includeLocation=false可进一步提升性能，但会丢失行号信息 -->
    <AppenderRef ref="FileAppender"/> <!-- FileAppender是上面定义的RollingFile -->
    <AppenderRef ref="ErrorFileAppender"/> <!-- 也可以是另一个只记录错误的Appender -->
</Async>

<Loggers>
    <Root level="info">
        <AppenderRef ref="ConsoleAppender"/>
        <AppenderRef ref="AsyncFile"/> <!-- 这里引用异步Appender -->
    </Root>
</Loggers>

异步日志虽然好，但也不是没有代价。它可能会增加内存消耗（因为需要缓冲日志事件），并且在极端情况下，如果应用崩溃，队列中未写入的日志事件可能会丢失。所以，在设计日志方案时，需要权衡性能和数据完整性。

那些年我们踩过的Log4j2配置坑与优化建议

Log4j2的强大伴随着一定的配置复杂性，踩坑是常有的事。我总结了一些常见的“坑”和对应的优化建议，希望能帮你少走弯路。

1. 依赖冲突或缺失：

   • 坑：最常见的莫过于NoClassDefFoundError或日志不输出。这往往是因为缺少了log4j-core、log4j-api，或者如果你用了SLF4J，却忘了log4j-slf4j2-impl这个桥接器。有时，项目里可能混入了Logback或Log4j1的依赖，导致日志系统混乱。
   • 建议：仔细检查Maven/Gradle依赖树，确保Log4j2的相关依赖版本一致且没有冲突。使用mvn dependency:tree是个好习惯。如果项目同时存在Spring Boot，它默认会引入Logback，你需要明确排除Logback依赖并引入Log4j2。

2. 配置文件未找到或格式错误：

   

   琅琅配音

   全能AI配音神器

   208

   查看详情
   • 坑：log4j2.xml文件没放在classpath下，或者XML格式有误（比如标签拼写错误，或者缺少闭合标签）。Log4j2启动时通常会打印警告信息，但有时容易被忽略。
   • 建议：确保log4j2.xml放在src/main/resources目录下。使用XML编辑器或IDE的XML验证功能检查格式。启动时留意控制台的Log4j2初始化日志，它会告诉你配置文件是否加载成功，以及是否有解析错误。

3. 日志文件不滚动或文件过大：

   • 坑：配置了RollingFile但文件就是不滚动，或者滚动策略没生效，导致日志文件无限增大。这通常是Policies或DefaultRolloverStrategy配置不当。
   • 建议：TimeBasedTriggeringPolicy的interval和modulate要理解清楚，modulate="true"能保证按整点时间滚动。SizeBasedTriggeringPolicy的size单位是字节，别写错了。DefaultRolloverStrategy的max属性决定了保留多少个旧文件。我曾见过有人把filePattern写得太简单，导致滚动后文件名冲突，覆盖了旧文件。确保filePattern足够独特，比如包含日期和索引%d{yyyy-MM-dd}.%i.log.gz。

4. 异步日志的includeLocation问题：

   • 坑：为了追求极致性能，开启了异步日志（AsyncAppender或AsyncLogger），但日志中却丢失了代码行号、文件名等位置信息。
   • 建议：这是因为获取调用栈信息是一个相对耗时的操作。在异步日志中，如果includeLocation设置为true（默认值），Log4j2会尝试在日志事件被放入队列之前获取这些信息。但为了性能，通常建议在生产环境中将includeLocation设为false。如果你确实需要这些信息进行调试，可以考虑在开发环境开启，生产环境关闭，或者只在特定关键日志点使用同步Logger。

5. 日志级别配置不当：

   • 坑：日志输出过多或过少。比如，Root Logger级别太低（如trace），导致大量无用日志淹没有效信息；或者某个特定包的Logger级别太高（如warn），导致重要的调试信息被过滤掉。
   • 建议：根据环境和需求合理设置日志级别。开发环境可以适当放宽，生产环境则应严格控制。additivity="false"属性很重要，它能阻止日志事件向上层Logger传递，避免重复输出。例如，你可能希望com.example.myapp的日志只输出到文件，而不希望它再次被Root Logger处理，这时additivity="false"就派上用场了。

6. 编码问题：

   • 坑：日志文件中出现乱码，特别是涉及到中文时。
   • 建议：在PatternLayout或Appender中明确指定编码，例如<PatternLayout charset="UTF-8" pattern="..."/>。确保你的文件系统和控制台也支持对应的编码。

优化日志系统是一个持续的过程，它需要在性能、存储、可读性之间找到一个平衡点。别忘了，日志的最终目的是为了帮助你理解和解决问题，而不是制造新的问题。

Log4j2与Spring Boot集成，是不是比想象中简单？

当谈到Log4j2与Spring Boot的集成，我的第一反应是：这事儿比很多人想象的要简单，但也有那么一点点小细节需要注意。Spring Boot以其“约定优于配置”的理念，默认集成了Logback作为其日志框架。这意味着，如果你直接引入Log4j2的依赖，可能会遇到日志不工作或者行为异常的问题，因为Logback和Log4j2都在争夺日志控制权。

所以，集成Log4j2到Spring Boot应用的核心步骤就两点：排除默认的Logback依赖和引入Log4j2的Spring Boot适配器。

1. 排除Logback依赖： Spring Boot的spring-boot-starter-logging模块默认包含了Logback。你需要从spring-boot-starter中排除它。

   <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>

   登录后复制

2. 引入Log4j2适配器： Spring Boot为Log4j2提供了一个专门的Starter：spring-boot-starter-log4j2。这个Starter会帮你把Log4j2的核心依赖以及SLF4J的桥接都引入进来。

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

   登录后复制

完成这两步，Spring Boot就会自动检测到classpath上的Log4j2，并将其作为默认的日志实现。你之前配置的log4j2.xml（或json/yaml）文件，只要放在classpath下，Spring Boot也能自动加载。

是不是很简单？确实如此。Spring Boot的这种设计哲学，让替换底层实现变得非常便捷。

一些额外的思考和技巧：

• 配置文件位置：默认情况下，Spring Boot会查找src/main/resources下的log4j2.xml、log4j2-spring.xml等。其中log4j2-spring.xml是个很有意思的约定，如果存在，Spring Boot会优先加载它，并且它支持Spring的Profile特性。

• Spring Profile与日志配置：这是我非常喜欢的一个特性。你可以为不同的环境（开发、测试、生产）定义不同的日志配置。例如，你可以创建log4j2-dev.xml、log4j2-prod.xml。在application.properties或application.yml中，通过spring.profiles.active=dev来激活对应的配置文件。这样，开发环境可以输出DEBUG级别到控制台，而生产环境则只输出INFO及以上级别到文件，且配置异步。

  <!-- log4j2-prod.xml 示例 -->
  <Configuration status="INFO">
      <Appenders>
          <Async name="AsyncFileAppender">
              <RollingFile name="FileAppender" ...>
                  <!-- 生产环境配置 -->
              </RollingFile>
          </Async>
      </Appenders>
      <Loggers>
          <Root level="info">
              <AppenderRef ref="AsyncFileAppender"/>
          </Root>
      </Loggers>
  </Configuration>

  登录后复制

• 日志级别在application.properties中配置：除了在log4j2.xml中配置日志级别，Spring Boot也允许你在application.properties或application.yml中通过logging.level.<logger-name>=<level>来控制日志级别。这提供了一种快速调整日志级别的方式，无需修改log4j2.xml并重启应用（如果monitorInterval配置了）。例如：

  logging.level.root=info
  logging.level.com.example.myapp=debug
  logging.level.org.springframework=warn

  登录后复制

  这种方式的优先级通常低于log4j2.xml中明确定义的Logger级别，但可以作为一种方便的运行时覆盖机制。

总的来说，Log4j2与Spring Boot的集成非常顺滑。Spring Boot的Starter机制极大地简化了依赖管理，而其对外部配置文件的支持和Profile特性，则让日志管理在不同环境下变得灵活而强大。掌握了这些，你就能轻松地在Spring Boot项目中驾驭Log4j2了。

以上就是Log4j2日志框架详细配置与使用教程的详细内容，更多请关注php中文网其它相关文章！