slf4j日志框架简介
每一个Java程序员都知道日志对于任何一个Java应用程序尤其是服务端程序是至关重要的，java.util.logging、Apache log4j、logback等常用的日志框架相信很多同学也已经有接触过或者用过其中的一种或几种。
SLF4J(Simple logging Facade for Java)不是一个真正的日志实现，而是一个抽象层（ abstraction layer），它允许你在后台使用任意一个日志类库。使你的代码独立于任意一个特定的日志API，这是对于API开发者的很好的思想。正式这个特性使得SLF4J迅速流行开来，事实上成为Java世界的日志标准。
官方用户手册：https://www.slf4j.org/manual.html
下图展示了slf4j日志框架是如何对多种日志系统进行适配和支持的
代码跟踪学习
slf4j日志框架在我们实际工程中通常是使用LoggerFactory.getLogger()获取到日志对象logger，然后再根据需要使用logger打印不同等级的对象
Logger logger = LoggerFactory.getLogger(PhoneRechargeServiceImpl.class);
logger.error("log info...");
slf4j日志框架实际上只是一层皮，仅仅提供了统一的日志打印接口层的封装，但是并没有具体实现打印日志的功能，如果需要真正的具有日志打印功能需要
那么，slf4j是如何绑定到一个具体日志的系统呢？是不是很好奇，接下来我们通过追踪源代码来看看这个到底是如何做到的。
public static Logger getLogger(String name) {
ILoggerFactory iLoggerFactory = getILoggerFactory();
return iLoggerFactory.getLogger(name);
}
public static Logger getLogger(Class<?> clazz) {
Logger logger = getLogger(clazz.getName());
if (DETECT_LOGGER_NAME_MISMATCH) {
Class<?> autoComputedCallingClass = Util.getCallingClass();
if (autoComputedCallingClass != null && nonMatchingClasses(clazz, autoComputedCallingClass)) {
Util.report(String.format("Detected logger name mismatch. Given name: \"%s\"; computed name: \"%s\".", logger.getName(),
autoComputedCallingClass.getName()));
Util.report("See " + LOGGER_NAME_MISMATCH_URL + " for an explanation");
}
}
return logger;
}
getLogger()支持Class和String两种类型的参数，事实上Class类型参数的方法也是通过clazz.getName()调用了String参数类型的getLogger()方法，底层都是通过getILoggerFactory()拿到具体的日志实现，下面来看看该方法代码实现。
public static ILoggerFactory getILoggerFactory() {
if (INITIALIZATION_STATE == UNINITIALIZED) {
synchronized (LoggerFactory.class) {
if (INITIALIZATION_STATE == UNINITIALIZED) {
INITIALIZATION_STATE = ONGOING_INITIALIZATION;
performInitialization();
}
}
}
switch (INITIALIZATION_STATE) {
case SUCCESSFUL_INITIALIZATION:
return StaticLoggerBinder.getSingleton().getLoggerFactory();
case NOP_FALLBACK_INITIALIZATION:
return NOP_FALLBACK_FACTORY;
case FAILED_INITIALIZATION:
throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG);
case ONGOING_INITIALIZATION:
// support re-entrant behavior.
// See also http://jira.qos.ch/browse/SLF4J-97
return SUBST_FACTORY;
}
throw new IllegalStateException("Unreachable code");
}
slf4j日志初始化过程是在performInitialization()中进行的，初始化成功则返回该绑日志实现的LoggerFactory，下面来看看最重要的performInitialization()过程是如何初始化日志的。
其实初始化过程非常的简单，只有简单的两步：
第一步，进行日志绑定，我们继续看bind()方法
第二步，进行版本校验，参见versionSanityCheck()方法
private final static void performInitialization() {
bind();
if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {
versionSanityCheck();
}
}
bind()方法代码如下所示：
private final static void bind() {
try {
Set<URL> staticLoggerBinderPathSet = null;
// skip check under android, see also
// http://jira.qos.ch/browse/SLF4J-328
if (!isAndroid()) {
staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();
reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);
}
// the next line does the binding
StaticLoggerBinder.getSingleton();
INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
reportActualBinding(staticLoggerBinderPathSet);
fixSubstituteLoggers();
replayEvents();
// release all resources in SUBST_FACTORY
SUBST_FACTORY.clear();
} catch (NoClassDefFoundError ncde) {
String msg = ncde.getMessage();
if (messageContainsOrgSlf4jImplStaticLoggerBinder(msg)) {
INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;
Util.report("Failed to load class \"org.slf4j.impl.StaticLoggerBinder\".");
Util.report("Defaulting to no-operation (NOP) logger implementation");
Util.report("See " + NO_STATICLOGGERBINDER_URL + " for further details.");
} else {
failedBinding(ncde);
throw ncde;
}
} catch (java.lang.NoSuchMethodError nsme) {
String msg = nsme.getMessage();
if (msg != null && msg.contains("org.slf4j.impl.StaticLoggerBinder.getSingleton()")) {
INITIALIZATION_STATE = FAILED_INITIALIZATION;
Util.report("slf4j-api 1.6.x (or later) is incompatible with this binding.");
Util.report("Your binding is version 1.5.5 or earlier.");
Util.report("Upgrade your binding to version 1.6.x.");
}
throw nsme;
} catch (Exception e) {
failedBinding(e);
throw new IllegalStateException("Unexpected initialization failure", e);
}
}
重点关注到findPossibleStaticLoggerBinderPathSet()方法是来寻找和绑定可能的StaticLogger集合
同时请注意到StaticLoggerBinder.getSingleton();这行，不知道大家有没有发现StaticLoggerBinder这个类在slf4j-api.jar中是没有定义的，神奇的是代码怎么编译通过的？请继续往下看，我们将揭晓这个谜底。
private static String STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class";
static Set<URL> findPossibleStaticLoggerBinderPathSet() {
// use Set instead of list in order to deal with bug #138
// LinkedHashSet appropriate here because it preserves insertion order
// during iteration
Set<URL> staticLoggerBinderPathSet = new LinkedHashSet<URL>();
try {
ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
Enumeration<URL> paths;
if (loggerFactoryClassLoader == null) {
paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
} else {
paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);
}
while (paths.hasMoreElements()) {
URL path = paths.nextElement();
staticLoggerBinderPathSet.add(path);
}
} catch (IOException ioe) {
Util.report("Error getting resources from path", ioe);
}
return staticLoggerBinderPathSet;
}
代码中可以看到slf4j是通过ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH)载入具体日志实现类的
看到这里STATIC_LOGGER_BINDER_PATH这个静态变量对应的值为org/slf4j/impl/StaticLoggerBinder.class了吧。没错！绑定的就是这个class，也就是上面slf4j-api.jar中没有定义的类。而这个类定义在哪里呢？答案是在具体实现日志绑定的jar中，我们可以打开常见的日志框架绑定slf4j的jar包看看。
slf4j-log4j.jar的StaticLoggerBinder实现
logback-classic.jar的StaticLoggerBinder实现
目前支持的日志实现框架有slf4j-log4j12、slf4j-jdk14、slf4j-nop、slf4j-simple、slf4j-jcl、logback-classic等，当然只要你愿意，也可以写一个自己的实现。
实际项目中，存在多个日志实现框架时，只能选择其中一个具体实现，需要将其他实现的slf4j适配支持的包排除掉，并将其他的具体实现日志系统直接打印的日志桥接到slf4j上，这样系统就可以统一在一个日志框架下打印日志。
如何将其他具体日志框架直接打印的日志桥接到slf4j上呢？我们可以参见下图：
正确姿势
1、最常见的不当姿势：
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
2、改进姿势：
if(logger.isDebugEnabled()) {
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
}
3、较优雅的姿势是采用{}占位符参数化变量：
Object entry = new SomeObject();
logger.debug("The entry is {}.", entry);
原因：采用方式1打日志时，当系统的日志级别不需要打印debug日志时还是会进行字符串拼接操作，而String为不可变类型，采用+进行字符串连接会增大系统开销，这在频繁打印日志的系统中，改进姿势2打日志每次都要额外进行日志级别判断，非常不方便，强烈建议采用{}占位符的方式打印日志。
如果占位变量是一个复杂对象，会在实际打印日志时调用对象的toString()方法。
如何实现一套兼容SLF4J的日志系统
1、org.slf4j.Logger接口适配实现
自定义一个org.slf4j.Logger接口的实现类，可以参见slf4j-jcl, slf4j-jdk14和slf4j-log4j12中的实现实例进行适配。
2、org.slf4j.ILoggerFactory接口适配实现
自定义一个org.slf4j.ILoggerFactory接口实现一个工厂类MyLoggerFactory，这个工厂会返回一个MyLoggerAdapter实例。
3、修改StaticLoggerBinder类
StaticLoggerBinder类会返回一个日志工厂类(ILoggerFactory)，修改StaticLoggerBinder类中的loggerFactoryClassStr变量
Marker和MDC支持可以参考NOP中现成的实现
总结起来，创建一个支持slf4j的日志系统大致需要如下几步：
- 拷贝一份现有的适配实现
- 创建一个适配器（adapter），让日志系统与org.slf4j.Logger接口适配
- 创建一个步骤2中适配器（adapter）的工厂类
- 修改StaticLoggerBinder类，会用到步骤3中创建的工厂类
参考
参考：
https://blog.csdn.net/kxcfzyk/article/details/38613861
