Java日志门面技术 JCL

欲无缘

已于 2023-01-18 16:13:07 修改

阅读量655

点赞数 1

分类专栏：日志框架文章标签： java log4j junit

于 2023-01-18 16:11:57 首次发布

原文链接：https://blog.csdn.net/w15558056319/article/details/123793600

版权

日志框架专栏收录该内容

7 篇文章 0 订阅

订阅专栏

文章目录

背景

在前面博文中，我们分别讲述了常用的2个日志框架：JUL（Java Util Logging）、Log4J。那么如何选择使用哪一个呢？

根据项目需求而定，在项目设计之初，功能比较单一简单，那么我们可以使用JUL日志框架，使用起来非常灵活，也不需要引入第三方依赖，随着我们项目升级，迭代维护，功能会越来越完善，简单的日志实现框架就不能满足我们的业务需求，那么就要进行日志升级！

如果我们从JUL日志实现框架切换为Log4j的话，代码会受到冲突影响，虽然Log4j在1.2以后，为了迎合JUL的设计思想，也把自己代码改成logger了，但它的日志级别和配置信息还是有一定的差异化，如果我们的日志代码有一万行，那么都要进行修改，这无疑是增加了很多工作量。

JCL的诞生

为了解决这个问题，apache组织就站出来了，它就将当时比较主流的日志实现框架，例如 JUL、Log4j 将代码统一成一套API，后期软件开发阶段，只需要关联这套统一的API，就可以操作某一个日志实现框架的日志记录了，代码无需发生改变。

以面向接口的方式，来操作具体的实现。一种解耦合的思想，这个技术就是：JCL

比如web应用需要进行日志记录的话，不再直接依赖log4j、jdk14等日志实现了，而是依赖JCL这套统一的接口API，它会帮助我们调用具体的日志实现。

在这里插入图片描述

JCL是什么？

JCL 全称为Jakarta Commons Logging，是Apache提供的一个通用日志API。

JCL 有两个基本的抽象类：Log（基本记录器）和 LogFactory（负责创建Log实例）

快速入门

新建一个maven项目引入maven依赖，为了方便测试，同步也引入Junit

<dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>
</dependencies>

编写测试用例

// 注意：jcl日志框架引入的是org.apache.commons.logging包类
public class Demo {
 
    // 入门案例
    @Test
    public void testQuick(){
        // 1.通过LogFactory获取日志记录器
        Log log = LogFactory.getLog(Demo.class);
 
        // 2.打印日志信息
        log.info("hello JCL");
 
    }
}

在这里插入图片描述

LogFactory 负责创建具体log实例，底层调用Log4j 或 JUL(Java util logging) ，具体调用哪个取决于引入了哪个组件，上述例子没有引入Log4j依赖，因此它底层用的是JUL日志框架。

引入Log4j依赖

<dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.13</version>
</dependency>

再次运行
在这里插入图片描述

⚠️ warn警告： 找不到logger对象的appenders处理器，它希望我们设置并初始化一个系统配置信息

# 设置rootLogger的日志级别为trace，appender处理器类型为ConsoleAppender
log4j.rootLogger = trace,consoleAppender
# "log4j.appender." 是前缀规范设置参数，myAppender是我们自己定义的appender的名称
# 设置appender类型为ConsoleAppender：将日志输出到控制台
log4j.appender.consoleAppender = org.apache.log4j.ConsoleAppender
# 设置名为myAppender的appender处理器的layout日志格式化类型
log4j.appender.consoleAppender.layout = org.apache.log4j.SimpleLayout

再次运行成功

在这里插入图片描述

JCL原理

其内部主要通过LogFactory 日志工厂去加载具体的日志实现

通过LogFactory动态加载Log实现类

在这里插入图片描述

日志门面支持的日志实现数组

public class LogFactoryImpl extends LogFactory {
    .....
 
    private static final String[] classesToDiscover = new String[]. 
        {
         "org.apache.commons.logging.impl.Log4JLogger", 
         "org.apache.commons.logging.impl.Jdk14Logger", 
         "org.apache.commons.logging.impl.Jdk13LumberjackLogger", 
         "org.apache.commons.logging.impl.SimpleLog"
        };
 
    .....
 
}

日志工厂其内部有一个加载日志的数组，加载顺序是按照数组顺序来的，这也解释了为什么入门案例中引入了Log4J，JCL内部日志框架就从JUL切换至Log4J了。

具体实现代码

for(int i = 0; i < classesToDiscover.length && result == null; ++i) {
    result = this.createLogFromClass(classesToDiscover[i], logCategory, true);
}