Log4j2

介绍

Log4j2 是对 Log4j 的升级版，他修复了一些 Log4j 存在的问题，还带了了一些重大的提升，主要有：异常处理机制，性能提升，无垃圾机制等。

官网： Log4j2 官网https://logging.apache.org/log4j/2.x/

Hello World

如果没有惯用的 Hello wrold 实例，任何介绍都是不完整的。

maven 依赖：

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

Java 测试代码：

 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 ​
 public class AppTest {
 ​
     public static void main(String[] args){
         Logger logger = LogManager.getLogger(AppTest.class);
         logger.info("Hello World!"); 
     }
 }

注意，如果这时允许程序的话，控制台会出现，一条提示信息:

ERROR StatusLogger No Log4j 2 configuration file found. 
Using default configuration (logging only errors to the console), 
or user programmatically provided configurations. 
Set system property 'log4j2.debug' to show Log4j 2 internal initialization logging. 
See https://logging.apache.org/log4j/2.x/manual/configuration.html for instructions on how to configure Log4j 2

大致的意思是，没有找到 Log4j2 的配置文件，也就是在类路径下没有找到 log4j2.xml这个文件。这时它会使用默认的配置，而这个配置只会显示 debug 及以上级别的日志。

配置文件，log4j2.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{yyyy-MM-dd}.log.gz">
             <PatternLayout>
                 <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n</Pattern>
             </PatternLayout>
             <Policies>
                 <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                 <SizeBasedTriggeringPolicy size="10MB"/>
             </Policies>
         </RollingFile>
     </Appenders>
 ​
     <Loggers>
         <Root level="debug">
             <AppenderRef ref="Console"/>
             <AppenderRef ref="RollingFile"/>
         </Root>
 ​
         <Logger name="com.example" level="info" additivity="false">
             <AppenderRef ref="Console"/>
         </Logger>
     </Loggers>
 </Configuration>

对这个配置信息进行说明：

• Configuration：

  • status：设置的是 log42 框架自身的日志级别（trace, debug, info, warn, error, fatal），如果把它挑底，你会发现，日志框架自身也打印了很多信息。

• Appenders

  • 定义日志输出目标，是输出到控制台，还是文件等。

  • Console：

    • name：给这个输出目标取的名字，这个名字是任意的，后面我们需要通过这个名字找到这个输出目标，作用仅此而已。

    • target：输出方式，可以是 SYSTEM_OUT (标准输出) 或 SYSTEM_ERR（异常输出），这个异常输出字体颜色为红色。

    • PatternLayout：定义输出的格式，pattern 属性设置具体格式。

• RollingFile：

  • name：给这个输出目标取的名字，这个名字是任意的，后面我们需要通过这个名字找到这个输出目标，作用仅此而已。

  • file：用来指定当前日志的文件名称。

  • filePattern：滚动文件的名称模式，比如按日期设置文件名称：2024-5-24.log

  • PatternLayout：定义日志输出的格式。

  • Policies

    • TimeBasedTriggeringPolicy：基于时间的滚动策略，interval 表示时间间隔。

    • SizeBasedTriggeringPolicy：基于文件大小的滚动策略，size 表示文件大小。

• Loggers：

  • 定义日志记录器，包括根记录器和具体包或类的记录器。

  • Root：

    • level：根记录器的日志级别。

    • AppenderRef：引用上面定义的 appender。

  • Logger：

    • name：记录器的名称，通常是包名或类名。

    • level：记录器的日志级别。

    • additivity：是否向上级记录器传递日志。

    • AppenderRef：引用上面定义的 appender。

大体上，这个日志框架就在这个样子的，可根据业务要求灵活的配置这些属性达到目的。