关于slf4j、log4j、log4j2 以及使用log4j-1.2-api将log4j适配到log4j2上的案例

关于关于slf4j、log4j、log4j2等的概念，以及介绍将三方库中的 log4j1 输出的日志转接到log4j2上的方式。

1379號监听猿

4648人浏览 · 2022-11-18 22:23:39

1379號监听猿 · 2022-11-18 22:23:39 发布

一、概念：

log4j：Apache 的一个开源日志框架实现
log4j2：Log4j 的升级版本
slf4j(Simple Logging Facade)：一个日志框架接口，与实现分离。开发时使用 slf4j，不强依赖具体的日志实现。运行时通过反射找到具体的日志实现。
- slf4j-log4j12：slf4j 到 log4j 的桥接器
- log4j-slf4j-impl：slf4j 到 log4j2 的桥接器
- log4j-1.2-api：log4j 到 log4j2 的适配器

二、使用

log4j

依赖：

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

配置

log4j.properties：

# log4j.rootLogger = [level],appenderName1,appenderName2,…
log4j.rootLogger=DEBUG,CONSOLE

#### 控制台输出 ####
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
# 输出到控制台
log4j.appender.CONSOLE.Target = System.out
# 指定控制台输出日志级别
log4j.appender.CONSOLE.Threshold = DEBUG
# 默认值是 true, 表示是否立即输出
log4j.appender.CONSOLE.ImmediateFlush = true
# 设置编码方式
log4j.appender.CONSOLE.Encoding = UTF-8
# 日志输出布局
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
# 如果日志输出布局为PatternLayout 自定义级别，需要使用ConversionPattern指定输出格式
log4j.appender.CONSOLE.layout.ConversionPattern=[LOG BY LOG4J]: %d{yyyy-MM-dd HH:mm:ss} %5p %c:%L - %m%n

使用：

org.apache.log4j.Logger log4j = org.apache.log4j.LogManager.getLogger(Log4jUtils.class);
log4j.info("log by log4j.");

输出：

[LOG BY LOG4J]: 2022-11-18 21:37:51  INFO org.example.Log4jUtils:22 - log by log4j.

log4j2

依赖：

        <!-- log4j2 日志实面 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <!--<version>2.16.0</version>-->
            <version>${log4j2.version}</version>
        </dependency>

配置

log4j2.xml：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 默认打印到控制台 -->
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 默认打印格式 -->
            <PatternLayout pattern="[LOG BY LOG4J2]: %d{yyyy-MM-dd HH:mm:ss} %5p %c:%L - %m%n"/>
        </Console>
    </Appenders>

    <Loggers>
        <!-- 默认打印日志级别为 info -->
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

使用：

org.apache.logging.log4j.Logger log4j2 = org.apache.logging.log4j.LogManager.getLogger(Application.class); 
log4j2 .info("log by log4j2.");

输出：

[LOG BY LOG4J2]: 2022-11-18 21:51:45  INFO org.example.Application:13 - log by log4j2.

slf4j

依赖：

    <dependency>
    		<groupId>org.slf4j</groupId>
    		<artifactId>slf4j-api</artifactId>
    </dependency>

slf4j 单独使用不会打印日志，要加上具体的日志实现以及相应的桥接包：
slf4j+log4j：

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
             <!--<version>1.7.25</version>-->
            <version>${slf4j.version}</version>
        </dependency>

slf4j+log4j2:

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

配置：

使用具体的日志实现配置即可。

使用：

org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(Application.class);
logger.info("log by slf4j.");

输出：

使用 log4j1 时输出：

[LOG BY LOG4J]: 2022-11-18 21:37:51  INFO org.example.Log4jUtils:22 - log by slf4j.

使用 log4j2 时输出：

[LOG BY LOG4J2]: 2022-11-18 21:51:45  INFO org.example.Application:13 - log by slf4j.

三、log4j-1.2-api 的使用案例

背景

项目中使用的是 log4j2，但是引入的三方库中直接使用了 log4j1。需要排除log4j1的干扰，并且将log4j1输出的日志转接到log4j2上。

项目搭建

创建项目：test-log4j-1.2-api

创建模块：

TripartiteDependence：模拟在代码里强依赖 log4j 的三方库。
Application：模拟开发场景。

TripartiteDependence

依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>test-log4j-1.2-api</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>TripartiteDependence</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <slf4j.version>1.7.25</slf4j.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
    </dependencies>
</project>

Log4jUtils：直接使用 log4j

package org.example;

/**
 * @author zhy
 */
public class Log4jUtils {
	// 强依赖日志实现框架 log4j 
    private static final org.apache.log4j.Logger log4j = org.apache.log4j.LogManager.getLogger(Log4jUtils.class);
    // 使用门面日志 slf4j
    private static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(Log4jUtils.class);

    public static void print(String msg) {
        log4j.info("[print by LogManager] " + msg);
        logger.info("[print by LoggerFactory] " + msg);
    }

    public static void main(String[] args) {
        logger.info("log by slf4j.");
        log4j.info("log by log4j.");
    }
}

log4j.properties 同上。

Application

依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>test-log4j-1.2-api</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>Application</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <log4j2.version>2.16.0</log4j2.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>TripartiteDependence</artifactId>
            <version>1.0-SNAPSHOT</version>
            <exclusions>
                <exclusion>
                    <artifactId>log4j</artifactId>
                    <groupId>log4j</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- 排除 log4j:log4j 后，将 log4j 适配为 log4j2 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-1.2-api</artifactId>
            <version>${log4j2.version}</version>
        </dependency>

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

log4j2.xml 同上。

测试代码：

package org.example;

/**
 * @author zhy
 */
public class Application {
    private static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(Application.class);
    private static final org.apache.logging.log4j.Logger log4j2 = org.apache.logging.log4j.LogManager.getLogger(Application.class);
    
    public static void main(String[] args) {
        // log4j2.info("log by log4j2.");
        // logger.info("log by slf4j.");
        Log4jUtils.print("hello ");
    }
}

输出：

[LOG BY LOG4J2]: 2022-11-18 22:04:44  INFO org.example.Log4jUtils:12 - [print by LogManager] hello 
[LOG BY LOG4J2]: 2022-11-18 22:04:44  INFO org.example.Log4jUtils:13 - [print by LoggerFactory] hello

可见，虽然 Log4jUtils 使用了 log4j，但是能够通过 log4j-1.2-api 适配到 log4j2 上。

有“AI”的1024 = 2048，欢迎大家加入2048 AI社区

更多推荐

cover

基于Spring AI实现多轮对话系统架构设计

cover

AI原生应用领域提示工程：构建智能服务体系的关键

cover

特斯拉AI布局：从自动驾驶到人形机器人的野心

所有评论(0)

查看更多评论

1379號监听猿

已为社区贡献2条内容