Slf4j日志绑定/日志桥接

原文链接：Slf4j日志绑定/日志桥接 – 编程屋

目录

1 前言

2 Slf4j

        2.1  使用slf4j日志的绑定流程

        2.2 日志框架绑定入门

        2.3 桥接旧的日志框架

---

1 前言

在上篇我们了解了JCL这样一个日志门面技术，不过JCL因为在底层已经将它可以配置的日志框架全部都定下来了。无法在衔接其他的日志框架，那么它就在2014年的时候被抛弃了。因为随着技术的发展，肯定会有越来越多优秀的日志框架，所以需要我们提供一个向上可以兼容老的日志试下，向下可以衔接新的日志框架的日志门面。由此而来，Slf4j就此诞生了。

简单日志门面技术SLF4j主要是为了给Java日志访问提供一套标准。规范的API框架，其主要意义是在于提供接口，具体的实现可以交由其他日志框架，例如log4j和logback等。当然slf4j自己也提供了功能较为简单的实现，但是一般很少用到。对于一般的Java项目而言，日志框架会选择slf4j-api作为门面，配上具体的日志实现框架(log4j，logback)中间使用桥接器作为桥接。

2 Slf4j

SLF4j作为日志门面技术主要提供两大功能：

1. 日志框架的绑定

2. 日志框架的桥接

2.1  使用slf4j日志的绑定流程

        1 添加slf4-api的依赖

        2 使用slf4j的API在项目中进行统一的日志记录

        3 绑定具体的日志实现框架

                1. 绑定已经实现了slf4j的日志框架，直接添加对应依赖

                2. 绑定没有实现slf4j的日志框架，先添加日志的适配器，再添加实现类的依赖

        4 slf4j有且仅有一个日志实现框架的绑定(如果出现多个默认使用第一个依赖日志实现)

以上是从官网截取的一张图，上面详细展示了slf4j作为日志门面时，如何衔接日志框架。

可以从三个部分来表示：

第一部分(红色框)：当我们只引入了slf4j的api接口，并没有引入相关的日志依赖时，将不会进行日志输出。

第二部分(蓝色框):  蓝色框中的三个日志框架比slf4j出的时候较晚，所以已经自动适配slf4j，我们只需要引入相应的依赖就可以实现slf4j作为门面，选中框架作为框架作为日志输出方式。

第三部分(青色框):  青色框的两个日志依赖比slf4j出的时候较晚，所以不能直接引入该依赖，需要先引入相应的适配器，再引入依赖，才能够实现该功能。

注意：一个slf4j只能绑定一个日志框架，绑定多个之后会默认选择第一个日志框架。

2.2 日志框架绑定入门

引入slf4j日志门面和具体实现依赖

<!--slf4j日志门面接口-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version>
</dependency>

<!--slf4j内置的简单实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.5</version>
</dependency>

测试类：

public class SLF4JTest {

    public static final Logger LOGGER = LoggerFactory.getLogger(SLF4JTest.class);

    @Test
    public void test(){
        LOGGER.error("error");
        LOGGER.warn("warn");
        LOGGER.info("info");
        LOGGER.debug("debug");
        LOGGER.trace("trace");


    }




}

测试结果:

 可见slf4j的日志默认输出级别为:info

除此之外，还可以使用占位符来输出日志信息：

String name = "啦啦啦";
Integer age = 14;
LOGGER.info("用户姓名和年龄分别为:{},{}",name,age);
try {
    int a = 1/0;
} catch (Exception e) {
    LOGGER.error("出现异常:",e);
}

 结果为:

2.3 桥接旧的日志框架

通常，在我们的项目中依赖了SLF4j以外的日志记录API。如果有一天，项目进行迭代升级，想要切换到slf4j的日志门面和另外一种日志框架，那么之前项目中所用到了日志记录需要全部进行改动吗? 其实是不用的，桥接解决的就是日志的遗留问题。

 当系统中存在存在之前的日志API，可以通过桥接转换到slf4的实现。

1 先去除老的日志框架的依赖

2 添加slf4提供的日志桥接组件

3为项目添加具体的SLF4j的具体实现

我们可以先用代码演示下：

步骤一：先用slf4j+log4j进行日志输出

相关依赖:

        <!--slf4j日志门面接口-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>

        <!--slf4j内置的简单实现-->
<!--        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.5</version>
        </dependency>-->

        <!--绑定log4j需要先导入适配器-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.32</version>
        </dependency>

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

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

配置文件：

log4j.rootLogger = trace,console
#指定控制台日志输出的appender
log4j.appender.console = org.apache.log4j.ConsoleAppender
#指定消息格式 layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
#指定消息格式的内容
log4j.appender.console.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss} %m%n

测试类：

public class Log4jTest {

    public static final Logger LOGGER = Logger.getLogger(SLF4JTest.class);

    @Test
    public void test(){
        LOGGER.info("hello");
    }

}

测试结果正常输出:

步骤二：项目进行迭代升级，用lockback日志框架替代log4j（此时将log4j依赖注释掉，但项目会报错）

改动后依赖：

        <!--slf4j日志门面接口-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>

        <!--slf4j内置的简单实现-->
<!--        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.5</version>
        </dependency>-->

        <!--绑定log4j需要先导入适配器-->
<!--        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.32</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>-->

        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.7</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

之前项目已经报错：

步骤三：添加对应的桥接组件

        <!--配置log4j的桥接器-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
            <version>1.7.25</version>
        </dependency>

就可以发现我们的测试可以正常进行输出了，并且采用的是logback的底层实现。

注意事项:

        1 . jcl-over-slf4j.jar 和 slf4j-jcl.jar不能同时部署，前一个jar文件会导致JCL将日志系统的选择委托给SLF4J，后一个jar文件将导致SLF4j将日志系统的选择委托给JCL,从而导致无限循环。

        2. log4j-over-slf4和slf4j-log12.加入不能同时出现

        3. jul-to-slf4j.jar和slf4j-jdk14.jar不能同时出现

        4. 所有的桥接只对Logger日志记录器有效，如果程序中调用了内部低配置类或者Appender，Filter等对象，将无法产生效果

原文链接：Slf4j日志绑定/日志桥接 – 编程屋