登录 注册

jcl 与 jul、log4j1、log4j2、logback 的集成原理 (转)

本贴最后更新于 2548 天前，其中的信息可能已经天翻地覆

1 系列目录

前面介绍了 jdk 自带的 logging、log4j1、log4j2、logback 等实际的日志框架

对于开发者而言，每种日志都有不同的写法。如果我们以实际的日志框架来进行编写，代码就限制死了，之后就很难再更换日志系统，很难做到无缝切换。

java web 开发就经常提到一项原则：面向接口编程，而不是面向实现编程

所以我们应该是按照一套统一的 API 来进行日志编程，实际的日志框架来实现这套 API，这样的话，即使更换日志框架，也可以做到无缝切换。

这就是 commons-logging 与 slf4j 的初衷。

下面就来介绍下 commons-logging 与 slf4j 这两个门面如何与上述四个实际的日志框架进行集成的呢

介绍之前先说明下日志简称：

  • jdk 自带的 logging-> 简称 jul (java-util-logging)
  • apache commons-logging-> 简称 jcl

2 apache commons-logging

先从一个简单的使用案例来说明

2.1 简单的使用案例

private static Log logger=LogFactory.getLog(JulJclTest.class);

public static void main(String[] args){
	if(logger.isTraceEnabled()){
		logger.trace("commons-logging-jcl trace message");
	}
	if(logger.isDebugEnabled()){
		logger.debug("commons-logging-jcl debug message");
	}
	if(logger.isInfoEnabled()){
		logger.info("commons-logging-jcl info message");
	}
}

上述 Log、LogFactory 都是 commons-logging 自己的接口和类

2.2 使用原理

LogFactory.getLog(JulJclTest.class)的源码如下：

public static Log getLog(Class clazz) throws LogConfigurationException {
    return getFactory().getInstance(clazz);
}

上述获取 Log 的过程大致分成 2 个阶段

  • 获取 LogFactory 的过程 (从字面上理解就是生产 Log 的工厂)
  • 根据 LogFactory 获取 Log 的过程

commons-logging 默认提供的 LogFactory 实现：LogFactoryImpl commons-logging 默认提供的 Log 实现：Jdk14Logger、Log4JLogger、SimpleLog。

来看下 commons-logging 包中的大概内容：

下面来详细说明：

  • 1 获取 LogFactory 的过程

    从下面几种途径来获取 LogFactory

    • 1.1 系统属性中获取，即如下形式

      System.getProperty("org.apache.commons.logging.LogFactory")

    • 1.2 使用 java 的 SPI 机制，来搜寻对应的实现

      对于 java 的 SPI 机制，详细内容可以自行搜索，这里不再说明。搜寻路径如下：

      META-INF/services/org.apache.commons.logging.LogFactory

      简单来说就是搜寻哪些 jar 包中含有搜寻含有上述文件，该文件中指明了对应的 LogFactory 实现

    • 1.3 从 commons-logging 的配置文件中寻找

      commons-logging 也是可以拥有自己的配置文件的，名字为 commons-logging.properties，只不过目前大多数情况下，我们都没有去使用它。如果使用了该配置文件，尝试从配置文件中读取属性"org.apache.commons.logging.LogFactory"对应的值

    • 1.4 最后还没找到的话，使用默认的 org.apache.commons.logging.impl.LogFactoryImpl

      LogFactoryImpl 是 commons-logging 提供的默认实现

  • 2 根据 LogFactory 获取 Log 的过程

    这时候就需要寻找底层是选用哪种类型的日志

    就以 commons-logging 提供的默认实现为例，来详细看下这个过程：

    • 2.1 从 commons-logging 的配置文件中寻找 Log 实现类的类名

      从 commons-logging.properties 配置文件中寻找属性为"org.apache.commons.logging.Log"对应的 Log 类名

    • 2.2 从系统属性中寻找 Log 实现类的类名

      即如下方式获取：

      System.getProperty("org.apache.commons.logging.Log")

    • 2.3 如果上述方式没找到，则从 classesToDiscover 属性中寻找

      classesToDiscover 属性值如下：

      private static final String[] classesToDiscover = {
    "org.apache.commons.logging.impl.Log4JLogger",
    "org.apache.commons.logging.impl.Jdk14Logger",
    "org.apache.commons.logging.impl.Jdk13LumberjackLogger",
    "org.apache.commons.logging.impl.SimpleLog"
};

      它会尝试根据上述类名，依次进行创建，如果能创建成功，则使用该 Log，然后返回给用户。

下面针对具体的日志框架，看看 commons-logging 是如何集成的

3 commons-logging 与 jul 集成

3.1 需要的 jar 包

  • commons-logging

对应的 maven 依赖是：

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

3.2 使用案例

private static Log logger=LogFactory.getLog(JulJclTest.class);

public static void main(String[] args){
	if(logger.isTraceEnabled()){
		logger.trace("commons-logging-jcl trace message");
	}
	if(logger.isDebugEnabled()){
		logger.debug("commons-logging-jcl debug message");
	}
	if(logger.isInfoEnabled()){
		logger.info("commons-logging-jcl info message");
	}
}

结果输出如下：

四月 27, 2015 11:13:33 下午 com.demo.log4j.JulJclTest main
信息: commons-logging-jcl info message

3.3 使用案例分析

案例过程分析，就是看看上述 commons-logging 的在执行原理的过程中是如何来走的

  • 1 获取获取 LogFactory 的过程

    • 1.1 我们没有配置系统属性"org.apache.commons.logging.LogFactory"
    • 1.2 我们没有配置 commons-logging 的 commons-logging.properties 配置文件
    • 1.3 也没有含有"META-INF/services/org.apache.commons.logging.LogFactory"路径的 jar 包

    所以 commons-logging 会使用默认的 LogFactoryImpl 作为 LogFactory

  • 2 根据 LogFactory 获取 Log 的过程

    • 2.1 我们没有配置 commons-logging 的 commons-logging.properties 配置文件
    • 2.2 我们没有配置系统属性"org.apache.commons.logging.Log"

    所以就需要依次根据 classesToDiscover 中的类名称进行创建。

    • 2.3 先是创建 org.apache.commons.logging.impl.Log4JLogger

      创建失败，因为该类是依赖 org.apache.log4j 包中的类的

    • 2.4 接着创建 org.apache.commons.logging.impl.Jdk14Logger

      创建成功，所以我们返回的就是 Jdk14Logger，看下它是如何与 jul 集成的

      它内部有一个 java.util.logging.Logger logger 属性，所以 Jdk14Logger 的 info("commons-logging-jcl info message")操作都会转化成由 java.util.logging.Logger 来实现：

      上述 logger 的来历：

      logger = java.util.logging.Logger.getLogger(name);

      就是使用 jul 原生的方式创建的一个 java.util.logging.Logger，参见 jdk-logging 的原生写法

      是如何打印 info 信息的呢？

      使用 jul 原生的方式：

      logger.log(Level.WARNING,"commons-logging-jcl info message");

由于 jul 默认的级别是 INFO 级别(见上一篇文章的说明中的配置文件 jdk 自带的 logging)，所以只打出了如下信息：

四月 27, 2015 11:41:24 下午 com.demo.log4j.JulJclTest main
信息: commons-logging-jcl info message

原生的 jdk 的 logging 的日志级别是 FINEST、FINE、INFO、WARNING、SEVERE 分别对应我们常见的 trace、debug、info、warn、error。

4 commons-logging 与 log4j1 集成

4.1 需要的 jar 包

  • commons-logging
  • log4j

对应的 maven 依赖是：

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

4.2 使用案例

  • 在类路径下加入 log4j 的配置文件 log4j.properties

    log4j.rootLogger = trace, console
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} %m%n

  • 使用方式如下：

    private static Log logger=LogFactory.getLog(Log4jJclTest.class);

public static void main(String[] args){
	if(logger.isTraceEnabled()){
		logger.trace("commons-logging-log4j trace message");
	}
	if(logger.isDebugEnabled()){
		logger.debug("commons-logging-log4j debug message");
	}
	if(logger.isInfoEnabled()){
		logger.info("commons-logging-log4j info message");
	}
}

