java日志门面之JCL和SLF4J

前言

什么时日志门面？

  随着系统开发的进行，可能会更新不同的日志框架，造成当前系统中存在不同的日志依赖，让我们难以统一的管理和控制。借鉴JDBC的思想，为日志系统也提供一套门面，那么我们就可以面向这些接口规范来开发，避免了直接依赖具体的日志框架。这样我们的系统在日志中，就存在了日志的门面和日志的实现。

常见的日志框架及日志门面

• 常见日志门面：JCL、slf4j
• 常见日志实现：JUL、log4j、logback、log4j2
• 框架诞生顺序：log4j --> JUL --> JCL --> slf4j --> logback --> log4j2

日志门面和日志实现的关系

一、JCL

1、JCL简介

• 全称为Jakarta Commons Logging，是Apache提供的一个通用日志API
• common-logging会通过动态查找的机制，在程序运行时自动找出log4j，或者jdk自带的jul
• 使用它的好处就是，代码依赖是common-logging而非log4j的API， 避免了和具体的日志API直接耦合，在有必要时，可以更改日志实现的第三方库（不改变代码，只修改依赖）
• JCL有两个基本的抽象类：Log（日志记录器），LogFactory（日志工厂负责创建Log实例）

2、快速入门

jcl依赖

<dependency><groupId>commons-logging</groupId><artifactId>commons-logging</artifactId><version>1.2</version>
</dependency>

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;public class JCLTest {@Testpublic void test01() {Log log = LogFactory.getLog(JCLTest.class);log.info("info");}
}

只导入commons-logging的输出结果

• 此时没有任何第三方日志框架，我们使用的就是jdk自带的JUL

导入commons-logging并添加log4j依赖和log4j.properties配置文件输出结果

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

#配置根节点logger
log4j.rootLogger=info,consolelog4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-10p] [%t] [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%l] %m%n

3、 JCL原理

• 通过LogFactory动态加载Log实现类
• Jdk14Logger就是jdk自带JUL日志框架（因为JUL从jdk1.4开始提供）
• SimpleLog是日志门面JCL自带日志，功能简单一般不用

• 日志门面创建公共接口org.apache.commons.logging.Log
• 日志实现类Logger实现接口Log，这样对外暴露的Log不变，只需要动态加载不同的Logger
• 如果只导入JCL门面，不导入其他日志实现，那么日志实现为jdk自带JUL
• 如果导入JCL门面，并导入log4j依赖，那么日志实现为log4j，log4j优先级最高

二、SLF4J

1、SLF4J简介

• 简单日志门面(Simple Logging Facade For Java) SLF4J主要是为了给Java日志访问提供一套标准、规范的API框架
• 主要意义在于提供接口，具体的实现可以交由其他日志框架，例如log4j和logback等
• slf4j自己也提供了功能较为简单的实现，但是一般很少用到
• SLF4J最重要的两个功能就是对于日志框架的绑定以及日志框架的桥接

2、快速入门

slf4j依赖

<!--slf4j 核心依赖-->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.25</version>
</dependency><!--slf4j 自带的简单日志实现 -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-simple</artifactId><version>1.7.25</version>
</dependency>

• slf4j-api只提供api，具体日志实现由slf4j-simple提供

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class SLF4JTest {@Testpublic void test01(){Logger logger = LoggerFactory.getLogger(SLF4JTest.class);logger.trace("trace信息");logger.debug("debug信息");logger.info("info信息");logger.warn("warn信息");logger.error("error信息");}
}

输出结果：

2.1、输出动态信息

• Logger方法：public void info(String format, Object... arguments);

@Test
public void test02() {Logger logger = LoggerFactory.getLogger(SLF4JTest.class);String name = "zs";int age = 23;// logger.info("学生信息-姓名："+name+"；年龄："+age); 字符串拼接，效率低// logger.info("学生信息-姓名：{}，年龄：{}",new Object[]{name,age}); 老方式，代码冗余logger.info("学生信息-姓名：{}，年龄：{}", name, age);// 新方式，简单
}

输出结果：

2.2、异常信息的处理

• Logger方法：public void info(String msg, Throwable t);

