Log4j2原理及应用详解（六）
本系列文章简介：
在软件开发过程中，日志记录是一个不可或缺的重要环节。它不仅帮助开发者在开发阶段追踪和调试代码，还在软件运行阶段提供了宝贵的运行信息和错误追踪能力。随着软件系统的日益复杂，对日志记录的需求也变得越来越高，包括日志的灵活性、性能、安全性以及可管理性等方面。
Log4j2，作为Apache Log4j的继任者，自发布以来便以其卓越的性能、灵活的架构和丰富的功能赢得了广泛的认可和应用。它不仅继承了Log4j的优点，还在多个方面进行了重大的改进和优化，特别是在日志性能、配置灵活性、自动重载配置以及无垃圾内存管理等方面，为开发者提供了更加强大和便捷的日志记录解决方案。
本系列文章旨在通过深入剖析Log4j2的内部原理、详细讲解其配置方法、展示高级特性的应用，以及探讨在实际项目中的集成与管理，帮助读者全面理解和掌握Log4j2。无论您是Java开发者、系统管理员，还是对日志记录技术感兴趣的爱好者，本系列文章都将为您提供宝贵的参考和指导。
我们相信，通过本系列的学习，您将能够熟练掌握Log4j2的使用技巧，并在实际项目中灵活应用其各项功能，从而为您的软件开发和运维工作带来极大的便利和效益。同时，我们也期待与您一起探索更多关于日志记录技术的奥秘，共同推动软件行业的进步和发展。
欢迎大家订阅《Java技术栈高级攻略》专栏（PS：近期会涨价），一起学习，一起涨分！
目录
一、引言
随着Logback的兴起，Log4j开始式微。为了应对这一挑战，Apache软件基金会决定开发Log4j的继任者——Log4j2。Log4j2不仅改进了Log4j的缺点，还借鉴了Logback的许多优点，号称在性能上完胜Logback。
本文将跟随《Log4j2原理及应用详解（五）》的进度，继续介绍Log4j2。希望通过本系列文章的学习，您将能够更好地理解Log4j2的内部工作原理，掌握Log4j2的使用技巧，以及通过合理的设计完成最佳实践，充分发挥优化Log4j2的潜力，为系统的高效运行提供有力保障。
二、Log4j2配置
2.1 配置文件类型
详见《Log4j2原理及应用详解（五）》
2.2 配置示例
2.2.1 XML配置示例
Log4j2的XML配置文件（通常命名为log4j2.xml）是Log4j2日志框架中用于定义日志记录行为的主要配置文件之一。以下是一个详细的Log4j2 XML配置示例，该示例展示了如何配置日志的级别、格式、输出目的地（如控制台和文件）以及日志文件的滚动策略等。
Log4j2 XML配置示例
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
<!-- 变量定义 -->
<Properties>
<Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Property>
<Property name="LOG_DIR">logs</Property>
<Property name="APP_NAME">myapp</Property>
</Properties>
<!-- Appenders定义 -->
<Appenders>
<!-- 控制台Appender -->
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="${LOG_PATTERN}"/>
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</Console>
<!-- 滚动文件Appender -->
<RollingFile name="RollingFile" fileName="${LOG_DIR}/${APP_NAME}.log"
filePattern="${LOG_DIR}/${APP_NAME}-%d{yyyy-MM-dd}-%i.log.gz">
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<DefaultRolloverStrategy max="20"/>
</RollingFile>
</Appenders>
<!-- Loggers定义 -->
<Loggers>
<!-- Root Logger -->
<Root level="info">
<AppenderRef ref="Console"/>
<AppenderRef ref="RollingFile"/>
</Root>
<!-- 特定包或类的Logger -->
<Logger name="com.example.myapp" level="debug" additivity="false">
<AppenderRef ref="RollingFile"/>
</Logger>
</Loggers>
</Configuration>配置解析
-
<Configuration>: 配置文件的根元素，status="WARN"表示Log4j2本身将记录警告及以上级别的内部日志信息，monitorInterval="30"表示Log4j2将每30秒检查一次配置文件是否有更改，并重新加载配置（如果配置文件发生变化）。 -
<Properties>: 定义了一些可以在配置文件中重复使用的变量，如日志格式（LOG_PATTERN）、日志目录（LOG_DIR）和应用程序名称（APP_NAME）。 -
<Appenders>: 定义了一个或多个日志输出目的地（Appender）。在这个示例中，定义了一个控制台Appender（Console）和一个滚动文件Appender（RollingFile）。-
<Console>: 将日志输出到控制台，使用PatternLayout定义日志格式，并通过ThresholdFilter设置只接受info级别及以上的日志。 -
<RollingFile>: 将日志输出到文件，文件名和文件模式（filePattern）定义了日志文件的命名规则和滚动策略。这里使用了TimeBasedTriggeringPolicy和SizeBasedTriggeringPolicy作为滚动策略，意味着日志文件将基于时间和大小进行滚动。DefaultRolloverStrategy的max属性设置了保留的滚动文件最大数量。
-
-
<Loggers>: 定义了一个或多个Logger，用于指定日志信息的过滤规则和路由规则。在这个示例中，定义了一个根Logger（Root）和一个特定包或类的Logger（com.example.myapp）。-
<Root>: 根Logger，它指定了所有未明确指定Logger的日志记录。在这个示例中，根Logger的级别被设置为info，并将日志信息同时发送到控制台和滚动文件Appender。 -
<Logger>: 特定包或类的Logger，它允许为特定包或类指定不同的日志级别和Appender。在这个示例中，com.example.myapp包下的日志将被设置为debug级别，并且只发送到滚动文件Appender（通过设置additivity="false"来阻止日志被根Logger处理）。
-
请注意，这个示例仅用于展示Log4j2 XML配置的基本结构和一些常用配置选项。在实际应用中，你可能需要根据自己的需求对配置进行调整和扩展。此外，Log4j2
2.2.2 JSON配置示例
Log4j2配置之JSON配置示例可以展示如何通过JSON格式的文件来配置Log4j2的日志行为。以下是一个详细的JSON配置示例，包括将日志输出到控制台和滚动文件的配置：
JSON配置文件示例（log4j2.json）
{
"configuration": {
"status": "error",
"name": "JSONConfigDemo",
"ThresholdFilter": {
"level": "debug"
},
"appenders": {
"Console": {
"name": "STDOUT",
"PatternLayout": {
"pattern": "%d [%t] %-5p %c - %m%n"
}
},
"RollingFile": {
"name": "File",
"fileName": "C:/logs/howtodoinjava.log",
"filePattern": "C:/logs/howtodoinjava-backup-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz",
"PatternLayout": {
"pattern": "%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"
},
"Policies": {
"SizeBasedTriggeringPolicy": {
"size": "10 MB"
}
},
"DefaultRolloverStrategy": {
"max": "10"
}
}
},
"loggers": {
"root": {
"level": "debug",
"appender-ref": {
"ref": "STDOUT"
},
"additional-appender-refs": {
"ref": "File"
}
}
}
}
}配置解析
- status: 设置为"error"，表示Log4j2将只记录错误级别的内部日志信息。
- name: 配置的名称，这里设置为"JSONConfigDemo"。
- ThresholdFilter: 设置全局的阈值过滤器，这里为"debug"，表示允许debug及以上级别的日志通过。
- appenders: 定义日志的输出目的地。
- Console: 控制台Appender，用于将日志输出到控制台。
- name: Appender的名称，这里为"STDOUT"。
- PatternLayout: 设置日志的输出格式。
- RollingFile: 滚动文件Appender，用于将日志输出到文件，并支持基于文件大小的滚动。
- name: Appender的名称，这里为"File"。
- fileName: 当前日志文件的位置和名称。
- filePattern: 滚动时旧日志文件的命名模式。
- PatternLayout: 设置日志的输出格式。
- Policies: 定义滚动策略。
- SizeBasedTriggeringPolicy: 基于文件大小的滚动策略，这里设置当文件达到10MB时触发滚动。
- DefaultRolloverStrategy: 定义默认的滚动策略，这里设置最多保留10个备份文件。
- Console: 控制台Appender，用于将日志输出到控制台。
- loggers: 定义日志记录器。
- root: 根日志记录器，用于处理未明确指定日志记录器的日志。
- level: 日志级别，这里设置为"debug"。
- appender-ref 和 additional-appender-refs: 引用Appender，这里将日志同时输出到控制台和文件。
- root: 根日志记录器，用于处理未明确指定日志记录器的日志。
注意事项
- 确保将
log4j2.json文件放置在应用的类路径中的任何位置，Log4j2将自动扫描并加载此文件。 - Log4j2使用Jackson库来解析JSON文件，因此请确保在项目中包含了Jackson的依赖项。
- JSON配置文件中，字段名大小写敏感，请确保使用正确的字段名。
依赖项示例（Maven）
在Maven项目中，你可能需要添加以下依赖项来支持Log4j2和Jackson：
<dependencies>
<!-- Log4j2 API -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.x.x</version> <!-- 请替换为你想使用的具体版本 -->
</dependency>
<!-- Log4j2 Core -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.x.x</version> <!-- 请替换为与log4j-api相同的版本 -->
</dependency>
<!-- 可选：如果你需要Jackson来解析或生成JSON（与Log4j2配置无关） -->
<!-- Jackson核心库 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.y.y</version> <!-- 请替换为适合你的项目的版本 -->
</dependency>
<!-- Jackson数据绑定库 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.y.y</version> <!-- 请替换为与jackson-core相同的版本 -->
</dependency>
<!-- 如果需要处理JSON注解，也可以添加jackson-annotations -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.y.y</version> <!-- 请替换为与上述相同的版本 -->
</dependency>
</dependencies>请注意，2.x.x 和 2.y.y 是占位符，你应该替换为实际想要使用的版本号。确保log4j-api和log4j-core的版本号相同，以避免潜在的兼容性问题。
对于Log4j2的JSON配置，你只需将log4j2.json文件放在类路径的根目录下（例如，放在src/main/resources目录中），Log4j2会自动检测到并加载它。你不需要在Maven依赖中明确添加任何与Log4j2 JSON配置直接相关的依赖项。
2.2.3 YAML配置示例
详见《Log4j2原理及应用详解（七）》
2.2.4 Properties配置示例
详见《Log4j2原理及应用详解（七）》
2.3 配置参数详解
详见《Log4j2原理及应用详解（八）》
三、Log4j2的高级特性
3.1 异步日志记录
详见《Log4j2原理及应用详解（九）》
3.2 日志分割与归档
详见《Log4j2原理及应用详解（十）》
3.3 日志安全
详见《Log4j2原理及应用详解（十一）》
四、Log4j2的应用
4.1 集成到Spring/Spring Boot项目中
详见《Log4j2原理及应用详解（十二）》
4.2 在Web项目中的应用
详见《Log4j2原理及应用详解（十三）》
4.3 日志管理与监控
详见《Log4j2原理及应用详解（十四）》
五、总结与展望
详见《Log4j2原理及应用详解（十四）》
六、结语
文章至此，已接近尾声！希望此文能够对大家有所启发和帮助。同时，感谢大家的耐心阅读和对本文档的信任。在未来的技术学习和工作中，期待与各位大佬共同进步，共同探索新的技术前沿。最后，再次感谢各位的支持和关注。您的支持是作者创作的最大动力，如果您觉得这篇文章对您有所帮助，请分享给身边的朋友和同事！
原文地址：https://blog.csdn.net/weixin_42506246/article/details/140443506
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！