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

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

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

相关推荐

SLF4j + Log4j 、Log4j2、 Logback日志框架使用总结

从写代码开始,就陆陆续续接触到了许多日志框架,常用的Log4j、Log4j2、Logback等。每次自己写项目时,就copy别人的代码或网上的demo。配置log4j.properties或者lo...

轻量级日志追踪方案——TLog

TLog概述TLog提供了一种最简单的方式来解决日志追踪问题,它不收集日志,也不需要另外的存储空间,它只是自动的对你的日志进行打标签,自动生成TraceId贯穿你微服务的一整条链路。并且提供上下游节点...

Java中优雅实现日志记录:Spring AOP秘籍

Java中优雅实现日志记录:SpringAOP秘籍在软件开发中,日志记录是一项非常重要的任务。它不仅帮助我们追踪程序执行的过程,还能在出现问题时快速定位错误原因。在Java世界里,Spring框架为...

Redis与Java整合的最佳实践

Redis与Java整合的最佳实践在这个数字化时代,数据处理速度决定了企业的竞争力。Redis作为一款高性能的内存数据库,以其卓越的速度和丰富的数据结构,成为Java开发者的重要伙伴。本文将带你深入了...

SpringBoot2.x系列教程54--SpringBoot整合日志记录项目重要信息

前言我们在进行项目开发时,无论是前端还是后端,都必须进行日志的记录。通过日志,来记录项目开发、运行时产生的各种异常信息和重要数据。这样我们才能对项目的异常进行定位,对项目的后期运营提供数据支撑。但我们...

Spring Boot中的Logback日志配置详解

在SpringBoot开发中,日志作为检查问题、追踪系统、分析系统性能的手段之一,为开发者提供了各种快速解决问题的方案。而在SpringBoot中默认采用的日志框架是LogBack,作为一个功能强...

MyBatis系列-2-日志配置

日积月累,方成大器。各大网站:Mybatis官方技术文档https://mybatis.org/mybatis-3/zh/index.htmlMybatis源码包下载:https://github...

Springboot强大的日志功能你真的了解吗?这些功能你肯定不知道

环境:Springboot2.4.10日志配置详解SpringBoot使用CommonsLogging记录所有内部日志,但保留底层日志实现的打开状态。为JUL日志记录、Log4J2和Logback...

SpringBoot中14个日志使用技巧

前言:日志是软件开发中不可或缺的一部分,它能帮助我们了解应用运行状态、调试问题和监控性能。1.使用SLF4J门面模式统一日志APISLF4J(SimpleLoggingFacadeforJ...

探索Java项目中日志系统最佳实践:从入门到精通

探索Java项目中日志系统最佳实践:从入门到精通在现代软件开发中,日志系统如同一位默默无闻却至关重要的管家,它记录了程序运行中的各种事件,为我们排查问题、监控性能和优化系统提供了宝贵的依据。在Java...

# 怎么让 java -jar example.jar 产生的日志输出到指定文件

#怎么让java-jarexample.jar产生的日志输出到指定文件要实现java-jarexample.jar命令产生的日志输出到指定文件,可以使用以下几种方法:##一、方法1...

探秘Logback:优雅管理Java日志的魔法工具

探秘Logback:优雅管理Java日志的魔法工具在Java的世界里,日志记录是每个开发者都绕不开的重要话题。想象一下,如果没有日志,我们的程序就像一辆没有仪表盘的汽车,既看不到速度,也摸不清方向。而...

SLF4J与Logback:Java日志世界的双子星

SLF4J与Logback:Java日志世界的双子星在Java的世界里,日志记录就像空气一样无处不在。无论是调试程序还是排查生产环境的问题,日志都是我们不可或缺的好帮手。而提到日志框架,SLF4J和L...

SLF4J与Logback:让Java日志记录变得简单优雅

SLF4J与Logback:让Java日志记录变得简单优雅在Java开发的世界里,日志记录是一项不可或缺的技术。它不仅帮助我们追踪程序运行的状态,还能在排查问题时提供重要的线索。今天,我们就来聊聊两个...

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

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

取消回复欢迎 发表评论: