jcl-over-slf4j log桥接工具简介

 Java 界里有许多实现日志功能的工具，最早得到广泛使用的是 log4j，许多应用程序的日志部分都交给了 log4j，不过作为组件开发者，他们希望自己的组件不要紧紧依赖某一个工具，毕竟在同一个时候还有很多其他很多日志工具，假如一个应用程序用到了两个组件，恰好两个组件使用不同的日志工具，那么应用程序就会有两份日志输出了。

 

为了解决这个问题，Apache Commons Logging （之前叫 Jakarta Commons Logging，JCL）粉墨登场，JCL 只提供 log 接口，具体的实现则在运行时动态寻找。这样一来组件开发者只需要针对 JCL 接口开发，而调用组件的应用程序则可以在运行时搭配自己喜好的日志实践工具。

 

所以即使到现在你仍会看到很多程序应用 JCL + log4j 这种搭配，不过当程序规模越来越庞大时，JCL的动态绑定并不是总能成功，具体原因大家可以 Google 一下，这里就不再赘述了。解决方法之一就是在程序部署时静态绑定指定的日志工具，这就是 SLF4J 产生的原因。

 

跟 JCL 一样，SLF4J 也是只提供 log 接口，具体的实现是在打包应用程序时所放入的绑定器（名字为 slf4j-XXX-version.jar）来决定，XXX 可以是 log4j12, jdk14, jcl, nop 等，他们实现了跟具体日志工具（比如 log4j）的绑定及代理工作。举个例子：如果一个程序希望用 log4j 日志工具，那么程序只需针对 slf4j-api 接口编程，然后在打包时再放入 slf4j-log4j12-version.jar 和 log4j.jar 就可以了。

 

现在还有一个问题，假如你正在开发应用程序所调用的组件当中已经使用了 JCL 的，还有一些组建可能直接调用了 java.util.logging，这时你需要一个桥接器（名字为 XXX-over-slf4j.jar）把他们的日志输出重定向到 SLF4J，所谓的桥接器就是一个假的日志实现工具，比如当你把 jcl-over-slf4j.jar 放到 CLASS_PATH 时，即使某个组件原本是通过 JCL 输出日志的，现在却会被 jcl-over-slf4j “骗到”SLF4J 里，然后 SLF4J 又会根据绑定器把日志交给具体的日志实现工具。过程如下

 

Component

   |

   | log to Apache Commons Logging

   V

 jcl-over-slf4j.jar --- (redirect) ---> SLF4j ---> slf4j-log4j12-version.jar ---> log4j.jar ---> 输出日志

 

看到上面的流程图可能会发现一个有趣的问题，假如在 CLASS_PATH 里同时放置 log4j-over-slf4j.jar 和 slf4j-log4j12-version.jar 会发生什么情况呢？没错，日志会被踢来踢去，最终进入死循环。

 

所以使用 SLF4J 的比较典型搭配就是把 slf4j-api、JCL 桥接器、java.util.logging（JUL）桥接器、log4j 绑定器、log4j 这5个 jar 放置在 CLASS_PATH 里。

 

不过并不是所有APP容器都是使用 log4j 的，比如 Google AppEngine 它使用的是 java.util.logging（JUL），这时应用 SLF4J 的搭配就变成 slf4j-api、JCL桥接器、logj4桥接器、JUL绑定器这4个 jar 放置在 WEB-INF/lib 里。

从前面对 SLF4J 的认识可知，即使把 JCL 转嫁到 SLF4J，还是无法输出日志，还需要一种日志实现，下层该用 Log4J 还得用 Log4J，想用 Logback 还是要用 Logback。所以到了 SLF4J 后还得往下走，也就是前面那两条路 SLF4J+Log4J 和 SLF4J+Logback，本篇使用 SLF4J 的模式具体就要分为：

JCL-Over-SLF4J+SLF4J+Log4J 和 JCL-Over-SLF4J+SLF4J+Logback，这两种实现方式差不多。只是分别用的 jar 包和配置文件不同，SLF4J+Log4J 和 SLF4J+Logback 原来要哪些文件现在还是需要那些文件，只是都要加上 jcl-over-slf4j-1.5.11.jar 包。这里说明 JCL-Over-SLF4J+SLF4J+Logback 的方式。

需要的配置文件和组件包，下面四个 jar 文件和一个 xml文件都是要放在项目的 ClassPath 上。

1. slf4j-api-1.5.11.jar
2. logback-core-0.9.20.jar
3. logback-classic-0.9.20.jar
4. logback.xml 或 logback-test.xml
5. jcl-over-slf4j-1.5.11.jar

