百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术教程 > 正文

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

csdh11 2025-02-20 15:08 21 浏览

背景



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

那么如何来正确使用日志框架呢?



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

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

代码样例:

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

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

日志框架



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

  • Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的,现在则是Apache软件基金会的一个项目。
    不支持占位符
    具体日志实现
  • Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品。
    不支持占位符
    具体日志实现
  • Commons Logging Apache基金会所属的项目,是一套Java日志接口,之前叫Jakarta Commons Logging,简称JCL 后更名为Commons Logging。
    不支持占位符
    日志门面
  • Logback 一套日志组件的实现(slf4j阵营)。
    不支持占位符
    具体日志实现
  • Jul (Java Util Logging),自Java1.4以来的官方日志实现。
    不支持占位符
    具体日志实现
  • Slf4j 类似于Commons Logging,是一套简易Java日志门面,本身并无日志的实现。(Simple Logging Facade for Java,缩写Slf4j)。
    支持占位符
    日志门面

重点来看下Slf4j的官方说明

Simple Logging Facade for Java(SLF4J): 可用作各种日志框架的简单外观或抽象,例如java.util.logging,logback和log4j。SLF4J允许最终用户在部署时插入所需的日志记录框架。

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

1. 门面模式

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

2. 占位符

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


使用注意点:

基本原则:嵌入式组件(如库和框架)不应声明对任何SLF4J绑定的依赖性,而只依赖于slf4j-api。
如果库声明了对slf4j-api特定绑定的传递依赖时,该种绑定强加给最终用户, 并非SLF4J的目的。
请注意,声明对绑定的非传递依赖性(例如,scope用于test 或 provide)不会影响最终用户。

小贴士:

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

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

3.桥接生态

SLF4J与其他日志组件的桥接(Bridge)

  • slf4j-log4j12-1.7.13.jar
    log4j1.2版本的桥接器
  • slf4j-jdk14-1.7.13.jar
    java.util.logging的桥接器
  • slf4j-nop-1.7.13.jar
    NOP桥接器
  • slf4j-simple-1.7.13.jar
    一个简单实现的桥接器
  • slf4j-jcl-1.7.13.jar
    Jakarta Commons Logging 的桥接器. 这个桥接器将SLF4j所有日志委派给JCL
  • logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar)
    slf4j的原生实现,logback直接实现了slf4j的接口,因此使用slf4j与logback的结合使用也意味更小的内存与计算开销

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

slf4j bound to 其它log框架

Bridging legacy APIs(桥接遗留的api)

  • log4j-over-slf4j-version.jar * 将log4j重定向到slf4j
  • jcl-over-slf4j-version.jar
    将commos logging里的Simple Logger重定向到slf4j
  • jul-to-slf4j-version.jar
    将Java Util Logging重定向到slf4j


slf4j bound to log redirection

桥接注意事项

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

  • log4j-over-slf4j.jar和slf4j-log4j12.jar同时存在
    从名字上就能看出,前者重定向给后者,后者又委派给前者,会形成死循环
  • jul-to-slf4j.jar和slf4j-jdk14.jar同时存在
    从名字上就能看出,前者重定向给后者,后者又委派给前者,会形成死循环

源码解析



从此行代码跟进查看源码。

LoggerFactory.getLogger(Abc.class);

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

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

小结



  • 切记阿里Java开发手册--日志规约第一条
    【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架 SLF4J 中的 API
  • Log使用基本原则
    在嵌入式组件(如库和框架)开发时,不应声明对任何SLF4J绑定实现的依赖性,而只依赖于slf4j-api。
  • 为了更好的了解SLF4J,你需要了解:
    1. JVM类加载机制
    2. 设计模式:门面模式、桥接模式
  • 简单总结SLF4J的原理:
    1. 通过工厂类,提供一个的接口,用户可以通过这个门面,直接使用API实现日志的记录。
    2. 而具体实现由SLF4J来寻找加载,寻找的过程,就是通过类加载加载org/slf4j/impl/StaticLoggerBinder.class的文件,只要实现了这个文件的日志实现系统,都可以作为一种实现方式。
    3. 如果找到很多种方式,那么就寻找一种默认的方式。
    4. 这就是日志接口的工作方式,简单高效,关键是完全解耦,不需要日志实现部分提供任何的修改配置,只需要符合接口的标准就可以加载进来,有利于维护和各个类的日志处理方式统一。