代码没变，还是使用 commons-logging 的接口和类来编程，没有 log4j 的任何影子。这样，commons-logging 就与 log4j 集成了起来，我们可以通过 log4j 的配置文件来控制日志的显示级别

上述是 trace 级别(小于 debug)，所以 trace、debug、info 的都会显示出来

4.3 使用案例分析

案例过程分析，就是看看上述 commons-logging 的在执行原理的过程中是如何来走的:

  • 1 获取获取 LogFactory 的过程

    同上述 jcl 的过程一样，使用默认的 LogFactoryImpl 作为 LogFactory

  • 2 根据 LogFactory 获取 Log 的过程

    同上述 jcl 的过程一样，最终会依次根据 classesToDiscover 中的类名称进行创建：

    先是创建 org.apache.commons.logging.impl.Log4JLogger

    创建成功，因为此时含有 log4j 的 jar 包，所以返回的是 Log4JLogger，我们看下它与 commons-logging 是如何集成的：

    它内部有一个 org.apache.log4j.Logger logger 属性，这个是 log4j 的原生 Logger。所以 Log4JLogger 都是委托这个 logger 来完成的

    • 2.1 org.apache.log4j.Logger logger 来历

      org.apache.log4j.Logger.getLogger(name)

      使用原生的 log4j1 的写法来生成，参见之前 log4j 原生的写法 log4j1 原生的写法，我们知道上述过程会引发 log4j1 的配置文件的加载，之后就进入 log4j1 的世界了

    • 2.2 输出日志

      测试案例中我们使用 commons-logging 输出的日志的形式如下（这里的 logger 是 org.apache.commons.logging.impl.Log4JLogger 类型）：

      logger.debug("commons-logging-log4j debug message");

      其实就会转换成 log4j 原生的 org.apache.log4j.Logger 对象（就是上述获取的 org.apache.log4j.Logger 类型的 logger 对象）的如下输出：

      logger.debug("log4j debug message");

上述过程最好与 log4j1 的原生方式对比着看，见 log4j1 的原生方式

5 commons-logging 与 log4j2 集成

5.1 需要的 jar 包

  • commons-logging
  • log4j-api （log4j2 的 API 包）
  • log4j-core （log4j2 的 API 实现包）
  • log4j-jcl （log4j2 与 commons-logging 的集成包）

对应的 maven 依赖是：

<dependency>
	<groupId>commons-logging</groupId>
	<artifactId>commons-logging</artifactId>
	<version>1.2</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.2</version>
</dependency>
<dependency>
	<groupId>org.apache.logging.log4j</groupId>
	<artifactId>log4j-core</artifactId>
	<version>2.2</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-jcl</artifactId>
    <version>2.2</version>
</dependency>

5.2 使用案例

  • 编写 log4j2 的配置文件 log4j2.xml，简单如下：

    <?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="debug">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

  • 使用案例如下：

    private static Log logger=LogFactory.getLog(Log4j2JclTest.class);

public static void main(String[] args){
	if(logger.isTraceEnabled()){
		logger.trace("commons-logging-log4j trace message");
	}
	if(logger.isDebugEnabled()){
		logger.debug("commons-logging-log4j debug message");
	}
	if(logger.isInfoEnabled()){
		logger.info("commons-logging-log4j info message");
	}
}

仍然是使用 commons-logging 的 Log 接口和 LogFactory 来进行编写，看不到 log4j2 的影子。但是这时候含有上述几个 jar 包，log4j2 就与 commons-logging 集成了起来。

5.3 使用案例分析

