最近开始学习java的日志系统管理,发现有好多的日志系统的jar包,感觉很乱,不知道这些jar包的基本功能。上网搜索了几篇文章后,做了一下整理,方便以后查看。
目前的日志系统主要有:commons-loging 、log4j 、slf4j 、LogBack。
commons-loging:apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC 的api 接口,具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦,不过其内部也实现了一些简单日志方案。
我们可以看一下commons-logging 中的 org.apache.commons.logging.Log.java 源码:
1 package org.apache.commons.logging; 2 public interface Log { 3 public boolean isDebugEnabled(); 4 public boolean isErrorEnabled(); 5 public boolean isFatalEnabled(); 6 public boolean isInfoEnabled(); 7 public boolean isTraceEnabled(); 8 public boolean isWarnEnabled(); 9 public void trace(Object message); 10 public void trace(Object message, Throwable t); 11 public void debug(Object message); 12 public void debug(Object message, Throwable t); 13 public void info(Object message); 14 public void info(Object message, Throwable t); 15 public void warn(Object message); 16 public void warn(Object message, Throwable t); 17 public void error(Object message); 18 public void error(Object message, Throwable t); 19 public void fatal(Object message); 20 public void fatal(Object message, Throwable t); 21 }
很显然,只要实现了 Log 接口,它就是一个名副其实的 Logger 组件。这就类似于JDBC的api接口,定下了一个标准规范。
而commons-logging 中已有简单的实现类,例如log4jLogger,jdk14Logger等。
Log4j : 经典的一种日志解决方案。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。
Slf4j : 全称为Simple Logging Facade for JAVA,也是java简单日志门面。 是对不同日志框架提供的一个门面封装。可以在部署的时候不修改任何配置即可接入一种日志实现方案。和commons-loging 应该有一样的初衷。个人感觉设从计上更好一些,没有commons 那么多潜规则。同时有两个额外特点:
1. 能支持多个参数,并通过{} 占位符进行替换,避免老写logger.isXXXEnabled 这种无奈的判断,带来性能提升。
2.OSGI 机制更好兼容支持。
Logback : 作为一个通用可靠、快速灵活的日志框架,将作为Log4j 的替代和SLF4J 组成新的日志系统的完整实现。官网上称具有极佳的性能,在关键路径上执行速度是log4j 的10 倍,且内存消耗更少。目前我对其了解比较少,网上也比较少见,所以还待学习。
这里可能会有疑问,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,使得我们不必关注我们正在使用何种日志工具。
常见的日志配置方案和注意事项:
1.Commons-logging+log4j:
经典的一个日志实现方案。出现在各种框架里。直接使用log4j 即可满足我们的日志方案。但是一般为了避免直接依赖具体的日志实现,一般都是结合commons-logging 来实现。常见代码如下:
1 import org.apache.commons.logging.Log; 2 import org.apache.commons.logging.LogFactory; 3 private static Log logger = LogFactory.getLog(CommonsLoggingTest.class);
代码上,没有依赖任何的log4j 内部的类。那么log4j 是如何被装载的?
Log 是一个接口声明。LogFactory 的内部会去装载具体的日志系统,并获得实现该Log 接口的实现类。而内部有一个Log4JLogger 实现类实现了Log 接口同时内部提供了对log4j logger 的代理。LogFactory 内部装载日志系统流程:
(1)首先,寻找org.apache.commons.logging.LogFactory 属性配置
(2)否则,利用JDK1.3 开始提供的service 发现机制,会扫描classpath下的META-INF/services/org.apache.commons.logging.LogFactory 文件,若找到则装载里面的配置,使用里面的配置。
(3)否则,从Classpath 里寻找commons-logging.properties ,找到则根据里面的配置加载。
(4)否则,使用默认的配置:如果能找到Log4j 则默认使用log4j 实现,如果没有则使用JDK14Logger 实现,再没有则使用commons-logging 内部提供的SimpleLog 实现。
从上述加载流程来看,如果没有做任何配置,只要引入了log4j 并在classpath 配置了log4j.xml或log4j.propertites,则commons-logging 就会使log4j 使用正常,而代码里不需要依赖任何log4j 的代码。
2.log4j+slf4j:
现在比较流行的搭配,其实现代码和上一种组合的代码类似:
1 import org.slf4j.Logger; 2 import org.slf4j.LoggerFactory; 3 Logger logger = LoggerFactory.getLogger(String name);
3.slf4j+logback:
logbackLogback分为三个模块:logback-core,logback-classic,logback-access。logback-core 是核心;logback-classic 改善了 log4j,且自身实现了 SLF4J API,所以即使用 Logback 你仍然可以使用其他的日志实现,如原始的 Log4J,java.util.logging 等;logback-access 让你方便的访问日志信息,如通过 http 的方式。还得提一点,Logback 能更好的放到 OSGI 环境中。
配置文件一般为logback.xml 或 logback-test.xml (类似于 log4j.properties/log4j.xml)
Logback 先找 logback-test.xml,没有则找 logback.xml 文件,都找不到就使用 BasicConfigurator 基本配置,BasicConfigurator 就是相当于等会贴出的 logback.xml 文件内容的配置。这里我们用 logback.xml 配置文件,以前的 log4j.properties 文件可以用 PropertiesTranslator 转换成 logback.xml 文件内容。