1. SLF4J日志门面

JCL日志门面逐渐被淘汰了,因为他无法动态的扩展具体的日志实现框架。

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

官方网站: https://www.slf4j.org/

SLF4J是目前市面上最流行的日志门面。现在的项目中,基本上都是使用SLF4J作为我们的日志系统。SLF4J日志门面主要提供两大功能:

日志框架的绑定日志框架的桥接

1.1 SLF4J入门案例

首先创建一个普通的Maven项目:

然后导入slf4j所需的依赖:

junit

junit

4.12

org.slf4j

slf4j-api

1.7.27

org.slf4j

slf4j-simple

1.7.27

接下来就可以编写测试代码了:

Slf4jTest.java

package com.tian.logs;

import org.junit.Test;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class Slf4jTest {

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

// 快速入门

@Test

public void test01() throws Exception {

// 日志输出

LOGGER.error("error");

LOGGER.warn("wring");

LOGGER.info("info"); // 默认级别

LOGGER.debug("debug");

LOGGER.trace("trace");

// 使用占位符输出日志信息

String name = "itheima";

Integer age = 14;

LOGGER.info("用户:{},{}", name, age);

// 将系统的异常信息输出

try {

int i = 1 / 0;

} catch (Exception e) {

// e.printStackTrace();

LOGGER.error("出现异常:", e);

}

}

}

运行结果:

1.2 SLF4J作为日志门面的优点

使用SLF4J框架,可以在部署时迁移到所需的日志记录框架。SLF4J提供了对所有流行的日志框架的绑定,例如log4j,JUL,Simple logging和NOP。因此可以 在部署时切换到任何这些流行的框架。无论使用哪种绑定,SLF4J都支持参数化日志记录消息。由于SLF4J将应用程序和日志记录框架分离, 因此可以轻松编写独立于日志记录框架的应用程序。而无需担心用于编写应用程序的日志记录框架。SLF4J提供了一个简单的Java工具,称为迁移器。使用此工具,可以迁移现有项目,这些项目使用日志 框架(如Jakarta Commons Logging(JCL)或log4j或Java.util.logging(JUL))到SLF4J。

1.3 SLF4J日志绑定

SLF4J支持各种日志框架。SLF4J发行版附带了几个称为 “SLF4J绑定” 的jar文件,每个绑定对应一个受支持的框架。

使用slf4j的日志绑定流程:

添加slf4j-api的依赖使用slf4j的API在项目中进行统一的日志记录绑定具体的日志实现框架

绑定已经实现了slf4j的日志框架,直接添加对应依赖绑定没有实现slf4j的日志框架,先添加日志的适配器,再添加实现类的依赖 slf4j有且仅有一个日志实现框架的绑定(如果出现多个默认使用第一个依赖日志实现)

通过maven引入常见的日志实现框架:

org.slf4j

slf4j-api

1.7.27

org.slf4j

slf4j-log4j12

1.7.27

log4j

log4j

1.2.17

org.slf4j

slf4j-jdk14

1.7.27

org.slf4j

slf4j-jcl

1.7.27

org.slf4j

slf4j-nop

1.7.27

ch.qos.logback

logback-classic

1.2.3

SLF4J不依赖于任何特殊的类装载。实际上,每个SLF4J绑定在编译时都是硬连线的, 以使用一个且只有一个特定的日志记录框架。例如,slf4j-log4j12-1.7.27.jar绑定在编译时绑定以使用log4j。在您的代码中,除了slf4j-api-1.7.27.jar之外,您只需将您选择的一个且只有一个绑定放到相应的类路径位置。不要在类路径上放置多个绑定。以下是一般概念的图解说明。

示例:SLF4J绑定Log4j框架作为日志实现

现在项目中已有的依赖如下:

junit

junit

4.12

org.slf4j

slf4j-api

1.7.27

org.slf4j

slf4j-log4j12

1.7.27

log4j

log4j

1.2.17

再次运行刚刚的代码:

现在我们创建Log4j的配置文件:

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息

# 指定日志级别=trace,使用的 appenderw 为=console

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.SSS} %m%n

再次运行上面的测试代码:

1.4 SL4J桥接旧的日志框架(Bridging)

通常,您依赖的某些组件依赖于SLF4J以外的日志记录API。您也可以假设这些组件在不久的将来不会切换到SLF4J。为了解决这种情况,SLF4J附带了几个桥接模块,这些模块将对log4j,JCL和java.util.logging API的调用重定向,就好像它们是对SLF4J API一样。

桥接解决的是项目中日志的遗留问题,当系统中存在之前的日志API,可以通过桥接转换到slf4j的实现。

迁移的方式:如果我们要使用SLF4J的桥接器,替换原有的日志框架,那么我们需要做的第一件事情,就是删除掉原有项目中的日志框架的依赖。然后替换成SLF4J提供的桥接器。

示例:

我们先编写一个测试程序:

Log4jTest.java

package com.tian.logs;

import org.apache.log4j.Logger;

import org.junit.Test;

public class Log4jTest {

// 定义 log4j 日志记录器

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

// 测试桥接器

@Test

public void test01() throws Exception {

LOGGER.info("hello lgo4j");

}

}

运行结果:

现在我们删去SL4J相关的依赖:

现在程序报错了:

现在我们导入Log4J桥接器,并导入JUL日志实现框架(你也可以导入除了LOG4J外的所有日志实现框架,但是千万不要同时存在LOG4J日志框架和LOG4J的桥接器,这样会出现死循环!导致栈溢出异常)

现在程序的依赖:

junit

junit

4.12

org.slf4j

slf4j-api

1.7.27

org.slf4j

log4j-over-slf4j

1.7.27

org.slf4j

slf4j-jdk14

1.7.27

我们去运行刚刚测试的代码:

说明:

桥接解决的是项目中日志的遗留问题,当系统中存在之前的日志API,可以通过桥接转换到slf4j的实现,其实现的具体步骤为:

先去除之前老的日志框架的依赖添加SLF4J提供的桥接组件为项目添加SLF4J的具体实现

图解:

注意问题:

jcl-over-slf4j.jar和 slf4j-jcl.jar不能同时部署。前一个jar文件将导致JCL将日志系统的选择委托给SLF4J,后一个jar文件将导致SLF4J将日志系统的选择委托给JCL,从而导致无限循环。log4j-over-slf4j.jar和slf4j-log4j12.jar不能同时出现,这也会导致无限循环。jul-to-slf4j.jar和slf4j-jdk14.jar不能同时出现所有的桥接都只对Logger日志记录器对象有效,如果程序中调用了内部的配置类或者是 Appender,Filter等对象,将无法产生效果。

1.5 SLF4J原理

SLF4J通过LoggerFactory加载日志具体的实现对象。LoggerFactory在初始化的过程中,会通过performInitialization()方法绑定具体的日志实现。在绑定具体实现的时候,通过类加载器,加载org.slf4j.impl.StaticLoggerBinder.class所以,只要是一个日志实现框架,在org.slf4j.impl包中提供一个自己的StaticLoggerBinder类,在其中提供具体日志实现的LoggerFactory就可以被SLF4J所加载

好文链接

评论可见,请评论后查看内容,谢谢!!!
 您阅读本篇文章共花了: