在项目中,我们经常会看到两个 jar 包:commons-logging.jar 和 log4j.rar。
为什么我们在使用 log4j 的同时还要引入 commons-logging.jar 呢,或者说不用 commons-logging.jar 可不可以,这两者之间到底是怎么的一种关系呢?
我们都知道,真正的记录日志的工具是 log4j 和 sun 公司提供的日志工具。
而 commons-logging 把这两个记录日志的工具重新封装了一遍(Log4JLogger.java 和
Jdk14Logger.java),可以认为 org.apache.commons.logging.Log
是个傀儡,它只是提供了对外的统一接口。(实际上,在 org.apache.commons.logging.impl
包下,commons-logging 仅仅为我们封装了 log4j 和 sun logger)。
因此我们只要能拿到 org.apache.commons.logging.Log,而不用关注到底使用的是 log4j 还是 sun logger。正如我们经常在项目中这样写:
// MyClass 是我们自己写的类,LogFactory 是一个专为提供 Log 的工厂(abstract class)
private static final Log logger = LogFactory.getLog(MyClass.class);
而使用log4j记录日志时,使用如下三个方法获取logger:
Logger.getRootLogger();
Logger getLogger(Class clazz);
Logger getLogger(String name);
既然如此,我们向构建路径加了 commons-logging.jar 和 log4j.jar 两个 jar 包,那我们的应用程序到底使用的
log4j 还是 sun logger 呢?我们能不能认为由于加了 log4j.jar 包,就认为系统使用的就是 log4j
呢?事实上当然不是这样的,那我还认为我正在使用 jdk 而认为系统使用的是 sun logger 呢。使用 Spring 的朋友可以在
web.xml 中看到如下 listener 片段:
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
这是由 Spring 为我们提供的实现了标准的 servlet api 中的 javax.servlet.ServletContextListener 接口,用于在 web 容器启动时做一些初始化操作。
从Spring 的源码,可以看到如下代码:Log4jConfigurer.initLogging(location, refreshInterval);
找到 org.springframework.util.Log4jConfigurer,这正是 log4j 提供给我们的初始化日志的类。至此,我们终于明白了我们系统的的确确使用的是 log4j 的日志工具。
可是问题又来了,org.apache.commons.logging.Log 和 org.apache.log4j.Logger
这两个类,通过包名我们可以发现它们都是 apache 的项目,既然如下,为何要动如此大的动作搞两个东西(指的是 commons-logging 和
log4j)出来呢?事实上,在 sun 开发 logger 前,apache 项目已经开发了功能强大的 log4j 日志工具,并向 sun
推荐将其纳入到 jdk 的一部分,可是 sun 拒绝了 apache 的提议,sun
后来自己开发了一套记录日志的工具。可是现在的开源项目都使用的是
log4j,log4j 已经成了事实上的标准,但由于又有一部分开发者在使用 sun logger,因此 apache 才推出
commons-logging,使得我们不必关注我们正在使用何种日志工具。
下面我说明如何通过配置文件来组合commons-logging和log4j。
配置文件内容很简单,就指定一个日志实现类即可,下面是个示例文件:
commons-logging.properties
--------------------------------------------------------------------------------
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
--------------------------------------------------------------------------------
在使用Log4j作为日志工具的时候,commons-logging.properties的配置可以不要,在下面例子中,你可以尝试删除此文件,而不影响日志输出。