Log4j2 在 Java 中的使用（参考）

于 2025-05-15 09:18:44 发布
阅读量719 收藏 19
点赞数 29
文章标签： log4j java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_52578852/article/details/147970436
版权

1. Log4j2 简介

Log4j2 是 Apache 基金会下的一个开源日志框架，是 Log4j 的升级版本，具有以下特点：

  • 高性能，异步日志记录比 Log4j 和 Logback 快很多

  • 支持多种日志级别

  • 插件式架构，易于扩展

  • 支持 XML、JSON、YAML 和 properties 配置

  • 自动重新加载配置文件

2. 环境准备

2.1 添加 Maven 依赖

<dependencies>
    <!-- Log4j2 核心依赖 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.20.0</version> 
    </dependency>
    
    <!-- Log4j2 API 接口 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.20.0</version>
    </dependency>
    
    <!-- 可选：SLF4J 桥接 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.20.0</version>
    </dependency>
</dependencies>

2.2 基本目录结构

src/
├── main/
│   ├── java/
│   │   └── com/example/MyApp.java
│   └── resources/
│       └── log4j2.xml  # 配置文件

3. 基本配置

3.1 XML 配置示例 (log4j2.xml)，一定不要忘记配置，否则可能会报错！！！！！！

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
    <Appenders>
        <!-- 控制台输出 -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        
        <!-- 文件输出 -->
        <File name="File" fileName="logs/app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </File>
        
        <!-- 滚动文件 -->
        <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.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="10"/>
        </RollingFile>
    </Appenders>
    
    <Loggers>
        <!-- 根日志记录器 -->
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
        
        <!-- 特定包的日志级别 -->
        <Logger name="com.example" level="debug" additivity="false">
            <AppenderRef ref="RollingFile"/>
        </Logger>
    </Loggers>
</Configuration>

3.2 配置说明

  • status: 设置 Log4j2 内部日志级别 (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL)

  • monitorInterval: 配置文件自动重新加载间隔(秒)

  • Appenders: 定义日志输出目的地

    • Console: 控制台输出

    • File: 简单文件输出

    • RollingFile: 滚动文件输出

  • Loggers: 定义日志记录器

    • Root: 根日志记录器

    • Logger: 特定包或类的日志记录器

4. 日志记录

4.1 基本使用

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MyApp {
    // 获取Logger实例
    private static final Logger logger = LogManager.getLogger(MyApp.class);
    
    public static void main(String[] args) {
        // 不同级别的日志记录
        logger.trace("Trace level message");
        logger.debug("Debug level message");
        logger.info("Info level message");
        logger.warn("Warn level message");
        logger.error("Error level message");
        logger.fatal("Fatal level message");
        
        // 参数化日志
        String user = "Alice";
        int age = 30;
        logger.info("User {} is {} years old", user, age);
        
        // 异常日志
        try {
            // 可能抛出异常的代码
        } catch (Exception e) {
            logger.error("An error occurred", e);
        }
    }
}

4.2 日志级别

Log4j2 支持以下日志级别（从低到高）：

  1. TRACE

  2. DEBUG

  3. INFO

  4. WARN

  5. ERROR

  6. FATAL

5. 高级配置

5.1 异步日志

异步日志可以显著提高性能：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    
    <Loggers>
        <Root level="info">
            <!-- 使用AsyncAppender -->
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
    
    <!-- 全局异步配置 -->
    <AsyncLogger name="com.example" level="debug" includeLocation="true">
        <AppenderRef ref="Console"/>
    </AsyncLogger>
    
    <!-- 或者使用AsyncRoot -->
    <AsyncRoot level="info">
        <AppenderRef ref="Console"/>
    </AsyncRoot>
</Configuration>

或者添加 LMAX Disruptor 实现高性能异步日志：

<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

并在启动时添加系统属性：

System.setProperty("log4j2.contextSelector", 
    "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");

5.2 过滤日志

<Console name="Console" target="SYSTEM_OUT">
    <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    <!-- 只记录ERROR级别以上的日志 -->
    <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
</Console>

5.3 自定义日志格式

PatternLayout 支持的格式：

  • %d: 日期时间

  • %t: 线程名

  • %level: 日志级别

  • %logger: 日志记录器名

  • %msg: 日志消息

  • %n: 换行符

  • %throwable: 异常堆栈

  • %highlight: 高亮显示

  • %style: 样式设置

示例：

<PatternLayout pattern="%style{%d{ISO8601}}{cyan} %highlight{%-5level} %style{%logger{36}}{magenta} - %msg%n"/>

