Skip to main content

JAVA 常见日志依赖处理细节

· 7 min read
jeesk

本文并不设置某个日志框架的配置,只是介绍其他日志框架和slf4j 的切换与桥接配合使用​

当你的项目中有spring ,kafka, hbase , hadoop 等框架的时候, 日志依赖混乱,各种pom眼花缭乱, 看了下面的文字, 让你轻松掌握各种日志框架的混合使用和嫁接.

各种包介绍​

  1. log4j

    • log4j : 实现和接口都在这个包

  2. log4j2

    • log4j-core : 核心包,日志实现

    • log4j-api : 日志api

  3. logback

    • logback-core : logback 核心包

    • logback-classic : 实现包,实现了slf4j-api

  4. commons-logging

    • commons-logging : jcl的原生全部内容

    • log4j-jcl : jcl到log4j2的桥梁 , 使用jcl的实现, 但是使用log4j2的接口

    • jcl-over-slf4j ：jcl到slf4j的桥梁,使用slf4j 的api, 日志打印 实现使用jcl

日志框架包的分类​

  1. api 包, 这种包只有接口, 比如slf4j-api, log4j-api ,每个日志框架都要自己api.

  2. 实现包, 比如slf4j-api 的实现有logback-classic, log4j-api的实现有log4j.

  3. 桥接器 日志统一管理使用slf4j, 但是实现用的jcl, 或者jul,或者log4j , 但是这些实现都不是slf4j的api的实现,只能提供桥接器,将slf4j 打印的日志, 交给具体的实现去操作, 这里的桥接器也可以叫做驱动.

  4. 切换器, 我需要将log4j 切换到Logback , 这个时候, 我可以使用slf4j提供的假包, 替换原有的实现类, 然后将日志重新交给slf4j管理. 比如, 项目使用的是Log4j, 那么直接使用 log4j-over-slf4j 替换log4j 即可. (其实在很多的文章中并没有切换器这个概念, 包括maven的分类中, 但是为了区分功能, 这里我还是区分出来了)

桥接器包​

什么是桥接器, 就是某个日志的具体实现, 要想配合slf4j的api使用, 但是在使用slf4j 的api的打印, 无法找到对应的实现类, 这个时候需要第三方包桥接一下, 当slf4j 打印日志的时候,交给具体的日志实现类.

  1. slf4j-jdk14 ：slf4j到jdk-logging的桥梁

  2. slf4j-log4j12 ：slf4j到log4j1的桥梁

  3. log4j-slf4j-impl ：slf4j到log4j2的桥梁

  4. logback-classic ：slf4j到logback的桥梁

  5. slf4j-jcl ：slf4j到commons-logging的桥梁

切换器包( 偷天换日, slf4j 提供了其他日志的包, 替换了原来的程序, 直接将日志交给了slf4j管理, 并且不需要更改代码. 但是jul 除外)​

什么是切换器, 就是当一个模块使用了他自己的日志实现和api , 但是想将日志的输出交给slf4j 管理. 这个时候需要一个切换器将第三方模块的日志切换到slf4j.

  1. jul-to-slf4j ：jdk-logging到slf4j的桥梁, 将jul 日志交给slf4j管理, 这个包不能和slf4j-jdk14 共存, 否则会导致无限循环.

  2. jcl-over-slf4j ：commons-logging到slf4j的桥梁,commons-logging.jar替换 为 jcl-over-slf4j.jar, 将jcl的日志交给slf4j管理.

  3. slf4j-jcl.jar : 我们的一些用户在切换到 SLF4J API 后意识到，在某些情况下，JCL 的使用是强制性的，他们使用 SLF4J 可能是一个问题。对于这种不常见但很重要的情况，SLF4J 提供了 JCL 绑定，可在文件slf4j-jcl.jar 中找到。JCL 绑定会将通过 SLF4J API 进行的所有日志记录调用委托给 JCL。因此，如果由于某种原因现有应用程序必须 使用 JCL，那么您的应用程序部分仍然可以以对更大的应用程序环境透明的方式针对 SLF4J API 进行编码。您选择的 SLF4J API 对可以继续使用 JCL 的应用程序的其余部分是不可见的。 这种情况下. jcl-overslf4j.jar-不可与slf4j-jcl.jar 同时使用.

  4. log4j-over-slf4j ：log4j1到slf4j的桥梁, 而只需将log4j.jar文件替换为 log4j-over-slf4j.jar.

  5. log4j-to-slf4j log4j2 到slf4j的桥梁, 将log4j2的日志移交给slf4j, 原文 原文.

日志方案:​

直接使用api和实现​

  1. 直接使用java common log 模块: use-jcl-log

  2. 直接使用log4j 的api和实现 模块: use-log4j

  3. 直接使用log4j2 的api和实现 模块: use-log4j2-impl-and-log4j2-api

  4. 直接使用jdk-logging 实现和api 模块: use-jdk-logging

  5. 直接使用slf4j-api和slf4j-simple简单的日志实现 模块: slf4j-sample-impl

使用slf4j自带​

  1. 使用slf4j的api,没有任何实现 模块: nologImpl

  2. 使用slf4j的api, 并且同时使用slf4f-nop,和slf4j-sample 实现 模块: multilogImpl

使用第三方实现 和slf4j 的api​

  1. 使用log4j 的实现,结合slf4j 的api 模块: user-log4jImpl-and-slf4japi

  2. 使用jdk的实现,结合slf4j 的api 模块: use-jdk-logging-imple-and-sl4j-api

  3. 使用 jcl 日志实现,结合slf4j的api 模块: use-jcl-imple-and-slf4j-api

  4. 使用logback的日志实现,结合slf4j的api 模块: use-logback-imple-and-slf4j-api

  5. 使用log4j2 的日志实现,结合slf4j 的api 模块: use-log4j2-imple-and-slf4j-api

日志切换器,引用的模块使用了自己的日志实现和api, 将日志输出切换到slf4j 上面 (项目中常用,常见依赖处理)​

  1. jcl 切换到 slf4j , 最终由logback 打印 模块: remove-common-logging-use-slf4j

  2. log4j 切换到 slf4j ,最终由logback 打印 模块: remove-log4j-use-slf4j-and-use-logback-impl

  3. jdk logging 切换到 slf4j,最终由logback 打印 模块: remove-jdk-loggin-use-slf4j-and-logback-impl

由于作者水平有限, 出现的错误请多多包含. 烦请指点一二.

本文简书地址: https://www.jianshu.com/p/7d12a8c25a38 全文例子如下: https://gitee.com/imomoda/log4-study