阿里强制使用SLF4J日志框架的缘由

Posted 2023-02-17

参考技术A

想必小伙伴们都用过日志，虽然日志看起来可有可无，但是等到出问题的时候，就比较棘手。所以说日志框架使用好不好，规范不规范，直接影响了解决生产环境故障的效率，日志框架选的不好、用的不好，有可能影响环境的性能，也有可能影响排查问题的难易程度。

阿里Java开发手册--日志规约第一条：

【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

代码样例：

为什么会有此规范呢？我们先来了解下日志框架。

Java中的日志框架分如下几种：

重点来看下Slf4j的官方说明

为什么阿里要强制 依赖使用日志框架 SLF4J 中的 API 或者说Slf4j的特点： 除了得益于面向接口编程(使用了门面模式)，还有一个特性支持占位符，以及SELF4J的生态(SLF4J与其他日志组件的桥接)

门面(Facade)模式，对外隐藏了系统的复杂性，并向客户端提供了可以访问的接口，门面模式的好处是将客户端和子系统松耦合，方便子系统的扩展和维护。
正是门面模式这样的特点，使用SLF4J门面，不管日志组件使用的是log4j还是logback等等，对于调用者而言并不关心使用的是什么日志组件，而且对于日志组件的更换或者升级，调用的地方也不用做任何修改。

SLF4J中有一个重要的特性：占位符，可以拼接任意字符串，相比如其他框架的优点即不需要用+来拼接字符串，也就不会创建新的字符串对象。

使用注意点：

小贴士：

在发布SDK或服务框架时，要遵循 面向接口编程的思想 ，不要把SLF4J实现类进行发布向下传递，SLF4J实现类可以通过maven的scope来控制不进行向下传递。

以上是使用SLF4J的缘由和注意点的说明。

Slf4j Manual中有一张图清晰的展示了接入方式，如下：

slf4j bound to 其它log框架

slf4j bound to log redirection

在使用slf4j桥接时要注意避免形成死循环，在项目依赖的jar包中不要存在以下情况

想要更好的了解SLF4J，你需要了解JVM类加载机制

设计模式：门面模式、桥接模式。源码解析过程这里忽略。