@Test
public void test03() {Logger logger = LoggerFactory.getLogger(SLF4JTest.class);try {Class.forName("aaa");} catch (ClassNotFoundException e) {// 打印栈追踪信息// e.printStackTrace();logger.info("具体错误是：", e);}
}

输出结果：

3、绑定日志的实现

使用slf4j绑定日志的流程

• 添加slf4j-api的依赖
• 使用slf4j的API在项目中进行统一的日志记录
• 绑定具体的日志实现框架
  • 绑定已经实现了slf4j的日志框架,直接添加对应依赖
  • 绑定没有实现slf4j的日志框架,先添加日志的适配器,再添加实现类的依赖
• slf4j有且仅有一个日志实现框架的绑定（如果出现多个默认使用第一个依赖日志实现）

使用slf4j绑定日志的原理

• public class StaticLoggerBinder implements LoggerFactoryBinder
• 这个类负责静态org.slf4j.LoggerFactory类与相应的日志实现ILoggerFactory类绑定
• 只要有这个类就可以实现slf4j门面+对应日志实现，包名都是org.slf4j.impl

3.1、slf4j实现slf4j-simple和logback

  slf4j-simple和logback都是slf4j门面出现后才有的日志实现，所以这两生来就有自己的StaticLoggerBinder类。

依赖

<!--slf4j 核心依赖-->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.25</version>
</dependency><!-- logback依赖 -->
<dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId><version>1.2.3</version>
</dependency><!--slf4j 自带的简单日志实现 -->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-simple</artifactId><version>1.7.25</version>
</dependency>

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

• 如果有多个日志实现的话，会出红色警告，默认使用先导入的实现
• 无论使用slf4j自己的slf4j-simple还是logback，导包都不会变，都用的以上两个

@Test
public void test04(){Logger logger = LoggerFactory.getLogger(SLF4JTest.class);logger.trace("trace信息");logger.debug("debug信息");logger.info("info信息");logger.warn("warn信息");logger.error("error信息");
}

输出结果：

3.2、slf4j绑定适配器实现log4j

• 由于log4j是在slf4j之前出品的日志框架实现，所以并没有遵循slf4j的API规范
• 之前集成的logback，是slf4j之后出品的日志框架实现，就是按照slf4j的标准指定的API，所以我们导入依赖就能用
• 如果想要使用slf4j门面，需要绑定一个适配器slf4j-log4j12

依赖

<!--slf4j 核心依赖-->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.25</version>
</dependency><!-- 
导入log4j适配器依赖
slf4j-log4j12依赖的slf4j-api，slf4j-api可以不用重复导入依赖-->
<dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId><version>1.7.25</version>
</dependency>

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Test
public void test05(){Logger logger = LoggerFactory.getLogger(SLF4JTest.class);logger.trace("trace信息");logger.debug("debug信息");logger.info("info信息");logger.warn("warn信息");logger.error("error信息");
}

log4j.properties

#指定日志的输出级别与输出端
log4j.rootLogger=info,console# 配置appender输出方式：输出到控制台
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-10p] [%t] [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%l] %m%n

输出结果：

  与slf4j-simple和logback的实现原理其实一样，都是在相同包下org.slf4j.impl下创建StaticLoggerBinder类将slf4j门面与日志实现绑定起来。log4j需要适配器slf4j-log4j12，JUL需要适配器slf4j-jdk14

4、桥接旧的日志框架

桥接解决的问题：当系统中存在之前的日志API，可以通过桥接转换到slf4j的实现

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

4.1、log4j日志重构为slf4j+logback的组合

重构前

依赖

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

log4j.properties

#配置根节点logger
log4j.rootLogger=trace,consolelog4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern=[%-10p]%r %c%t%d{yyyy-MM-dd HH:mm:ss:SSS} %m%n

导包

import org.apache.log4j.Logger;

@Test
public void test07(){Logger logger = Logger.getLogger(Log4jTest.class);logger.info("info信息");
}

• 查看Logger类源码，属于log4j包下的类

重构后

• 依赖：删除log4j依赖，添加slf4j提供的桥接组件和logback依赖

<!-- log4j相关的桥接器 -->
<dependency><groupId>org.slf4j</groupId><artifactId>log4j-over-slf4j</artifactId><version>1.7.25</version>
</dependency>
<!-- logback依赖 -->
<dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId><version>1.2.3</version>
</dependency>

• 导包：依然不变

import org.apache.log4j.Logger;

@Test
public void test08(){Logger logger = Logger.getLogger(Log4jTest.class);logger.info("info信息");
}

• 查看Logger类源码，属于log4j-over-slf4j包下的类

  如此操作，看上去依赖还是org.apache.log4j.Logger，实际已不再是log4j包下的类，日志实现也变成了slf4j门面可以随意搭配的方式了。