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

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

ccwgpt 2025-05-21 12:34 26 浏览 0 评论

背景



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

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



阿里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. 这就是日志接口的工作方式,简单高效,关键是完全解耦,不需要日志实现部分提供任何的修改配置,只需要符合接口的标准就可以加载进来,有利于维护和各个类的日志处理方式统一。

相关推荐

自己动手写Android数据库框架_android开发数据库搭建

http://blog.csdn.net/feiduclear_up/article/details/50557590推荐理由关于Android数据库操作,由于每次都要自己写数据库操作,每次还得去...

谷歌开源大模型评测工具LMEval,打通谷歌、OpenAI、Anthropic

智东西编译|金碧辉编辑|程茜智东西5月28日消息,据科技媒体TheDecoder5月26日报道,当天,谷歌正式发布开源大模型评测框架LMEval,支持对GPT-4o、Claude3.7...

工信部:着力推动大模型算法、框架等基础性原创性的技术突破

工信部新闻发言人今日在发布会上表示,下一步,我们将坚持突出重点领域,大力推动制造业数字化转型,推动人工智能创新应用。主要从以下四个方面着力。一是夯实人工智能技术底座。通过科技创新重大项目,着力推动大模...

乒乓反复纠结“框架不稳定”的三个小误区

很多球友由于对框架的认知不清晰,往往会把“框架不稳定”当成一种心理负担,从而影响学球进度,其典型状态就是训练中有模有样,一旦进入实战,就像被捆住了手脚。通过训练和学习,结合“基本功打卡群”球友们交流发...

前AMD、英特尔显卡架构师Raja再战GPU,号称要全面重构堆栈

IT之家8月5日消息,知名GPU架构师拉贾科杜里(RajaKoduri)此前曾先后在AMD和英特尔的显卡部门担任要职。而在今日,由Raja创立的GPU软件与IP初创企...

三种必须掌握的嵌入式开发程序架构

前言在嵌入式软件开发,包括单片机开发中,软件架构对于开发人员是一个必须认真考虑的问题。软件架构对于系统整体的稳定性和可靠性是非常重要的,一个合适的软件架构不仅结构清晰,并且便于开发。我相...

怪不得别人3秒就知道软考案例怎么做能50+

软考高级统一合格标准必须三科都达到45分,案例分析也一直是考生头疼的一门,但是掌握到得分点,案例能不能50+还不是你们说了算吗?今天就结合架构案例考点,分享实用的备考攻略~一、吃透考点,搭建知识框架从...

UML统一建模常用图有哪些,各自的作用是什么?一篇文章彻底讲透

10万+爆款解析:9大UML图实战案例,小白也能秒懂!为什么需要UML?UML(统一建模语言)是软件开发的“蓝图”,用图形化语言描述系统结构、行为和交互,让复杂需求一目了然。它能:降低沟通成本避...

勒索软件转向云原生架构,直指备份基础设施

勒索软件组织和其他网络犯罪分子正越来越多地将目标对准基于云的备份系统,对久已确立的灾难恢复方法构成了挑战。谷歌安全研究人员在一份关于云安全威胁演变的报告中警告称,随着攻击者不断改进数据窃取、身份泄露和...

ConceptDraw DIAGRAM:释放创意,绘就高效办公新未来

在当今数字化时代,可视化工具已成为提升工作效率和激发创意的关键。ConceptDrawDIAGRAM,作为一款世界顶级的商业绘图软件,凭借其强大的功能和用户友好的界面,正逐渐成为众多专业人士的首选绘...

APP 制作界面设计教程:一步到位_app界面设计模板一套

想让APP界面设计高效落地,无需繁琐流程,掌握“框架搭建—细节填充—体验优化”三步法,即可一步到位完成专业级设计。黄金框架搭建是基础。采用“三三制布局”:将屏幕横向三等分,纵向保留三...

MCP 的工作原理:关键组件_mcp部件

以下是MCP架构的关键组件:MCP主机:像ClaudeDesktop、GitHubCopilot或旅行助手这样的AI智能体,它们希望通过MCP协议访问工具、资源等。MCP主机会...

软件架构_软件架构师工资一般多少

软件架构师自身需要是程序员,并且必须一直坚持做一线程序员。软件架构应该是能力最强的一群程序员,他们通常会在自身承接编程任务的同时,逐渐引导整个团队向一个能够最大化生产力的系统设计方向前进。软件系统的架...

不知不觉将手机字体调大!老花眼是因为“老了吗”?

现在不管是联系、交友,还是购物,都离不开手机。中老年人使用手机的时间也在逐渐加长,刷抖音、看短视频、发朋友圈……看手机的同时,人们也不得不面对“视力危机”——老花眼,习惯眯眼看、凑近看、瞪眼看,不少人...

8000通用汉字学习系列讲座(第046讲)

[表声母字]加(续)[从声汉字]伽茄泇迦枷痂袈笳嘉驾架咖贺瘸(计14字)嘉[正音]标准音读jiā。[辨形]上下结构,十四画。会意形声字,从壴从加,加也表声。注:从壴,字义与鼓乐有关;从加,字义与...

取消回复欢迎 发表评论: