栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

java日志框架之JCL和SLF4J

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

java日志框架之JCL和SLF4J

文章目录
  • 1、JCL
    • 1.1、JCL简介
    • 1.2、入门使用
  • 2、SLF4J
    • 2.1、日志门面概述
    • 2.2、SLF4J简介
    • 2.3、入门使用
    • 2.4、slf4j实现slf4j-simple和logback
    • 2.5、slf4j绑定适配器实现log4j
    • 2.6、slf4j绑定适配器实现JUL
    • 2.7、jcl、log4j、jul转换为slf4j的桥接器
    • 2.8、log4j日志重构为slf4j+logback的组合
    • 2.9、总结

1、JCL 1.1、JCL简介
  • 全称为Jakarta Commons Logging,是Apache提供的一个通用日志API
  • 用户可以自由选择第三方的日志组件作为具体实现,像log4j,或者jdk自带的jul,common-logging会通过动态查找的机制,在程序运行时自动找出真正使用的日志库
  • 使用它的好处就是,代码依赖是common-logging而非log4j的API, 避免了和具体的日志API直接耦合,在有必要时,可以更改日志实现的第三方库(不改变代码,只修改依赖)
  • JCL 有两个基本的抽象类:Log(日志记录器),LogFactory(日志工厂负责创建Log实例)
1.2、入门使用

jcl依赖


    commons-logging
    commons-logging
    1.2

导包

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
  • 如果没有任何第三方日志框架的时候,我们使用的就是JUL
  • 如果有log4j,优先使用log4j
@Test
public void test01(){
    Log log = LogFactory.getLog(JCLTest.class);
    log.info("info信息");
}

1)只导入commons-logging的输出结果:

六月 24, 2022 9:13:33 下午 com.xc.mylog.JCLTest test01
信息: info信息

Process finished with exit code 0

2)添加依赖和log4j.properties文件后的额输出结果:


    log4j
    log4j
    1.2.17

#配置根节点logger
log4j.rootLogger=trace,console

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern=[%-10p]%r %c%t%d{yyyy-MM-dd HH:mm:ss:SSS} %m%n
[INFO      ]0 com.xc.mylog.JCLTestmain2022-06-24 21:25:35:598 info信息

Process finished with exit code 0
2、SLF4J 2.1、日志门面概述

门面模式(外观模式)

  • 门面模式(Facade Pattern),也称之为外观模式
  • 核心为外部与一个子系统的通信必须通过一个统一的外观对象进行,使得子系统更易于使用
  • 更简单的说,就是对外提供的接口要尽可能的简单

日志门面

  • 在不同日志框架和应用程序之间架设一个沟通的桥梁,对于应用程序来说,无论底层的日志框架如何变,都不需要有任何感知
  • 只要门面服务做的足够好,随意换另外一个日志框架,应用程序不需要修改任意一行代码, 就可以直接上线

常见的日志框架及日志门面

  • 常见的日志实现:JUL、log4j、logback、log4j2
  • 常见的日志门面 :JCL、slf4j
  • 框架诞生顺序 :log4j -->JUL–>JCL–> slf4j --> logback --> log4j2
2.2、SLF4J简介
  • 简单日志门面(Simple Logging Facade For Java) SLF4J 主要是为了给Java日志访问提供一套标准、规范的API框架
  • 主要意义在于提供接口,具体的实现可以交由其他日志框架,例如log4j和logback等
  • slf4j自己也提供了功能较为简单的实现,但是一般很少用到
  • SLF4J最重要的两个功能就是对于日志框架的绑定以及日志框架的桥接
2.3、入门使用

SLF4J对日志的级别划分

  • trace:日志追踪信息
  • debug:日志详细信息
  • info:日志的关键信息 默认打印级别
  • warn:日志警告信息
  • error:日志错误信息

依赖



    org.slf4j
    slf4j-api
    1.7.25




    org.slf4j
    slf4j-simple
    1.7.25

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  • 在没有任何其他日志实现框架集成的基础之上
  • slf4j使用的就是自带的框架slf4j-simple
@Test
public void test01(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    logger.trace("trace信息");
    logger.debug("debug信息");
    logger.info("info信息");
    logger.warn("warn信息");
    logger.error("error信息");
}

输出结果:

[main] INFO com.xc.mylog.SLF4JTest - info信息
[main] WARN com.xc.mylog.SLF4JTest - warn信息
[main] ERROR com.xc.mylog.SLF4JTest - error信息

Process finished with exit code 0

输出动态信息

Logger方法: public void info(String format, Object… arguments);

@Test
public void test02(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    String name = "zs";
    int age = 23;
    //logger.info("学生信息-姓名:"+name+";年龄:"+age); 字符串拼接,效率低
    //logger.info("学生信息-姓名:{},年龄:{}",new Object[]{name,age});//老方式,代码冗余
    logger.info("学生信息-姓名:{},年龄:{}",name,age);//新方式,简单
}

输出结果:

[main] INFO com.xc.mylog.SLF4JTest - 学生信息-姓名:zs,年龄:23

Process finished with exit code 0

异常信息的处理

Logger方法: public void info(String msg, Throwable t);

@Test
public void test03(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    try {
        Class.forName("aaa");
    } catch (ClassNotFoundException e) {
        //打印栈追踪信息
        //e.printStackTrace();
        logger.info("具体错误是:",e);
    }
}

输出结果:

[main] INFO com.xc.mylog.SLF4JTest - 具体错误是:
java.lang.ClassNotFoundException: aaa
	at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
	at java.lang.Class.forName0(Native Method)
	at java.lang.Class.forName(Class.java:264)
	at com.xc.mylog.SLF4JTest.test03(SLF4JTest.java:88)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)

Process finished with exit code 0
2.4、slf4j实现slf4j-simple和logback
  • 在没有绑定任何日志实现的基础之上,日志是不能够绑定实现任何功能;slf4j-simple是slf4j官方提供的,如果不导入,slf4j 核心依赖是不提供任何实现的
  • logback和simple只需要导入想要使用的日志实现依赖,即可与slf4j无缝衔接
  • log4j和JUL需要适配桥接的技术,完成的与日志门面的衔接

依赖



    org.slf4j
    slf4j-api
    1.7.25

        


    ch.qos.logback
    logback-classic
    1.2.3




    org.slf4j
    slf4j-simple
    1.7.25

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  • 集成多个日志框架,会出红色警告
  • 如果有多个日志实现的话,默认使用先导入的实现
  • 无论使用slf4j自己的slf4j-simple还是logback,导包都不会变,都用的以上两个
@Test
public void test04(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    try {
        Class.forName("aaa");
    } catch (ClassNotFoundException e) {
        //打印栈追踪信息
        //e.printStackTrace();
        logger.info("具体错误是:",e);
    }
}

输出结果:

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/E:/java/maven/mvnrep/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/E:/java/maven/mvnrep/org/slf4j/slf4j-simple/1.7.25/slf4j-simple-1.7.25.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]
22:36:15.538 [main] INFO com.xc.mylog.SLF4JTest - 具体错误是:
java.lang.ClassNotFoundException: aaa
	at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
	at java.lang.Class.forName0(Native Method)
	at java.lang.Class.forName(Class.java:264)
	at com.xc.mylog.SLF4JTest.test04(SLF4JTest.java:159)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)

Process finished with exit code 0
2.5、slf4j绑定适配器实现log4j
  • 由于log4j是在slf4j之前出品的日志框架实现,所以并没有遵循slf4j的API规范
  • 之前集成的logback,是slf4j之后出品的日志框架实现,就是按照slf4j的标准指定的API,所以我们导入依赖就能用
  • 如果想要使用,需要绑定一个适配器(slf4j-log4j12)导入log4j的实现

添加依赖



    org.slf4j
    slf4j-api
    1.7.25




    org.slf4j
    slf4j-log4j12
    1.7.25

  • 根据测试发现,log4j依赖添不添加都可以


    log4j
    log4j
    1.2.17

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

log4j.properties

#配置根节点logger
log4j.rootLogger=trace,console

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern=[%-10p]%r %c%t%d{yyyy-MM-dd HH:mm:ss:SSS} %m%n
@Test
public void test05(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    logger.trace("trace信息");
    logger.debug("debug信息");
    logger.info("info信息");
    logger.warn("warn信息");
    logger.error("error信息");
}

输出结果:

[TRACE     ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:04:31:101 trace信息
[DEBUG     ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:04:31:101 debug信息
[INFO      ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:04:31:101 info信息
[WARN      ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:04:31:101 warn信息
[ERROR     ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:04:31:101 error信息

Process finished with exit code 0
2.6、slf4j绑定适配器实现JUL

与slf4j绑定适配器实现log4j一样,只是添加不同的适配器依赖



    org.slf4j
    slf4j-api
    1.7.25

        

    org.slf4j
    slf4j-jdk14
    1.7.25

导包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Test
public void test06(){
    Logger logger = LoggerFactory.getLogger(SLF4JTest.class);
    logger.trace("trace信息");
    logger.debug("debug信息");
    logger.info("info信息");
    logger.warn("warn信息");
    logger.error("error信息");
}

输出结果:

六月 24, 2022 11:18:25 下午 com.xc.mylog.SLF4JTest test06
信息: info信息
六月 24, 2022 11:18:25 下午 com.xc.mylog.SLF4JTest test06
警告: warn信息
六月 24, 2022 11:18:25 下午 com.xc.mylog.SLF4JTest test06
严重: error信息

Process finished with exit code 0
2.7、jcl、log4j、jul转换为slf4j的桥接器

2.8、log4j日志重构为slf4j+logback的组合

重构前

依赖


    log4j
    log4j
    1.2.17

log4j.properties

#配置根节点logger
log4j.rootLogger=trace,console

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern=[%-10p]%r %c%t%d{yyyy-MM-dd HH:mm:ss:SSS} %m%n

导包

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
@Test
public void test07(){
    Logger logger = LogManager.getLogger(SLF4JTest.class);
    logger.info("info信息");
}

输出结果:

[INFO      ]0 com.xc.mylog.SLF4JTestmain2022-06-24 23:35:38:356 info信息

Process finished with exit code 0

查看LogManager源码

重构后

依赖:删除log4j依赖,添加slf4j提供的桥接组件和logback依赖



    org.slf4j
    log4j-over-slf4j
    1.7.25



    ch.qos.logback
    logback-classic
    1.2.3

导包:依然不变

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
@Test
public void test08(){
    Logger logger = LogManager.getLogger(SLF4JTest.class);
    logger.info("info信息");
}

输出结果:

23:38:26.617 [main] INFO com.xc.mylog.SLF4JTest - info信息

Process finished with exit code 0

查看LogManager源码

2.9、总结
  • slf4j绑定不同的日志框架实现,只需要修改依赖,代码及import都不用变,即可实现不同日志框架的变更
  • log4j日志重构为slf4j+logback的组合,根据查看LogManager源码的结果可知,log4j-over-slf4j桥接器只是伪造了log4j同样的包路径org.apache.log4j.LogManager和org.apache.log4j.Logger,所以重构后代码及import都不变,即实现了从slf4j到logback的转换
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/993051.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号