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

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

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

相关推荐

Java七大热门技术框架源码解析(25章) 完结

获课》aixuetang.xyz/5699/Hibernate与MyBatis源码级PK:ORM框架的两种哲学在Java持久层框架领域,Hibernate与MyBatis代表了两种截然不同的设计哲学。...

【25章】Java七大热门技术框架源码解析

获课》aixuetang.xyz/5699/Java高级面试:七大框架源码精讲与实战解析在当今Java技术生态中,对主流框架源码的深入理解已成为高级开发者面试的核心竞争力。掌握Spring、MyBat...

饿了么董事长吴泽明兼任CEO,韩鎏分管即时物流中心

饿了么调整组织架构。2月11日,饿了么董事长吴泽明(花名:范禹)通过公司全员信宣布饿了么最新组织调整:即日起,吴泽明将兼任饿了么CEO,韩鎏(花名:昊宸)专注分管即时物流中心,继续向吴泽明汇报。吴泽明...

饿了么100%迁至阿里云,快速扩容可支持1亿人同时点单

来源:环球网6月17日,记者获悉,饿了么已完成100%上云,所有业务系统、数据库设施等均已迁移至阿里云。高峰期,饿了么可在阿里云上快速扩容,可以支持1亿人同时在线点单,这意味着饿了么的服务能力再次全面...

饿了么组织架构调整:董事长吴泽明兼任CEO 韩鎏专注即时物流中心管理

近日,饿了么董事长吴泽明(花名:范禹)通过公司全员信宣布饿了么最新组织调整:即日起,吴泽明将兼任饿了么CEO,韩鎏(花名:昊宸)专注分管即时物流中心,继续向吴泽明汇报。吴泽明在内部信中表示,考虑即时物...

饿了么组织架构调整:董事长吴泽明兼任CEO

Tech星球2月11日消息,据新浪科技报道,今日饿了么董事长吴泽明(花名:范禹)通过公司全员信宣布饿了么最新组织调整:即日起,吴泽明将兼任饿了么CEO,韩鎏(花名:昊宸)专注分管即时物流中心,继续向吴...

饿了么又调整了组织架构,董事长吴泽明兼任CEO

2月11日,饿了么董事长,花名为范禹的吴泽明,通过公司全员信宣布最新组织调整:从即日起,吴泽明将兼任饿了么CEO。公司原CEO,花名为昊宸的韩鎏今后专注分管即时物流中心,继续向吴泽明汇报。在内部信中,...

SpringBoot项目快速开发框架JeecgBoot——Web处理!

Web处理JeecgBoot框架主要用于Web开发领域。下面介绍JeecgBoot在Web开发中的常用功能,如控制器、登录、系统菜单、权限模块的角色管理和用户管理。首先启动后台项目,将其导入IDE...

腾讯即将开源Kuikly:基于Kotlin的纯原生跨端解决方案

IT之家3月4日消息,腾讯日前在端服务网站发布预告,即将开源Kuikly跨端开发框架。预告海报介绍称,Kuikly是基于KotlinKMM技术、客户端开发友好的全新跨端解决方案,可...

Python构建MCP服务器完整教程:5步打造专属AI工具调用系统

模型控制协议(ModelControlProtocol,MCP)是一种专为实现AI代理与工具解耦而设计的通信协议,为AI驱动应用程序的开发提供了高度的灵活性和模块化架构。通过MCP服务器,AI代...

Python3使用diagrams生成架构图(python模块制作)

目录技术背景diagrams的安装基础逻辑关系图组件簇的定义总结概要参考链接技术背景对于一个架构师或者任何一个软件工程师而言,绘制架构图都是一个比较值得学习的技能。这就像我们学习的时候整理的一些Xmi...

Python 失宠!Hugging Face 用 Rust 新写了一个 ML框架,现已低调开源

大数据文摘受权转载自AI前线整理|褚杏娟近期,HuggingFace低调开源了一个重磅ML框架:Candle。Candle一改机器学习惯用Python的做法,而是Rust编写,重...

Python Web 框架(Python Web 框架)

Tornado、Flask、Django三个PythonWeb框架的主要区别和适用场景:特点/框架TornadoFlaskDjango类型异步非阻塞Web服务器和框架轻量级微框架全功能...

构建并发布你的自定义 Python 包(python如何创建自定义模块)

Python让你可以重用代码,并将代码分享给他人以节省时间和精力。所以,当你编写了一些方便的脚本,希望你的同事或其他人也能使用时,接下来该怎么做呢?这篇文章就来解决打包和分发的问题。我们将专注于将你...

Python 应用开发框架 BeeWare 简明实用教程

1.BeeWare简介BeeWare是一个Python框架,用于开发跨平台原生应用。它支持Android、iOS、Windows、macOS和Linux,并提供原生用户体验。2.安装B...

取消回复欢迎 发表评论: