学习日志框架之——log4j2入门__log4j教程

link之家

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

文章目录

一、log4j2概述

1、Log4j2简介
2、Log4j2特征
3、日志输出格式

二、单纯使用log4j2使用实例

1、导包
2、入门案例
3、使用配置文件

三、使用slf4j门面

1、导包
2、代码实例
3、将日志输出到文件
4、日志文件的拆分
5、使用过滤器

四、异步日志

1、AsyncAppender方式

（1）使用示例

2、AsyncLogger方式

（1）全局异步

（2）混合异步
3、注意

一、log4j2概述

1、Log4j2简介

Apache Log4j 2是对Log4j的升级，它比其前身Log4j 1.x提供了重大改进，并提供了Logback中可用的许多改进，同时修复了Logback架构中的一些问题。被誉为是目前最优秀的Java日志框架（没有之一）。

2、Log4j2特征

性能提升
Log4j2包含基于LMAX Disruptor库的下一代异步记录器。在多线程场景中，异步记录器的吞吐量比Log4j 1.x和Logback高18倍，延迟低。

自动重新加载配置
与Logback一样，Log4j2可以在修改时自动重新加载其配置。与Logback不同的是，它会在重新配置发生时不会丢失日志事件。

高级过滤
与Logback一样，Log4j2支持基于Log事件中的上下文数据，标记，正则表达式和其他组件进行过滤。
此外，过滤器还可以与记录器关联。与Logback不同，Log4j2可以在任何这些情况下使用通用的Filter类。

插件架构
Log4j使用插件模式配置组件。因此，您无需编写代码来创建和配置Appender，Layout，Pattern Converter等。在配置了的情况下，Log4j自动识别插件并使用它们。

无垃圾机制
在稳态日志记录期间，Log4j2 在独立应用程序中是 无垃圾的 ，在Web应用程序中是低垃圾。这减少了垃圾收集器的压力，并且可以提供更好的响应性能。
目前市面上最主流的日志门面就是SLF4J，虽然Log4j2 也是日志门面，因为它的日志实现功能非常强大，性能优越。所以我们一般情况下还是将 Log4j2 看作是日志的实现
SLF4j + Log4j2 的组合，是市场上最强大的日志功能实现方式，绝对是未来的主流趋势。

3、日志输出格式

日志输出格式：
%-10level 级别案例为设置10个字符，左对齐
%d{yyyy-MM-dd HH:mm:ss.SSS} 日期
%c 当前类全限定名
%M 当前执行日志的方法
%L 行号
%t 线程名称
%m或者%msg 信息
%n 换行
%xwEx 带颜色输出

二、单纯使用log4j2使用实例

单纯的使用Log4j2的门面+实现。

1、导包

<!-- log4j2日志门面 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.12.1</version>
</dependency>
<!-- log4j2日志实现 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.12.1</version>
</dependency>

2、入门案例

Log4j2和log4j提供了相同的日志级别输出，默认为error级别信息的打印。

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Logger logger = LogManager.getLogger(Log4j2Test01.class);
logger.fatal("fatal信息");
logger.error("error信息");
logger.warn("warn信息");
logger.info("info信息");
logger.debug("debug信息");
logger.trace("trace信息");

直接运行的话，会有一个提示，表示我们还没有建立自己的配置文件，如果没有建立配置文件，则使用默认的配置：

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

3、使用配置文件

log4j2是参考logback创作出来的，所以配置文件也是使用xml。

log4j2默认加载类路径（resources）下的log4j2.xml文件中的配置。

根标签，所有日志相关信息，都是在根标签中进行配置
<Configuration status=“debug” monitorInterval=“数值”></Configuration>
在根标签中，可以加属性status=“debug” 日志框架log4j2 本身的日志输出级别，monitorInterval=“5” 自动加载配置文件的间隔时间，不低于5秒。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <!-- 配置appender -->
    <Appenders>
        <!-- 配置控制台输出，SYSTEM_ERR表示打印红色，SYSTEM_OUT表示打印黑色 -->
        <Console name="consoleAppender" target="SYSTEM_ERR">
        </Console>
    </Appenders>
    <!-- 配置logger -->
    <Loggers>
        <!-- 配置rootlogger -->
        <Root level="trace">
            <!-- 引用Appender -->
            <AppenderRef ref="consoleAppender"/>
        </Root>
    </Loggers>
</Configuration>

三、使用slf4j门面

虽然log4j2也是日志门面，但是现在市场的主流趋势仍然是slf4j，所以我们仍然需要使用slf4j作为日志门面，搭配log4j2强大的日志实现功能，进行日志的相关操作。

接下来我们配置的就是当今市场上的最强大，最主流的日志使用搭配方式：slf4j+log4j2。

1、导包

总共需要导入4个包。

执行原理：slf4j门面调用的是log4j2的门面，再由log4j2的门面调用log4j2的实现

<!-- slf4j日志门面 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
<!-- log4j适配器 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.12.1</version>
</dependency>
<!-- log4j2日志门面 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.12.1</version>
</dependency>
<!-- log4j2日志实现 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.12.1</version>
</dependency>

接下来，我们的代码都是基于slf4j来编写的。

2、代码实例

如不做特殊说明，本文其他实例都是基于这段代码。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Logger logger = LoggerFactory.getLogger(Log4j2Test01.class);
logger.error("error信息");
logger.warn("warn信息");
logger.info("info信息");
logger.debug("debug信息");
logger.trace("trace信息");

3、将日志输出到文件

1.需要在Appenders中配置File 标签。
2.在rootLoggers中添加Appender的引用。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
        配置全局通用属性
    <properties>
        <property name="logDir">D://test</property>
        <property name="pattern">[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n</property>
    </properties>
    <!-- 配置appender -->
    <Appenders>
        <!-- 配置控制台输出 -->
        <Console name="consoleAppender" target="SYSTEM_ERR">
            <PatternLayout pattern="${pattern}"/>
        </Console>
        <!-- 1.配置文件输出-->
        <File name="fileAppender" fileName="${logDir}//log4j2.log">
            <!-- 配置文件输出格式 -->
            <PatternLayout pattern="${pattern}"/>
        </File>
    </Appenders>
    <!-- 配置logger -->
    <Loggers>
        <!-- 配置rootlogger -->
        <Root level="trace">
            <!-- 2.引用Appender -->
            <AppenderRef ref="consoleAppender"/>
            <AppenderRef ref="fileAppender"/>
        </Root>
    </Loggers>
</Configuration>

4、日志文件的拆分

1.需要在Appenders中配置RollingFile标签。
2.在rootLoggers中添加Appender的引用。

<!--
    按照指定规则来拆分日志文件
    fileName:日志文件的名字
    filePattern：日志文件拆分后文件的命名规则
                $${date:yyyy-MM-dd}：根据日期当天，创建一个文件夹
                            例如：2023-01-01这个文件夹中，记录当天的所有日志信息（拆分出来的日志放在这个文件夹中）
                                  2023-01-02这个文件夹中，记录当天的所有日志信息（拆分出来的日志放在这个文件夹中）
                rollog-%d{yyyy-MM-dd-HH-mm}-%i.log
                            为文件命名的规则：%i表示序号，从0开始，目的是为了让每一份文件名字不会重复
<RollingFile name="rollingFile" fileName="${logDir}/rollog.log"
             filePattern="${logDir}/$${date:yyyy-MM-dd}/rollog-%d{yyyy-MM-dd-HH-mm}-%i.log">
    <!-- 日志消息格式 -->
    <PatternLayout pattern="${pattern}"/>
    <Policies>
        <!-- 在系统启动时，触发拆分规则，产生一个日志文件 -->
        <OnStartupTriggeringPolicy/>
        <!-- 按照文件的大小进行拆分 -->
        <SizeBasedTriggeringPolicy size="10KB"/>
        <!-- 按照时间节点进行拆分 拆分规则就是filePattern-->
        <TimeBasedTriggeringPolicy/>
    </Policies>
    <!-- 在同一目录下，文件的个数限制，如果超出了设置的数值，则根据时间进行覆盖，新的覆盖旧的规则-->
    <DefaultRolloverStrategy max="30"/>
</RollingFile>
<!-- 配置rootlogger -->
<Root level="trace">
    <!-- 引用Appender -->
    <AppenderRef ref="rollingFile"/>
</Root>

5、使用过滤器

log4j2使用filter过滤日志

四、异步日志

异步日志是log4j2最大的特色，其性能的提升主要也是从异步日志中受益。我们之前用的同步日志只要是在记录日志，那么系统本身的功能就处于一种停滞的状态，当日志记录完毕后，才会执行其他的代码，如果日志记录量非常庞大的话，那么我们对于系统本身业务代码的执行效率会非常低。

Log4j2提供了两种实现日志的方式，一个是通过AsyncAppender，一个是通过AsyncLogger，分别对应前面我们说的Appender组件和Logger组件。

注意这是两种不同的实现方式，在设计和源码上都是不同的体现。

1、AsyncAppender方式

是通过引用别的Appender来实现的，当有日志事件到达时，会开启另外一个线程来处理它们。需要注意的是，如果在Appender的时候出现异常，对应用来说是无法感知的。

AsyncAppender应该在它引用的Appender之后配置，默认使用 java.util.concurrent.ArrayBlockingQueue实现而不需要其它外部的类库。当使用此Appender的时候，在多线程的环境下需要注意，阻塞队列容易受到锁争用的影响，这可能会对性能产生影响。这时候，我们应该考虑使用无锁的异步记录器（AsyncLogger）。

（1）使用示例

1.添加异步日志依赖
2.在Appenders标签中，对于异步进行配置使用Async标签
3.rootlogger引用Async

异步日志的使用需要添加异步日志的依赖：

<!-- 异步日志依赖 -->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.3.7</version>
</dependency>

log4j2.xml中的关键配置：

<!-- 配置异步日志 -->
<Async name="myAsync">
    <!-- 将控制台输出做异步的操作 -->
    <AppenderRef ref="consoleAppender"/>
</Async>
<!-- 配置rootlogger -->
<Root level="trace">
    <!-- 引用Appender -->
    <AppenderRef ref="myAsync"/>
</Root>

这样的话，会单独分配线程做日志的记录，不会阻塞主线程我们的正常业务逻辑。

2、AsyncLogger方式

AsyncLogger才是log4j2实现异步最重要的功能体现，也是 官方推荐 的异步方式。

它可以使得调用Logger.log返回的更快。你可以有两种选择：全局异步和混合异步。

全局异步：所有的日志都异步的记录，在配置文件上不用做任何改动，只需要在jvm启动的时候增加一个参数即可实现。

混合异步：你可以在应用中同时使用同步日志和异步日志，这使得日志的配置方式更加灵活。虽然Log4j2提供以一套异常处理机制，可以覆盖大部分的状态，但是还是会有一小部分的特殊情况是无法完全处理的，比如我们如果是记录审计日志（特殊情况之一），那么官方就推荐使用同步日志的方式，而对于其他的一些仅仅是记录一个程序日志的地方，使用异步日志将大幅提升性能，减少对应用本身的影响。

混合异步的方式需要通过修改配置文件来实现，使用AsyncLogger标记配置。

（1）全局异步

所有的日志都是异步的日志记录，在配置文件上不用做任何的改动，只需要在类路径resources下添加一个properties属性文件，做一步配置即可。

文件名要求是：log4j2.component.properties
内容为：

Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

还是用我们正常的Appender就行，什么都不需要改动。

（2）混合异步

混合异步可以在应用中同时使用同步日志和异步日志，这使得日志的配置及输出会更加的灵活。

在Loggers中自定义Logger，使我们规定的包下的日志异步输出，而此外的日志都遵循Root配置。

<!-- 配置logger -->
<Loggers>
    <!-- 自定义logger，让自定义的logger为异步logger -->
        includeLocation="false"
        表示去除日志记录中的行号信息，这个行号信息非常的影响日志记录的效率（生产中都不加这个行号）
        严重的时候可能记录的比同步的日志效率还有低
        additivity="false"
        表示不继承rootlogger
    <AsyncLogger name="com.demo" level="trace"
                        includeLocation="false" additivity="false">
        <!-- 将控制台输出consoleAppender，设置为异步打印 -->
        <AppenderRef ref="consoleAppender"/>
    </AsyncLogger>
    <!-- 配置rootlogger -->
    <Root level="trace">
        <!-- 引用Appender -->
        <!--<AppenderRef ref="consoleAppender"/>-->
        <!--<AppenderRef ref="fileAppender"/>-->
        <!--<AppenderRef ref="rollingFile"/>-->
        <!--<AppenderRef ref="myAsync"/>-->
        <AppenderRef ref="consoleAppender"/>
    </Root>
</Loggers>

3、注意

所有的异步实现都不要同时配置，一般情况下只配置一种即可。

性能对比：

学习日志框架之——log4j2入门_apache

学习日志框架之——log4j2入门_java_02