相关推荐

pdf怎么在线阅读?这几种在线阅读方法看看

pdf怎么在线阅读?我们日常生活中经常使用到pdf文档。这种格式的文档在不同平台和设备上的可移植性,以及保留文档格式和布局的能力都很强。在阅读这种文档的时候,很多人会选择使用在线阅读的方法。在线阅读P...

PDF比对不再眼花缭乱:开源神器diff-pdf助你轻松揪出差异

PDF比对不再眼花缭乱:开源神器diff-pdf助你轻松揪出差异在日常工作和学习中,PDF文件可谓是无处不在。然而,有时我们需要比较两个PDF文件之间的差异,这可不是一件轻松的事情。手动逐页对比简直是...

全网爆火!580页Python编程快速上手,零基础也能轻松学会

Python虽然一向号称新手友好,但对完全零基础的编程小白来讲,总会在很长时间内,都对某些概念似懂非懂,每次拿起书本教程,都要从第一章看起。对于这种迟迟入不了门的情况,给大家推荐一份简单易懂的入门级教...

我的名片能运行Linux和Python,还能玩2048小游戏,成本只要20元

晓查发自凹非寺量子位报道|公众号QbitAI猜猜它是什么?印着姓名、职位和邮箱,看起来是个名片。可是右下角有芯片,看起来又像是个PCB电路板。其实它是一台超迷你的ARM计算机,不仅能够运...

由浅入深学shell,70页shell脚本编程入门,满满干货建议收藏

不会Linux的程序员不是好程序员,不会shell编程就不能说自己会Linux。shell作为Unix第一个脚本语言,结合了延展性和高效的优点,保持独有的编程特色,并不断地优化,使得它能与其他脚本语言...

真工程师:20块钱做了张「名片」,可以跑Linux和Python

机器之心报道参与:思源、杜伟、泽南对于一个工程师来说,如何在一张名片上宣告自己的实力?在上面制造一台完整的计算机说不定是个好主意。最近,美国一名嵌入式系统工程师GeorgeHilliard的名片...

《Linux 命令行大全》.pdf

今天跟大家推荐个Linux命令行教程:《TheLinuxCommandLine》,中文译名:《Linux命令行大全》。该书作者出自自美国一名开发者,兼知名Linux博客LinuxCo...

PDF转换是难题? 搜狗浏览器即开即看

由于PDF文件兼容性相当广泛,越来越多的电子图书、产品说明、公司文告、网络资料、电子邮件选择开始使用这种格式来进行内容的展示,以便给用户更好的再现原稿的细节,但需要下载专用阅读器进行转化才能浏览的问题...

彻底搞懂 Netty 线程模型

点赞再看,养成习惯,微信搜一搜【...

2022通俗易懂Redis的线程模型看完就会

Redis真的是单线程吗?我们一般说Redis是单线程,是指Redis的网络IO和键值对操作是一个线程完成的,这就是Redis对外提供键值存储服务的主要流程。Redis的其他功能,例如持久化、异步删除...

实用C语言编程(第三版)高清PDF

编写C程序不仅仅需要语法正确,最关键的是所编代码应该便于维护和修改。现在有很多介绍C语言的著作,但是本书在这一方面的确与众不同,例如在讨论C中运算优先级时,15种级别被归纳为下面两条原则:需要的...

手拉手教你搭建redis集群(redis cluster)

背景:最近需要使用redis存储数据,但是随着时间的增加,发现原本的单台redis已经不满足要求了,于是就倒腾了一下搭建redistclusterredis集群。好了,话不多说,下面开始展示:...

记录处理登录页面显示: HTTP Error 503. The service is unavailable.

某天一个系统的登录页面无法显示,显示ServiceUnavailableHTTPError503.Theserviceisunavailable,马上登录服务器上查看IIS是否正常。...

黑道圣徒杀出地狱破解版下载 免安装硬盘版

游戏名称:黑道圣徒杀出地狱英文名称:SaintsRow:GatOutofHell游戏类型:动作冒险类(ACT)游戏游戏制作:DeepSilverVolition/HighVoltage...

Exchange Server 2019 实战操作指南

...