案例过程分析，就是看看上述 commons-logging 的在执行原理的过程中是如何来走的:

  • 1 先来看下上述 log4j-jcl（log4j2 与 commons-logging 的集成包）的来历：

    我们知道，commons-logging 原始的 jar 包中使用了默认的 LogFactoryImpl 作为 LogFactory，该默认的 LogFactoryImpl 中的 classesToDiscover（到上面查看它的内容）并没有 log4j2 对应的 Log 实现类。所以我们就不能使用这个原始包中默认的 LogFactoryImpl 了，需要重新指定一个，并且需要给出一个 apache 的 Log 实现（该 Log 实现是用于 log4j2 的），所以就产生了 log4j-jcl 这个 jar 包，来看下这个 jar 包的大致内容：

    这里面的 LogFactoryImpl 就是要准备替换 commons-logging 中默认的 LogFactoryImpl（其中 META-INF/services/下的那个文件起到重要的替换作用，下面详细说）

    这里面的 Log4jLog 便是针对 log4j2 的，而 commons-logging 中的原始的 Log4JLogger 则是针对 log4j1 的。它们都是 commons-logging 的 Log 接口的实现

  • 2 获取获取 LogFactory 的过程

    这个过程就和 jul、log4j1 的集成过程不太一样了。通过 java 的 SPI 机制，找到了 org.apache.commons.logging.LogFactory 对应的实现，即在 log4j-jcl 包中找到的，其中 META-INF/services/org.apache.commons.logging.LogFactory 中的内容是：

    org.apache.logging.log4j.jcl.LogFactoryImpl

    即指明了使用 log4j-jcl 中的 LogFactoryImpl 作为 LogFactory

  • 3 根据 LogFactory 获取 Log 的过程

    就来看下 log4j-jcl 中的 LogFactoryImpl 是怎么实现的

    public class LogFactoryImpl extends LogFactory {

	private final LoggerAdapter<Log> adapter = new LogAdapter();
	//略
}

    这个 LoggerAdapter 是 lo4j2 中的一个适配器接口类，根据 log4j2 生产的原生的 org.apache.logging.log4j.Logger 实例，将它包装成你指定的泛型类。

    这里使用的 LoggerAdapter 实现是 LogAdapter，它的内容如下：

    public class LogAdapter extends AbstractLoggerAdapter<Log> {
    @Override
    protected Log newLogger(final String name, final LoggerContext context) {
        return new Log4jLog(context.getLogger(name));
    }
    @Override
    protected LoggerContext getContext() {
        return getContext(ReflectionUtil.getCallerClass(LogFactory.class));
    }
}

    我们可以看到，它其实就是将原生的 log4j2 的 Logger 封装成 Log4jLog。这里就可以看明白了，下面来详细的走下流程，看看是什么时候来初始化 log4j2 的：

    • 3.1 首先获取 log4j2 中的重要配置对象 LoggerContext，LogAdapter 的实现如上面的源码（使用父类的 getContext 方法），父类方法的内容如下：

      LogManager.getContext(cl, false);

      我们可以看到这其实就是使用 log4j2 的 LogManager 进行初始化的，至此就进入 log4j2 的初始化的世界了。

    • 3.2 log4j2 的 LoggerContext 初始化完成后，该生产一个 log4j2 原生的 Logger 对象

      使用 log4j2 原生的方式：

      context.getLogger(name)

    • 3.3 将上述方式产生的 Log4j 原生的 Logger 实例进行包装，包装成 Log4jLog

      new Log4jLog(context.getLogger(name));

    至此，我们通过 Log4jLog 实例打印的日志都是委托给了它内部包含的 log4j2 的原生 Logger 对象了。

上述过程最好与 log4j2 的原生方式对比着看，见 log4j2 的原生方式

6 commons-logging 与 logback 集成

6.1 需要的 jar 包

  • jcl-over-slf4j (替代了 commons-logging，下面详细说明)
  • slf4j-api
  • logback-core
  • logback-classic

对应的 maven 依赖是：

<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>jcl-over-slf4j</artifactId>
	<version>1.7.12</version>
</dependency>
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>1.7.12</version>
</dependency>
<dependency> 
	<groupId>ch.qos.logback</groupId> 
	<artifactId>logback-core</artifactId> 
	<version>1.1.3</version> 
</dependency> 
<dependency> 
    <groupId>ch.qos.logback</groupId> 
    <artifactId>logback-classic</artifactId> 
    <version>1.1.3</version> 
</dependency>

6.2 使用案例

  • 首先在类路径下编写 logback 的配置文件 logback.xml，简单如下：

    <?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  <root level="DEBUG">          
    <appender-ref ref="STDOUT" />
  </root>  
</configuration>

  • 使用方式：

    private static Log logger=LogFactory.getLog(LogbackTest.class);

