JCL,全称为"Jakarta Commons Logging",也可称为"Apache Commons Logging"。

一、JCL原理

1、基本原理

JCL这个日志框架跟Log4J,Java Logging API等日志框架不同。JCL采用了设计模式中的“适配器模式”,它对外提供统一的接口,然后在适配类中将对日志的操作委托给具体的日志框架,比如Log4J,Java Logging API等。

在JCL中对外有两个统一的接口,分别是Log和LogFactory。

Log的继承体系如图1:

               图1

LogFactory的继承体系如图2:

图2

Log4JLogger,Jdk14Logger等是适配类。

在Log4JLogger类中,包含有"org.apache.log4j.Logger"类,即Log4J中的Logger类,因而对Log4JLogger类中的日志操作方法的调用会被委托给"org.apache.log4j.Logger"类运行

在Jdk14Logger类中,包含有"java.util.logging.Logger"类,即Java Logging API中的Logger类,因而对Jdk14Logger类中的日志操作方法的调用会被委托给"java.util.logging.Logger"类运行

2、具体加载步骤

在执行以下Java代码语句的时候,经历了哪些步骤?


  1. Log log = LogFactory.getLog(Main.class);
  2. log.error("Hello World");

1)通过查看源代码可以发现,执行"LogFactory.getLog(Main.class)"语句的时候,最终是执行LogFactoryImp类中的discoverLogImplementation方法,在该方法中有如下代码语句:


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

其中classesToDiscover的值如图3所示:

图3



这个过程就是依次去判断类路径中是否存在Log4J依赖,JDK依赖等。就是经常说的JCL运行时动态查找具体日志框架的过程。

2)在1)中discoverLogImplementation方法找到具体的日志框架依赖之后,会去生成相应的适配器类实例。比如找到了Log4J日志框架依赖,那么会生成一个Log4JLogger适配器类实例(以A来表示它),并将其返回。最后该适配器类实例,被赋值给"Log log = LogFactory.getLog(Main.class)"中的log对象。

3)执行log.error("Hello World");语句,实际上是执行A中的error(Object message)方法,而该方法中会去委托"A中所包含的org.apache.log4j.Logger类实例"进行处理。

二、基本原理扩展

1、本质上说,NoOpLog和SimpleLog不是适配器类,因为它们自身实现日志操作功能,而不是委托给其他日志框架。

2、关于JCL有两个包,分别是:commons-logging:commons-logging:1.1和commons-logging:commons-logging-api:1.1

这两者的主要差别在于前者比后者拥有更多的适配器类

前者中的适配器体系见图1

后者中的适配器体系见图4

图4

3、在commons-logging:commons-logging:1.1和commons-logging:commons-logging-api:1.1的pom.xml文件中,可以发现它们有对具体日志框架的依赖,比如在commons-logging:commons-logging:1.1的pom.xml中有如下片段:


  1. <dependency>
  2. <groupId>log4j</groupId>
  3. <artifactId>log4j</artifactId>
  4. <version>1.2.12</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>avalon-framework</groupId>
  8. <artifactId>avalon-framework</artifactId>
  9. <version>4.1.3</version>
  10. </dependency>

即包含有对Log4J和avalon-framework(也是一个具体的日志框架)的依赖。其实想想也是如此,因为JCL中含有Log4JLogger,Jdk14Logger等适配器类,在这些适配器类中含有对对应的具体的日志框架的依赖,比如在Log4JLogger类中,有如下片段:


  1. package org.apache.commons.logging.impl;
  2. import java.io.Serializable;
  3. import org.apache.commons.logging.Log;
  4. import org.apache.log4j.Logger;
  5. import org.apache.log4j.Priority;
  6. public class Log4JLogger implements Log, Serializable {}

以上这点表明,在项目中,我们只要包含了对commons-logging:commons-logging:1.1或者commons-logging:commons-logging-api:1.1的依赖,就会包含所有对它们所支持的具体日志框架的依赖。因而在JCL运行时动态查找具体日志框架的过程中,能够找到所有所支持的具体日志框架,根据具体的查找算法,选定某一个返回。

但是为了更加清晰准确,我们应该还是得在项目中包含对具体日志框架的依赖比较好,比如要使用“JCL+Log4J”的组合方案,那么在项目的pom.xml中,应该包含以下片段:


  1. <dependency>
  2. <groupId>commons-logging</groupId>
  3. <artifactId>commons-logging</artifactId>
  4. <version>1.1</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>log4j</groupId>
  8. <artifactId>log4j</artifactId>
  9. <version>1.2.17</version>
  10. </dependency>

4、在JCL中一般情况下,需要有两个配置文件,一个是JCL自身的,另外一个是具体日志框架的。比如在JCL中,具体的日志框架使用Log4J,那么需要有"commons-logging.properties"和"log4j.properties"这两个文件