第 1 和第 5 个包在 http://www.slf4j.org/download.html 处下载，第二第三个包在 http://logback.qos.ch/download.html 下载，可能包文件名中的版本号有些差异。

下面是一个最简单的 logback.xml 文件内容

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

  < root level = "DEBUG" >
    < appender-ref ref = "stdout" />
  </ root >
</ configuration >

为了看看效果，我们在输入的 pattern 中加入了 [Consociate]，来检验是否统一到单一的日志通道中去了。

使用 了 JCL 和 SLF4J  的代码

package com.unmi;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestJCLOverSlf4j {
    //SLF4J 的 Logger
    private static final Logger logger = LoggerFactory.getLogger( "From SLF4J" );

    //JCL 的 Log
    private static final Log log = LogFactory.getLog( "From JCL" );

    //分别用上面的 logger 和 log 输出日志，从输出可以看到它们统一到一个通道中了
    public static void main(String[] args) {
        logger.info( "Hello {}" , "From SLF4J" );
        log.info( "Hello From JCL" );
    }
}

我们在上面代码中，既使用了 JCL 统一日志框架，也使用了 SLF4J 的统一日志框架。要注意一点，从 JCL 桥接过来的 log 不能输出参数化消息了。上面代码使用了 org.apache.commons.logging.Log，import org.apache.commons.logging.LogFactory，但你却用不着引入 commons-logging.jar 包。

执行上面的代码，看到输出：

本文原始链接 http://unmi.cc/jcl-over-slf4j-slf4j/, 来自 隔叶黄莺 Unmi Blog

[Consociate] 23:19:39.890 [main] INFO  From SLF4J – Hello From SLF4J
[Consociate] 23:19:39.921 [main] INFO  From JCL – Hello From JCL

很明显示 JCL 框架和 SLF4J 框架的日志输出都统一到了一个通道中来了，为什么呢? SLF4J 使用的是 Logback 输出的信息，这一点没问题的，而 JCL 是不认识 Logback 的，所以 JCL 框架的输出必然是绕道到 SLF4J，最后也是由 Logback 输出的。

实现分析：

我们打开 jcl-over-slf4j-1.5.11.jar，看到里面有两个包 org.apache.commons.logging 和 org.apache.commons.logging.impl，并有相应的类，这就是为什么，虽然在代码中有：

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

却不用把 commons-logging.jar 包引入到类路径上的原因。

再深入下 jcl-over-slf4j-1.5.11.jar，看到其中还有个文件 /META-INF/services/org.apache.commons.logging.LogFactory，内容为：

org.apache.commons.logging.impl.SLF4JLogFactory

# Axis gets at JCL through its own mechanism as defined by Commons Discovery, which
# in turn follows the instructions found at:
# http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service Provider

JCL 运行时使用了 SLF4JLogFactory，从而完成了 JCL 的日志实现委托给了 SLF4J，再由 SLF4J 进一步完成具体的日志输出。

采用 JCL-Over-SLF4J+SLF4J+Log4J 使用模式也是相似的，这里就不详述了。总结下就是 JCL 把 SLF4J 当作它的日志实现。

再来想象个问题：如果我们把这两个包 jcl-over-slf4j-1.5.11.jar 和 slf4j-jcl-1.5.11.jar 都放到 ClassPath 下会有什么情况呢？JCL 代理给 SLF4J，SLF4J 又绑定到 JCL，对了，死循环，StackOverFlow 错误：

SLF4J: Detected both jcl-over-slf4j.jar AND slf4j-jcl.jar on the class path, preempting StackOverflowError.
SLF4J: See also http://www.slf4j.org/codes.html#jclDelegationLoop for more details.
java.lang.ExceptionInInitializerError
at org.slf4j.impl.StaticLoggerBinder.<init>(StaticLoggerBinder.java:82)
at org.slf4j.impl.StaticLoggerBinder.<clinit>(StaticLoggerBinder.java:51)
at org.slf4j.LoggerFactory.getSingleton(LoggerFactory.java:230)
at org.slf4j.LoggerFactory.bind(LoggerFactory.java:121)
at org.slf4j.LoggerFactory.performInitialization(LoggerFactory.java:112)
at org.slf4j.LoggerFactory.getILoggerFactory(LoggerFactory.java:275)
at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:248)
at com.unmi.TestJCLOverSlf4j.<clinit>(TestJCLOverSlf4j.java:10)
Caused by: java.lang.IllegalStateException: Detected both jcl-over-slf4j.jar AND slf4j-jcl.jar on the class path, preempting StackOverflowError. See alsohttp://www.slf4j.org/codes.html#jclDelegationLoop for more details.
at org.slf4j.impl.JCLLoggerFactory.<clinit>(JCLLoggerFactory.java:64)
… 8 more
Exception in thread “main”