5.4 多环境配置

使用属性文件定义环境变量：

<Configuration status="WARN">
    <Properties>
        <Property name="logPath">logs</Property>
        <Property name="logPattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Property>
    </Properties>
    
    <Appenders>
        <RollingFile name="File" fileName="${logPath}/app.log"
                    filePattern="${logPath}/app-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="${logPattern}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingFile>
    </Appenders>
    
    <Loggers>
        <Root level="info">
            <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

6. 与SLF4J集成

如果项目使用SLF4J作为日志门面：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyApp {
    private static final Logger logger = LoggerFactory.getLogger(MyApp.class);
    
    public static void main(String[] args) {
        logger.info("This is an info message using SLF4J");
    }
}

确保添加了log4j-slf4j-impl依赖。

7. 最佳实践

  1. 合理使用日志级别：

    • TRACE: 非常详细的调试信息

    • DEBUG: 调试信息

    • INFO: 程序运行中的重要信息

    • WARN: 潜在问题

    • ERROR: 错误但不影响系统运行

    • FATAL: 严重错误导致系统无法运行

  2. 避免字符串拼接：
    使用参数化日志而不是字符串拼接：

    // 好
logger.debug("User {} logged in at {}", username, loginTime);

// 不好
logger.debug("User " + username + " logged in at " + loginTime);

  3. 合理配置日志文件：

    • 使用滚动文件防止单个文件过大

    • 设置合理的文件保留策略

    • 考虑按日期或大小分割日志

  4. 生产环境注意事项：

    • 不要在生产环境使用DEBUG或TRACE级别

    • 确保日志文件有足够的磁盘空间

    • 考虑日志收集和分析系统（如ELK）

8. 常见问题解决

8.1 日志不输出

  1. 检查配置文件位置是否正确（应在classpath根目录）

  2. 检查配置文件名称是否正确（log4j2.xml或log4j2.properties）

  3. 检查日志级别设置是否过高

  4. 检查是否有多个日志框架冲突

8.2 配置文件不自动刷新

确保配置了monitorInterval属性：

<Configuration status="WARN" monitorInterval="30">

8.3 性能问题

  1. 考虑使用异步日志

  2. 减少不必要的日志记录

  3. 简化日志格式

9. 扩展功能

9.1 自定义Appender

@Plugin(name = "CustomAppender", category = "Core", 
        elementType = "appender", printObject = true)
public class CustomAppender extends AbstractAppender {
    
    protected CustomAppender(String name, Filter filter, Layout<? extends Serializable> layout) {
        super(name, filter, layout);
    }
    
    @Override
    public void append(LogEvent event) {
        // 自定义日志处理逻辑
        System.out.println("Custom Appender: " + event.getMessage().getFormattedMessage());
    }
    
    @PluginFactory
    public static CustomAppender createAppender(
            @PluginAttribute("name") String name,
            @PluginElement("Filter") Filter filter,
            @PluginElement("Layout") Layout<? extends Serializable> layout) {
        return new CustomAppender(name, filter, layout);
    }
}

然后在配置中使用：

<CustomAppender name="Custom">
    <PatternLayout pattern="%msg%n"/>
</CustomAppender>

9.2 日志脱敏

实现自定义Converter进行敏感信息脱敏：

@Plugin(name = "SensitiveConverter", category = "Converter")
@ConverterKeys({"sc"})
public class SensitiveConverter extends LogEventPatternConverter {
    
    protected SensitiveConverter(String[] options) {
        super("SensitiveConverter", "sc");
    }
    
    public static SensitiveConverter newInstance(final String[] options) {
        return new SensitiveConverter(options);
    }
    
    @Override
    public void format(LogEvent event, StringBuilder toAppendTo) {
        String message = event.getMessage().getFormattedMessage();
        // 实现脱敏逻辑
        toAppendTo.append(message.replaceAll("\\d{4}(?=\\d{4})", "****"));
    }
}

在配置中使用：

<PatternLayout pattern="%d %sc{%msg}%n"/>

10. 总结

Log4j2 是一个功能强大且高性能的日志框架，通过合理配置可以满足各种日志需求。关键点包括：

  1. 正确配置日志级别和输出目标

  2. 根据需求选择同步或异步日志

  3. 合理设计日志格式和内容

  4. 在生产环境中注意性能和存储问题

  5. 利用高级功能如过滤、脱敏等增强日志功能

 

上官箫羽
关注
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值