Java日志体系居然这么复杂?——架构篇

编程

本文是一个系列,欢迎关注

日志到底是何方神圣?为什么要使用日志框架?

想必大家都有过使用System.out来进行输出调试,开发开发环境下这样做当然很方便,但是线上这样做就有麻烦了:

  1. 系统一直运行,输出越来越多,磁盘空间逐渐被写满
  2. 不同的业务想要把日志输出在不同的位置
  3. 有些场合为了更高性能,尽量控制减少日志输出,需要动态调整日志输出量
  4. 自动输出日志相关信息,比如:日期、线程、方法名称等等

显然System.out解决不了我们的问题,但是我们遇到的问题一定会有前人遇到过,日志也不例外,其中就有一个大牛 Ceki,整个Java的日志体系几乎都有Ceki参与或者受到了Ceki的深度影响。当然Java日志体系的复杂度也有一部分原因是拜这位大牛所赐。

Java日志的恩怨情仇

  • 1996年早期,欧洲安全电子市场项目组决定编写它自己的程序跟踪API(Tracing API)。经过不断的完善,这个API终于成为一个十分受欢迎的Java日志软件包,即Log4j(由Ceki创建)。
  • 后来Log4j成为Apache基金会项目中的一员,Ceki也加入Apache组织。后来Log4j近乎成了Java社区的日志标准。据说Apache基金会还曾经建议Sun引入Log4j到Java的标准库中,但Sun拒绝了。
  • 2002年Java1.4发布,Sun推出了自己的日志库JUL(Java Util Logging),其实现基本模仿了Log4j的实现。在JUL出来以前,Log4j就已经成为一项成熟的技术,使得Log4j在选择上占据了一定的优势。
  • 接着,Apache推出了Jakarta Commons Logging,JCL只是定义了一套日志接口(其内部也提供一个Simple Log的简单实现),支持运行时动态加载日志组件的实现,也就是说,在你应用代码里,只需调用Commons Logging的接口,底层实现可以是Log4j,也可以是Java Util Logging。
  • 后来(2006年),Ceki不适应Apache的工作方式,离开了Apache。然后先后创建了Slf4j(日志门面接口,类似于Commons Logging)和Logback(Slf4j的实现)两个项目,并回瑞典创建了QOS公司,QOS官网上是这样描述Logback的:The Generic,Reliable Fast&Flexible Logging Framework(一个通用,可靠,快速且灵活的日志框架)。
  • Java日志领域被划分为两大阵营:Commons Logging阵营和Slf4j阵营。
  • Commons Logging在Apache大树的笼罩下,有很大的用户基数。但有证据表明,形式正在发生变化。2013年底有人分析了GitHub上30000个项目,统计出了最流行的100个Libraries,可以看出Slf4j的发展趋势更好。
  • Apache眼看有被Logback反超的势头,于2012-07重写了Log4j 1.x,成立了新的项目Log4j 2, Log4j 2具有Logback的所有特性。
  • 如今日志框架已经发展为:Slf4j作为API,实现分为logback与log4j(Commons Logging因为效率和API设计等问题,现在逐渐淡出舞台了)

让我们来瞻仰一下大神,哈哈:

那么如何在混乱的Java日志体系中如何优雅的使用日志呢?

其实在Ceki设计的体系下,日志如同Java的JDBC、Servelt等一样,定义好标准后实现可以互相切换,问题在于定标准的人各自为政搞出来好多标准,JCL、SLF4j等等,官方(Sun公司)又晚又不给力,发展到现在终于被SLF4j以一种巧妙的方式(桥接、绑定,见下文)统一了,标准使用方式如下图:

这个图截取自slf4j手册,简化了多余部分,很清晰的表示了使用方式:

应用引用SLF4j-API(编码时使用SLF4j的接口org.slf4j.Logger,而非logback或log4j的实现)

  • logbak: slf4j会自动查找logback实现(logback默认实现了slf4j)
  • log4j:使用起来基本一致,只不过多了适配器层,引用了slf4j-log4j12.jar,官方称为绑定(concrete-bindings),就是将SLF4j-API绑定到log4j最终输出日志

具体依赖如下

logback

<dependency>

<groupid>ch.qos.logback</groupid>

<artifactid>logback-classic</artifactid>

<version>1.2.3</version>

</dependency>

log4j2

<dependency>

<groupid>org.apache.logging.log4j</groupid>

<artifactid>log4j-slf4j-impl</artifactid>

<version>2.12.1</version>

</dependency>

<dependency>

<groupid>org.apache.logging.log4j</groupid>

<artifactid>log4j-core</artifactid>

<version>2.12.1</version>

</dependency>

得益于maven的依赖传递机制,我们不需要显示声明依赖SLF4j-API.jar。

可以看到,log4j 多依赖了 log4j-slf4j-impl.jar,其实就是上图所示的适配器层,读者可能好奇,为什么使用 log4j 会有适配器层?其原因在于,slf4j 并不是官方规范,所以没人遵守(也就是自己的日志框架中没有原生实现org.slf4j.Logger接口,如 log4j ),而绑定层( log4j-slf4j-impl.jar)的作用就是通过静态查找的方式将使用log4j作为实现(具体原理请关注后续文章),这样就是实现了不依赖log4j而使用log4j输出日志(面向接口编程的最佳实践,Ceki 大神就是用这套思想将 slf4j 做成了 Java 日志的标准,烂牌翻盘的典范)。

