Log4j2日志记录框架的使用教程与简单实例

原创

已于 2025-03-12 17:59:20 修改 · 1.7w 阅读

34 ·

CC 4.0 BY-SA版权

文章标签：

#log4j2

于 2020-02-14 17:50:56 首次发布

日志框架的使用，系列文章：

《SpringBoot使用Logback日志框架与综合实例》

《SpringBoot使用@Slf4j注解实现日志输出》

《Log4j2日志记录框架的使用教程与简单实例》

《SpringBoot使用AspectJ实现AOP记录接口：请求日志、响应日志、异常日志》

《SpringBoot使用AspectJ的@Around注解实现AOP全局记录接口：请求日志、响应日志、异常日志》

1、Log4j2的使用教程

1.1 简介

Log4j的1.x版本虽然已经被广泛使用于很多应用程序中，但由于出现内存泄漏等bug，代码难以维护，以及需要使用老版本的jdk等劣势，在2015年8月已经玩完。它的替代品，SLF4J，Logback，Log4j2对日志框架做了很多必要的改进。

历史上出现了很多的日记框架，如：

Log4j：Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。

Log4j2：Apache Log4j 2是apache开发的一款Log4j的升级产品。

Commons Logging：Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging。

Slf4j：类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）。

Logback：一套日志组件的实现(Slf4j阵营)。

Jul(Java Util Logging)：自Java1.4以来的官方日志实现。

1.2 安装

在开发中使用Log4j2日志记录框架需要引入的jar包如下：

log4j-api-2.13.0.jar
log4j-core-2.13.0.jar

这里使用Maven进行安装，pom.xml配置文件如下：

<properties>
    <logging.log4j.version>2.13.0</logging.log4j.version>
</properties>

<dependencies>
    <!-- Log4j2日志记录框架 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>${logging.log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>${logging.log4j.version}</version>
    </dependency>
</dependencies>

1.3 配置文件

在项目的src根目录下，创建log4j2.xml配置文件。配置信息如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- log4j2 配置文件 -->
<!-- 日志级别 trace<debug<info<warn<error<fatal -->
<configuration status="debug">
    <!-- 自定义属性 -->
    <Properties>
        <!-- 日志格式(控制台) -->
        <Property name="pattern1">[%-5p] %d %c - %m%n</Property>
        <!-- 日志格式(文件) -->
        <Property name="pattern2">
            =========================================%n 日志级别：%p%n 日志时间：%d%n 所属类名：%c%n 所属线程：%t%n 日志信息：%m%n
        </Property>
        <!-- 日志文件路径 -->
        <Property name="filePath">logs/myLog.log</Property>
    </Properties>

    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${pattern1}"/>
        </Console>
        <RollingFile name="RollingFile" fileName="${filePath}"
                     filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout pattern="${pattern2}"/>
            <SizeBasedTriggeringPolicy size="5 MB"/>
        </R