common-logging 与 slf4j 都是日志实现门面,它们本身都不具体实现写日记操作,只是提供统一的接口。
common-logging 是最早的日志门面实现,而 SLF4J 是较新的日志门面实现。因此 SLF4J 在性能以及兼容性处理会比 common-logging 要好。commons-logging
commons-logging是apache提供的一个通用的日志接口,是为了避免和具体的日志方案直接耦合的一种实现。通过commons-logging用户可以自己选择log4j或者jdk自带的logging作为具体实现。
使用commons-logging的代码如下
import org.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory;public class MyApplication { private Log log = LogFactory.getLog(this.getClass());}
Log是一个接口,LogFactory的内部会去装载具体的日志系统,并获得实现该Log接口的实现类,其具体流程如下
-
通过系统属性org.apache.commons.logging.LogFactory加载LogFactory的实现
-
如果未找到,则通过服务发现机制(SPI)在META-INF/services/org.apache.commons.logging.LogFactory寻找实现类进行加载
-
如果未找到,则从classpath下寻找commons-logging.properties文件,根据文件中org.apache.commons.logging.LogFactory配置进行加载
-
如果仍未找到,则使用默认配置:如果找到Log4j 则默认使用log4j 实现,如果仍没有则使用JDK14Logger 实现,再没有则使用commons-logging 内部提供的SimpleLog 实现
所以只要你引入了log4j的jar包以及对其进行了配置底层就会直接使用log4j来进行日志输出了,其实质就是在org.apache.commons.logging.impl.Log4JLogger(commons-logging包)的getLogger方法调用了log4j的Logger.getLogger来返回底层的Logger,当记录日志的时候就会通过这个Logger写日志。
Slf4j
slf4j全称为Simple Logging Facade for JAVA,java简单日志门面。其使用方式如下
import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class MyApplication { private Logger logger = LoggerFactory.getLogger(this.getClass());}
slf4j和commons-logging不一样的是,如果你没有具体的日志组件(logback,log4j等),它是无法打印日志的,如果你在一个maven项目里面只引入slf4j的jar包,然后记录日志
public class Main { public static Logger logger = LoggerFactory.getLogger(Main.class); public static void main(String[] args) { logger.info("slf4j"); System.out.println("done"); }}
就会出现下面的信息
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".SLF4J: Defaulting to no-operation (NOP) logger implementationSLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
如果你此时引入log4j或者logback的jar包就会打印出日志。
通过LoggerFactory.getLogger()查看其实现原理,其加载Logger核心源码如下:
static SetfindPossibleStaticLoggerBinderPathSet() { Set staticLoggerBinderPathSet = new LinkedHashSet (); try { ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader(); Enumeration paths; if (loggerFactoryClassLoader == null) { paths = ClassLoader.getSystemResources("org/slf4j/impl/StaticLoggerBinder.class"); } else { paths = loggerFactoryClassLoader.getResources("org/slf4j/impl/StaticLoggerBinder.class"); } while (paths.hasMoreElements()) { URL path = paths.nextElement(); staticLoggerBinderPathSet.add(path); } } catch (IOException ioe) { Util.report("Error getting resources from path", ioe); } return staticLoggerBinderPathSet;}
其主要思想就是去classpath下找org/slf4j/impl/StaticLoggerBinder.class,即所有slf4j的实现,无论是log4j还是logback都有实现类,同学们可以看下自己项目中的jar包。
logback的关于slf4j的实现类我找到了,但是log4j我还没有找到,但是每个支持 SLF4J 的日志框架必须存在一个实现该接口的 StaticLoggerBinder 类。
实现 LoggerFactoryBinder 接口,类 LoggerFactory 调用该类的 getSingleton() 和 getLoggerFactory() 方法返回具体日志框架的接口实例,
log4j调用的是 slf4j-log4j12.jar 财报中没有调用这个日志
logback调用的是logback-classic-1.1.7.jar下面的logback-classic-1.1.7.jar!\org\slf4j\impl
StaticLoggerBinder implements LoggerFactoryBinder
SLF4J 有五个主要组件,分别是:
- ILoggerFactory:工厂接口
- LoggerFactory:工厂类
- LoggerFactoryBinder:日志框架绑定接口
- Logger:日志接口
- StaticLoggerBinder:日志框架绑定实现类
此处先给出整体的流程:LoggerFactory 调用 getILoggerFactory() 方法,该方法会初始化 LoggerFactory,即通过在 bind() 方法中加载 classpath 中的 StaticLoggerBinder 类,并根据加载结果设置当前 LoggerFactory 的初始化状态,从而在 getILoggerFactory() 方法中通过当前 LoggerFactory 的状态判断返回的 ILoggerFactory 实例。
如果引入了多个实现,编译器会在编译的时候选择其中一个实现类进行绑定,也会将具体绑定的哪个日志框架告诉你
private static void reportActualBinding(SetbinderPathSet) { if (binderPathSet != null && binderPathSet.size() > 1) { Util.report("Actual binding is of type [" + StaticLoggerBinder.getSingleton().getLoggerFactoryClassStr() + "]"); }}
如何进行日志系统转换?
在实际的日志转换过程中,SLF4J其实是充当了一个中介的角色。例如当我们一个项目原来是使用LOG4J进行日志记录,但是我们要换成LogBack进行日志记录。
此时我们需要先将LOG4J转换成SLF4J日志系统,再从SLF4J日志系统转成LogBack日志系统。
从日志框架转向SLF4J
- jul-to-slf4j:jdk-logging到slf4j的桥梁
- log4j-over-slf4j:log4j1到slf4j的桥梁
- jcl-over-slf4j:commons-logging到slf4j的桥梁
从SLF4J转向具体的日志框架
- slf4j-jdk14:slf4j到jdk-logging的桥梁
- slf4j-log4j12:slf4j到log4j1的桥梁
- log4j-slf4j-impl:slf4j到log4j2的桥梁
- logback-classic:slf4j到logback的桥梁
- slf4j-jcl:slf4j到commons-logging的桥梁
例如我们一开始使用的是 Log4J 日志框架,现在我们希望转成 LogBack 框架,那么我们首先需要加入 log4j-over-slf4j.jar 将 Log4J 转成 SLF4J,之后再加入 logback-classic.jar 将 SLF4J 转成 LogBack。
日志技术框架一览
- JUL:JDK中的日志记录工具,也常称为JDKLog、jdk-logging。
- LOG4J1:一个具体的日志实现框架。
- LOG4J2:一个具体的日志实现框架,是LOG4J1的下一个版本。
- LOGBACK:一个具体的日志实现框架,但其性能更好。
- JCL:一个日志门面,提供统一的日志记录接口,也常称为commons-logging。
- SLF4J:一个日志门面,与JCL一样提供统一的日志记录接口,可以方便地切换看具体的实现框架。
JUL、LOG4J1、LOG4J2、LOGBACK是日志实现框架,而JCL、SLF4J是日志实现门面。