log4j2-基础

依赖

本文主要围绕log4j2展开, 因此必然需要引入log4j2相关的核心依赖.

pom.xml

properties

<properties>
    <log4j2.version>2.17.0</log4j2.version>
</properties>

dependency

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>${log4j2.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>${log4j2.version}</version>
</dependency>

注

log4j-core和log4j-api是套件, 使用相同版本, 如果只引入log4j-api会出现如下报错:

ERROR StatusLogger Log4j2 could not find a logging implementation. Please add log4j-core to the classpath. Using SimpleLogger to log to the console...

单独使用

使用默认配置

Logger logger = LogManager.getLogger("origin");
logger.error("test origin log4j");

小结

log4j2可以不用任何配置直接使用, 此时使用的是默认配置, 优点是使用方便, 缺点是不适应各样场景自定义.

自定义配置

log4j2的配置核心类为org.apache.logging.log4j.core.config.Configuration, 支持多种格式实现:

上一小节中就是使用了默认配置DefaultConfiguration.

本节使用常用的xml方式演示.

1. log4j2-origin.xml

   <?xml version="1.0" encoding="UTF-8"?>
   <Configuration status="WARN" xmlns="http://logging.apache.org/log4j/2.0/config">
       <Appenders>
           <Console name="Console" target="SYSTEM_OUT">
               <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-8level %logger{36} -- %msg%n"/>
           </Console>
       </Appenders>
       <Loggers>
           <Root level="info">
               <AppenderRef ref="Console"/>
           </Root>
       </Loggers>
   </Configuration>
   

2. 设置jvm参数-Dlog4j2.configurationFile="X:\\xx\\log4j2-origin.xml"

3. 打印日志

   private static final Logger logger = LogManager.getLogger(TestOriginLog4j2.class);
   @Test
   public void testXmlConfiguration() {
       logger.error("test origin log4j");
   }
   

小结

1. 配置文件生效顺序:
   1. log4j2在程序启动时会检查系统配置项log4j2.configurationFile，如果此配置项被设置，则优先采用此配置项指定的配置文件去解析加载；
   2. 如果1中的系统配置项没有被指定，则按下面优先级顺序加载。首先寻找classpath下的log4j2-test.properties文件
   3. 寻找classpath下的 log4j2-test.yaml 或者 log4j2-test.yml 文件
   4. 寻找classpath下的 log4j2-test.json 或者 log4j2-test.jsn文件
   5. 寻找classpath下的 log4j2-test.xml 文件
   6. 如果上述test文件没有找到，则尝试寻找classpath下的 log4j2.yaml 或者 log4j2.yml 文件
   7. 寻找classpath下的 log4j2.json或者 log4j2.jsn文件
   8. 寻找classpath下的 log4j2.xml 文件
   9. 如果上述配置文件都无法找到，则日志直接输出到控制台

log4j2配置示例

<?xml version="1.0" encoding="UTF-8"?> 
<!-- 主要配置为error日志与debug日志分别打印文件，errorLog按照分钟存档，debugLog按照日志文件大小存档，最多保存10个。 -->
<!-- 日志打印状态为debug， monitorInterval是用来设置配置文件的动态加载时间的，每30秒配置文件会动态加载一次，修改配置30秒会生效-->
<configuration status="debug" monitorInterval="30"> 
    <Properties>
        <!-- baseLogDir变量名，日志存储路径。logPattern日志打印路径 -->
        <property name="baseLogDir">./app/log</property>
        <!-- 格式化输出：%d格式化日期，%-5level：级别从左显示5个字符宽度，%thread表示线程名，%msg：日志消息，%n是换行符 -->
        <property name="logPattern">%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%logger{0}:%line][%thread] %X{logger_id} - [TID: %X{EagleEye-TraceID}] %msg%n</property>
    </Properties>
        
    <Appenders>
        <!--Appender 1. console输出DEBUG级别以上日志，指定输出格式和过滤器等级为DEBUG -->
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="${logPattern}"/>
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
        </Console>
        
        <!--Appender 2. INFO日志保存到app.log文件,日志留3天 -->
        <RollingFile name="business" fileName="${baseLogDir}/app.log"
                     filePattern="${baseLogDir}/app.log.%d{yyyy-MM-dd}">
            <PatternLayout pattern="${logPattern}"/>
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
            <DefaultRolloverStrategy>
                <Delete basePath="${baseLogDir}" maxDepth="2">
                    <IfFileName glob="app.log.20*" />
                    <IfLastModified age="3d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
        
        <!--Appender 3. DEBUG日志保存到debug.log文件,日志留3天 -->
        <RollingFile name="debug" fileName="${baseLogDir}/debug.log"
                     filePattern="${baseLogDir}/debug.log.%d{yyyy-MM-dd}">
            <PatternLayout pattern="${logPattern}"/>
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
            <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
            <DefaultRolloverStrategy>
                <Delete basePath="${baseLogDir}" maxDepth="2">
                    <IfFileName glob="debug.log.20*" />
                    <IfLastModified age="3d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
        
        <!--Appender 4. ERROR日志保存到error.log文件,日志留3天 -->
        <RollingFile name="error" fileName="${baseLogDir}/error.log"
                     filePattern="${baseLogDir}/error.log.%d{yyyy-MM-dd}">
            <PatternLayout pattern="${logPattern}"/>
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <CronTriggeringPolicy schedule="0 0 0 * * ?"/>
            <DefaultRolloverStrategy>
                <Delete basePath="${baseLogDir}" maxDepth="2">
                    <IfFileName glob="error.log.20*" />
                    <IfLastModified age="3d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </Appenders> 

    <Loggers>
        <AsyncRoot level="info" includeLocation="true">
            <AppenderRef ref="console"/>
            <AppenderRef ref="business"/>
            <AppenderRef ref="debug"/>
            <AppenderRef ref="error"/>
        </AsyncRoot>
    </Loggers>
</configuration>

集成Slf4j

依赖

<properties>
    <log4j2.version>2.17.0</log4j2.version>
    <slf4j.version>1.7.36</slf4j.version>
</properties>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>${log4j2.version}</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>${slf4j.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>${log4j2.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>${log4j2.version}</version>
</dependency>

集成Spring

集成Spring Boot

springboot默认是用logback的日志框架的，所以需要排除logback，不然会出现jar依赖冲突的报错

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-web</artifactId>  
    <exclusions><!-- 去掉springboot默认配置 -->  
        <exclusion>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-logging</artifactId>  
        </exclusion>  
    </exclusions>  
</dependency> 

<dependency> <!-- 引入log4j2依赖 -->  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-log4j2</artifactId>  
</dependency>   
<!-- 异步日志依赖 -->
<dependency>
   <groupId>com.lmax</groupId>
   <artifactId>disruptor</artifactId>
   <version>3.4.1</version>
</dependency>