上面这一段讲解了绑定(concrete-bindings)思想,是本文的精髓,读者一定要理解这里,后面还有桥接思想与之类似,请继续阅读。

小结

至此我们已经完成了日志的整合,但是事情真的这么简单吗?

先梳理一下,如此混乱的日志体系下(slf4j,jul,jcl,logback,log4j)会不会会产生什么问题?答案是一定的,各种第三方库使用了不同的日志框架,如果我们依赖 Spring ,Spring(非boot)的默认日志实现是JCL、又或者我们已有项目已经使用了Log4j,想使用logback的话,难道要逐个类改代码吗(官方有迁移工具)?我们能不能只用一种框架来处理JUL(java.util.logging)、JCL(Jakarta Commons Logging)、Log4j1、Log4j2 呢?

答案是肯定的,Ceki 的 Slf4j 给出了解决方案,就是上文所说的桥接( Bridging legacy),简单来说就是劫持以上所以第三方日志输出并重定向至 SLF4j,最终实现统一日志上层 API(编码) 与下层实现(输出日志位置、格式统一)。我们来看一下图示:

上图左侧就是前一张图的 logback 日志实现,为了兼容其他日志,我们需要引用右侧的桥接包:xxx-over/to-slf4j.jar ,xxx对应日志框架,使用 logback 的情况下,除了上文的 logback 依赖,还需要引入以下依赖才能保证所有日志都被桥接至slf4j。

如何桥接?

logback 如下

<dependency>

<groupid>ch.qos.logback</groupid>

<artifactid>logback-classic</artifactid>

<version>1.2.3</version>

</dependency>

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>jcl-over-slf4j</artifactid>

</dependency>

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>jul-to-slf4j</artifactid>

</dependency>

<!-- log4j 桥接包,slf4j官方实现,另有log4j官方实现,

二选一即可 log4j-to-slf4j-->

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>log4j-over-slf4j</artifactid>

</dependency>

log4j2 如下

<dependency>

<groupid>org.apache.logging.log4j</groupid>

<artifactid>log4j-slf4j-impl</artifactid>

<version>2.12.1</version>

</dependency>

<dependency>

<groupid>org.apache.logging.log4j</groupid>

<artifactid>log4j-core</artifactid>

<version>2.12.1</version>

</dependency>

<!-- 以下是桥接包,使用了log4j作为底层实现,

不能再桥接log4j,否则会出现无限递归的情况(具体原因请关注后续文章) -->

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>jcl-over-slf4j</artifactid>

</dependency><dependency>

<groupid>org.slf4j</groupid>

<artifactid>jul-to-slf4j</artifactid>

</dependency>

SpringBoot 项目引用了一部分依赖,所以使用起来略微有些不同:

logback 如下

<!-- logback作为内置实现,使用相对简单 -->

<dependency>

<groupid>org.springframework.boot</groupid>

<artifactid>spring-boot-starter</artifactid>

</dependency>

<!-- 引入缺少的桥接包 -->

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>jcl-over-slf4j</artifactid>

</dependency>

log4j2 如下

<dependency>

<groupid>org.springframework.boot</groupid>

<artifactid>spring-boot-starter</artifactid>

<!-- 使用log4j2要排除logback依赖 -->

<exclusions>

<exclusion>

<groupid>org.springframework.boot</groupid>

<artifactid>spring-boot-starter-logging</artifactid>

</exclusion>

</exclusions>

</dependency>

<!-- Spring已经写好了一个log4j2-starter但缺少桥接包 -->

<dependency>

<groupid>org.springframework.boot</groupid>

<artifactid>spring-boot-starter-log4j2</artifactid>

</dependency>

<!-- 引入缺少的桥接包 -->

<dependency>

<groupid>org.slf4j</groupid>

<artifactid>jcl-over-slf4j</artifactid>

</dependency>

结束语

以上两种才是项目中的最佳使用方式,其他笔者不推荐使用。

最后来看一下 slf4j 如何使用:

static final org.slf4j.Logger logger = LoggerFactory.getLogger(TestLog.class);

logger.trace("A TRACE Message");

logger.debug("A DEBUG Message");

logger.info("An INFO Message");

logger.warn("A WARN Message");

logger.error("An ERROR Message");

这样使用我们就可以随意切换日志实现而无需改动代码,操作起来也简单,只需要按照上文切换依赖即可。至于其他使用细节本文不在赘述,关注后续文章(最佳实践、配置文件、原理、扩展等)。

如果觉得写的不错,求关注、求点赞、求转发,如果有问题或者文中有错误,欢迎留言讨论。

扫描关注公众号,第一时间获得更新

参考:

  • Java-日志的江湖
  • http://www.slf4j.org/manual.html
  • http://www.slf4j.org/legacy.html
  • www.baeldung.com/spring-boot…

转载请注明出处。

以上是 Java日志体系居然这么复杂?——架构篇 的全部内容, 来源链接: utcz.com/z/512435.html

回到顶部