5、由上述第3点可以知道,最终使用的具体日志框架由查找算法决定,这降低了我们对日志框架使用的控制度。我们也可以通过JCL的配置文件,即"commons-logging.properties",来明确指定最终使用的具体日志框架,达到精准控制定义的目标。具体是配置文件中的"org.apache.commons.logging.Log"属性。

比如在"commons-logging.properties"文件中,配置

org.apache.commons.logging.Log = org.apache.commons.logging.impl.Log4JLogger

那么显式指定使用Log4J这个具体日志框架,然后也生成"org.apache.commons.logging.impl.Log4JLogger"的一个实例

三、JCL如何使用的具体例子

1、JCL+Log4J

1.1、项目中的pom.xml配置


  1. <dependencies>
  2. <dependency>
  3. <groupId>commons-logging</groupId>
  4. <artifactId>commons-logging</artifactId>
  5. <version>1.1</version>
  6. </dependency>
  7. <dependency>
  8. <groupId>log4j</groupId>
  9. <artifactId>log4j</artifactId>
  10. <version>1.2.17</version>
  11. </dependency>
  12. </dependencies>

1.2、commons-logging.properties和log4j.properties两个文件的内容

"commons-logging.properties"文件内容如下:

org.apache.commons.logging.Log = org.apache.commons.logging.impl.Log4JLogger

"log4j.properties"文件内容如下:

# Root logger option
log4j.rootLogger=INFO, stdout # Direct log messages to stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target=System.out

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

1.3、Java代码


  1. import org.apache.commons.logging.Log;
  2. import org.apache.commons.logging.LogFactory;
  3. public class Main {
  4. public static void main(String[] args) {
  5. Log log = LogFactory.getLog(Main.class);
  6. log.error("Hello World");
  7. System.out.println(log.getClass());
  8. }
  9. }

1.4、输出结果

如图5

图5

2、JCL+Log4J

2.1、项目中的pom.xml配置


  1. <dependencies>
  2. <dependency>
  3. <groupId>commons-logging</groupId>
  4. <artifactId>commons-logging</artifactId>
  5. <version>1.1</version>
  6. </dependency>
  7. <dependency>
  8. <groupId>log4j</groupId>
  9. <artifactId>log4j</artifactId>
  10. <version>1.2.17</version>
  11. </dependency>
  12. </dependencies>

2.2、commons-logging.properties和log4j.properties两个文件的内容

"commons-logging.properties"文件内容如下:

org.apache.commons.logging.Log = org.apache.commons.logging.impl.Log4JLogger

"log4j.properties"文件不存在

2.3、Java代码


  1. import org.apache.commons.logging.Log;
  2. import org.apache.commons.logging.LogFactory;
  3. public class Main {
  4. public static void main(String[] args) {
  5. Log log = LogFactory.getLog(Main.class);
  6. log.error("Hello World");
  7. System.out.println(log.getClass());
  8. }
  9. }

2.4、输出结果

如图6

图6

3、JCL+Java Logging API

3.1、项目中的pom.xml配置


  1. <dependency>
  2. <groupId>commons-logging</groupId>
  3. <artifactId>commons-logging</artifactId>
  4. <version>1.1</version>
  5. </dependency>
  6. <!--对JDK的依赖无需在pom.xml中配置-->

3.2、commons-logging.propertie和logging.properties两个文件的内容

"commons-logging.properties"文件内容如下:

org.apache.commons.logging.Log = org.apache.commons.logging.impl.Jdk14Logger

"logging.properties"文件是Java Logging API默认的配置文件名称,默认路径是JDK_HOME/jre/lib/logging.properties

3.3、Java代码


  1. import org.apache.commons.logging.Log;
  2. import org.apache.commons.logging.LogFactory;
  3. public class Main {
  4. public static void main(String[] args) {
  5. Log log = LogFactory.getLog(Main.class);
  6. log.error("Hello World");
  7. System.out.println(log.getClass());
  8. }
  9. }

3.4、输出结果

如图7

图7



四、其他

1、在项目中使用JCL的好处是降低与具体日志框架的耦合,可以灵活改变使用的具体日志框架

2、经典的日志框架组合为:JCL+Log4J

3、Spring项目中就选用了JCL框架

参考文献:

[1]http://commons.apache.org/proper/commons-logging/guide.html

[2]http://www.javapractices.com/topic/TopicAction.do?Id=143

原文地址:https://blog.csdn.net/DSLZTX/article/details/47132329

Java日志框架——JCL的更多相关文章

  1. java日志框架与日志系统

    日志框架:提供日志调用的接口,实际的日志输出委托给日志系统实现. JCL(Jakarta Commons Logging):比较流行的日志框架,很多框架都依赖JCL,例如Spring等. SLF4j: ...

  2. Java日志框架那些事儿

    文章首发于[博客园-陈树义],点击跳转到原文Java日志框架那些事儿. 在项目开发过程中,我们可以通过 debug 查找问题.而在线上环境我们查找问题只能通过打印日志的方式查找问题.因此对于一个项目而 ...

  3. Java程序员最常用的8个Java日志框架

    转自:http://www.codeceo.com/article/8-java-log-framework.html 作为一名Java程序员,我们开发了很多Java应用程序,包括桌面应用.WEB应用 ...

  4. 转:Java程序员最常用的8个Java日志框架

    作为一名Java程序员,我们开发了很多Java应用程序,包括桌面应用.WEB应用以及移动应用.然而日志系统是一个成熟Java应用所必不可少的,在开发和调试阶段,日志可以帮助我们更好更快地定位bug:在 ...

  5. Java 日志框架终极教程

    概述 对于现代的 Java 应用程序来说,只要被部署到真实的生产环境,其日志的重要性就是不言而喻的,很难想象没有任何日志记录功能的应用程序被运行于生产环境中.日志 API 所能提供的功能是多种多样的, ...

  6. Java基础学习总结(40)——Java程序员最常用的8个Java日志框架

    作为一名Java程序员,我们开发了很多Java应用程序,包括桌面应用.WEB应用以及移动应用.然而日志系统是一个成熟Java应用所必不可少的,在开发和调试阶段,日志可以帮助我们更好更快地定位bug:在 ...

  7. Java日志框架总结

    1. 前言 从写代码开始,就陆陆续续接触到了许多日志框架,较常用的属于LOG4J,LogBack等.每次自己写项目时,就copy前人的代码或网上的demo.配置log4j.properties或者lo ...

  8. Java-最常用的Java日志框架整理

    Java-最常用的Java日志框架整理 前言 Java程序员,我们开发了很多Java应用程序,包括桌面应用.WEB应用以及移动应用.然而日志系统是一个成熟Java应用所必不可少的,在开发和调试阶段,日 ...

  9. java日志框架系列(4):logback框架xml配置文件语法

    1.xml配置文件语法 由于logback配置文件语法特别灵活,因此无法用DTD或schema进行定义. 1.配置文件基本结构 配置文件基本结构:以<configuration>标签开头, ...

随机推荐

  1. 逐行粒度的vuex源码分析

    vuex源码分析 了解vuex 什么是vuex vuex是一个为vue进行统一状态管理的状态管理器,主要分为state, getters, mutations, actions几个部分,vue组件基于 ...

  2. c标签 if else c标签 总结

    [b]STL标签用法 关键字:JSTL标签.<c:choose>.<c:forEach>.<c:forTokens>.<c:if>.<c:impo ...

  3. 【水滴石穿】react-native-ble-demo

    项目的话,是想打开蓝牙,然后连接设备 点击已经连接的设备,我们会看到一些设备 不过我这边在开启蓝牙的时候报错了 先放作者的项目地址: https://github.com/hezhii/react-n ...

  4. 几道莫名AC的并查集题

    那啥那啥 原本今天还是做(看)差分约束的,但是上不去Vjudge我只能来刷并查集了. %%%静萱大佬把那么多年的noip题都刷遍了,我只能刷水题,noip的题实在是太难了不会啊. 第一道:洛谷P202 ...

  5. LintCode_111 爬楼梯

    题目 假设你正在爬楼梯,需要n步你才能到达顶部.但每次你只能爬一步或者两步,你能有多少种不同的方法爬到楼顶部? 比如n=3,中不同的方法 返回 3 1 2 3 5 8 13... step[2] = ...

  6. 怎样做一个iOS App的启动分层引导动画?

    一. 为什么要写这篇文章? 这是一个很古老的话题,从两年前新浪微博开始使用多层动画制作iOS App的启动引导页让人眼前一亮(当然,微博是不是历史第一个这个问题值得商榷)之后,各种类型的引导页层出不穷 ...

  7. OpenTelemetry-可观察性的新时代

    有幸在2019KubeCon上海站听到Steve Flanders关于OpenTelemetry的演讲,之前Ops领域两个网红项目OpenTracing和OpenCensus终于走到了一起,可观察性统 ...

  8. Vagrant-安装教程及常见问题

    http://ju.outofmemory.cn/entry/346215 前言: Vagrant是一个基于Ruby的工具,用于创建和部署虚拟化开发环境. 它的主要意义是让所有开发人员都使用和线上服务 ...

  9. NS2学习笔记

    这两天在调一个仿真程序,比较奇怪的错误,就是一个节点广播消息,在它通信半径内的节点收不到消息,一直在通信上找问题,找了半天也没找到. 最后,用gdb调试,发现在一个操作指针处发生了段错误,引起的原因时 ...

  10. jenkins使用教程!

    http://jenkins-ci.org/ 首先去官方下载war包,直接安装jenkins的方式比较麻烦. 下载tomcat,jdk和ant cd /optwget http://mirrors.h ...