public static void main(String[] args){
	if(logger.isTraceEnabled()){
		logger.trace("commons-logging-jcl trace message");
	}
	if(logger.isDebugEnabled()){
		logger.debug("commons-logging-jcl debug message");
	}
	if(logger.isInfoEnabled()){
		logger.info("commons-logging-jcl info message");
	}
}

完全是用 commons-logging 的 API 来完成日志编写

6.3 使用案例分析

logback 本身的使用其实就和 slf4j 绑定了起来，现在要想指定 commons-logging 的底层 log 实现是 logback，则需要 2 步走

  • 第一步： 先将 commons-logging 底层的 log 实现转向 slf4j (jcl-over-slf4j 干的事)
  • 第二步： 再根据 slf4j 的选择底层日志原理，我们使之选择上 logback

这样就可以完成 commons-logging 与 logback 的集成。即写着 commons-logging 的 API，底层却是 logback 来进行输出

然后来具体分析下整个过程的源码实现：

  • 1 先看下 jcl-over-slf4j 都有哪些内容(它可以替代了 commons-logging)，如下图

    • 1.1 commons-logging 中的 Log 接口和 LogFactory 类等

      这是我们使用 commons-logging 编写需要的接口和类

    • 1.2 去掉了 commons-logging 原生包中的一些 Log 实现和默认的 LogFactoryImpl

      只有 SLF4JLog 实现和 SLF4JLogFactory

    这就是 jcl-over-slf4j 的大致内容

    这里可以与 commons-logging 原生包中的内容进行下对比。原生包中的内容如下：

  • 2 获取获取 LogFactory 的过程

    jcl-over-slf4j 包中的 LogFactory 和 commons-logging 中原生的 LogFactory 不一样，jcl-over-slf4j 中的 LogFactory 直接限制死，是 SLF4JLogFactory，源码如下：

    public abstract class LogFactory {
	static LogFactory logFactory = new SLF4JLogFactory();
	//略
}

  • 3 根据 LogFactory 获取 Log 的过程

    这就需要看下 jcl-over-slf4j 包中的 SLF4JLogFactory 的源码内容：

    Log newInstance;
Logger slf4jLogger = LoggerFactory.getLogger(name);
if (slf4jLogger instanceof LocationAwareLogger) {
    newInstance = new SLF4JLocationAwareLog((LocationAwareLogger) slf4jLogger);
} else {
    newInstance = new SLF4JLog(slf4jLogger);
}

    可以看到其实是用 slf4j 的 LoggerFactory 先创建一个 slf4j 的 Logger 实例(这其实就是单独使用 logback 的使用方式，见 logback 原生案例)。

    然后再将这个 Logger 实例封装成 common-logging 定义的 Log 接口实现，即 SLF4JLog 或者 SLF4JLocationAwareLog 实例。

    所以我们使用的 commons-logging 的 Log 接口实例都是委托给 slf4j 创建的 Logger 实例（slf4j 的这个实例又是选择 logbakc 后产生的，即 slf4j 产生的 Logger 实例最终还是委托给 logback 中的 Logger 的）

7 未完待续

这篇讲解 commons-logging 与 jul、log4j1、log4j2、logback 的集成原理，内容很长了，就把 slf4j 与上述四者的集成放到下一篇文章

本人转载自：https://my.oschina.net/pingpangkuangmo/blog/407895#OSC_h1_17

  • 日志
    45 引用 • 105 回帖
  • Log4j

    Log4j 是 Apache 开源的一款使用广泛的 Java 日志组件。

    20 引用 • 18 回帖 • 30 关注
  • logback
    4 引用 • 1 回帖
广州 位置
1 回帖
874 7 253 151 39 102 2 59 250

相关帖子

1 回帖
jcl 与 jul、log4j1、log4j2、logback 的集成原理 (转)

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • someone •

    瞄到相同主题的 blog,又看到同是 java,不过博主比我勤快多了.很多东西都还没来得及去总结.不过貌似 cdn 用的还是临时域名,其实七牛 CNAME 关联域名很快捷啊.干嘛不试试

someone9891
广州
回帖
1339
 帖子
112
 积分
31242