commons-logging的使用简介、Java的那些日志---commons-loging 、log4j 、slf4j 、LogBack 的理解与区分

迈不过友情╰ 2022-05-08 10:36 46阅读 0赞

转载自：[https://blog.csdn.net/backbug/article/details/78655664][https_blog.csdn.net_backbug_article_details_78655664]

## 简介： ##

> Jakarta  Commons-logging（JCL）是apache最早提供的日志的门面接口。提供简单的日志实现以及日志解耦功能。

JCL能够选择使用Log4j（或其他如slf4j等）还是JDK Logging，但是他不依赖Log4j，JDK Logging的API。如果项目的classpath中包含了log4j的类库，就会使用log4j，否则就使用JDK Logging。使用commons-logging能够灵活的选择使用那些日志方式，而且不需要修改源代码。（类似于JDBC的API接口）

## 原理： ##

JCL有两个基本的抽象类： Log( 基本记录器 ) 和 LogFactory( 负责创建 Log 实例 ) 。当 commons-logging.jar 被加入到 CLASSPATH之后，它会合理地猜测你想用的日志工具，然后进行自我设置，用户根本不需要做任何设置。默认的 LogFactory 是按照下列的步骤去发现并决定那个日志工具将被使用的（按照顺序，寻找过程会在找到第一个工具时中止） :

> ①首先在classpath下寻找commons-logging.properties文件。如果找到，则使用其中定义的Log实现类；如果找不到，则在查找是否已定义系统环境变量org.apache.commons.logging.Log，找到则使用其定义的Log实现类；
> 
>

> ②查看classpath中是否有Log4j的包，如果发现，则自动使用Log4j作为日志实现类；
> 
>

> ③否则，使用JDK自身的日志实现类（JDK1.4以后才有日志实现类）；
> 
>

> ④否则，使用commons-logging自己提供的一个简单的日志实现类SimpleLog；

org.apache.commons.logging.Log 的具体实现有如下：

\---org.apache.commons.logging.impl.Jdk14Logger 　使用 JDK1.4 。

\---org.apache.commons.logging.impl.Log4JLogger 　使用 Log4J 。

\---org.apache.commons.logging.impl.LogKitLogger    使用 avalon-Logkit 。

\---org.apache.commons.logging.impl.SimpleLog 　    common-logging 自带日志实现类。

\---org.apache.commons.logging.impl.NoOpLog          common-logging 自带日志实现类。它实现了 Log 接口。 其输出日志的方法中不进行任何操作。

————————————————————————————————————————

Maven依赖：

1.  `<dependency>`
2.  `<groupId>commons-logging</groupId>`
3.  `<artifactId>commons-logging</artifactId>`
4.  `<version>1.2</version>`
5.  `</dependency>`

## 一、Commons-logging简单日志实现： ##

①新建commons-logging.properties文件，放置在classpath根路径下：

![SouthEast][]

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

②代码中使用

1.  `import org.apache.commons.logging.Log;`
2.  `import org.apache.commons.logging.LogFactory;`
3.   
4.  `public class CommonsTest {`
5.  `private final static Log logger = LogFactory.getLog(CommonsTest.class);`
6.   
7.  `public static void main(String[] args) {`
8.  `logger.debug("DEBUG ...");`
9.  `logger.info("INFO ...");`
10. `logger.error("ERROR ...");`
11. `}`
12. `}`

输出：

**![SouthEast 1][]**

## 二、Commons-logging的解耦功能： ##

commons-logging最核心有用的功能是解耦，它的SimpleLog实现性能比不上其他实现，如log4j等。

①添加依赖

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

②修改配置文件：

![SouthEast 2][]

修改commons-logging.properties文件：显示地指定log4j

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

并添加log4j.properties的配置文件：

1.  `log4j.rootLogger=DEBUG,console`
2.   
3.  `# 输出到控制台`
4.  `log4j.appender.console=org.apache.log4j.ConsoleAppender`
5.  `# 设置输出样式`
6.  `log4j.appender.console.layout=org.apache.log4j.PatternLayout`
7.  `# 日志输出信息格式为`
8.  `log4j.appender.console.layout.ConversionPattern=[%-d{yyyy-MM-dd HH:mm:ss}]-[%t-%5p]-[%C-%M(%L)]: %m%n`

③代码中使用

输出：

**![SouthEast 3][]**

=========================================================================

# Java的那些日志---commons-loging 、log4j 、slf4j 、LogBack 的理解与区分 #

[https://blog.csdn.net/zengshunyao/article/details/26145409][https_blog.csdn.net_zengshunyao_article_details_26145409]

最近自己动手做项目时，发现Java日志实现这么狗血。。。

以下是小弟的一些拙见。。。望过往牛人指正！

如果对于commons-loging 、log4j 、slf4j 、LogBack 等都已经非常清楚了，可以忽略本文。几次解决日志冲突问题时对这几个概念的简单总结，希望对这块基础没有理解透的同学能有所帮助，当然如果对这块有更深刻理解的同学，也贡献出自己的知识和见解。

**一、     概念**

**Commons-logging **: apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC 的api 接口，具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦，不过其内部也实现了一些简单日志方案。

**Log4j **: 经典的一种日志解决方案。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。

**Slf4j **: 全称为Simple Logging Facade for JAVA：java简单日志门面。 是对不同日志框架提供的一个门面封装。可以在部署的时候不修改任何配置即可接入一种日志实现方案。和commons-loging 应该有一样的初衷。个人感觉设从计上更好一些，没有commons 那么多潜规则。同时有两个额外特点：

1. 能支持多个参数，并通过\{\} 占位符进行替换，避免老写logger.isXXXEnabled 这种无奈的判断，带来性能提升见：http://www.slf4j.org/faq.html\#logging\_performance 。

2.OSGI 机制更好兼容支持

一图胜千言，官网上的一个图：

![a88174245d4bf56bae170fed847dca43.png][]

从上图可以发现，选择还是很多的。

**Logback **: LOGBack 作为一个通用可靠、快速灵活的日志框架，将作为Log4j 的替代和SLF4J 组成新的日志系统的完整实现。官网上称具有极佳的性能，在关键路径上执行速度是log4j 的10 倍，且内存消耗更少。具体优势见：

http://logback.qos.ch/reasonsToSwitch.html

**二、     常见日志方案和注意事项**

**1.Commons-logging+log4j **: 经典的一个日志实现方案。出现在各种框架里。如spring 、webx 、ibatis 等等。直接使用log4j 即可满足我们的日志方案。但是一般为了避免直接依赖具体的日志实现，一般都是结合commons-logging 来实现。常见代码如下：

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

private static Log logger = LogFactory.getLog(CommonsLoggingTest.class);

代码上，没有依赖任何的log4j 内部的类。那么log4j 是如何被装载的？

Log 是一个接口声明。LogFactory 的内部会去装载具体的日志系统，并获得实现该Log 接口的实现类。而内部有一个Log4JLogger 实现类对Log 接口同时内部提供了对log4j logger 的代理。LogFactory 内部装载日志系统流程：

1.   首先，寻找org.apache.commons.logging.LogFactory 属性配置

2.   否则，利用JDK1.3 开始提供的service 发现机制，会扫描classpah 下的META-INF/services/org.apache.commons.logging.LogFactory 文件，若找到则装载里面的配置，使用里面的配置。

3.   否则，从Classpath 里寻找commons-logging.properties ，找到则根据里面的配置加载。

4.   否则，使用默认的配置：如果能找到Log4j 则默认使用log4j 实现，如果没有则使用JDK14Logger 实现，再没有则使用commons-logging 内部提供的SimpleLog 实现。

从上述加载流程来看，如果没有做任何配置，只要引入了log4j 并在classpath 配置了log4j.xml ，则commons-logging 就会使log4j 使用正常，而代码里不需要依赖任何log4j 的代码。

**2.Commons-logging+log4j+slf4j**

如果在原有commons-logging 系统里，如果要迁移到slf4j, 使用slf4j 替换commons-logging ，也是可以做到的。原理使用到了上述commons-logging 加载的第二点。需要引入Org.slf4j.jcl-over-slf4j-1.5.6.jar 。这个jar 包提供了一个桥接，让底层实现是基于slf4j 。原理是在该jar 包里存放了配置META-INF/services/org.apache.commons.logging.LogFactory =org.apache.commons.logging.impl.SLF4JLogFactory，而commons-logging 在初始化的时候会找到这个serviceId ，并把它作为LogFactory 。

完成桥接后，那么那么简单日志门面SLF4J 内部又是如何来装载合适的log 呢？

原理是SLF4J 会在编译时会绑定import org.slf4j.impl.StaticLoggerBinder; 该类里面实现对具体日志方案的绑定接入。任何一种基于slf4j 的实现都要有一个这个类。如：

org.slf4j.slf4j-log4j12-1.5.6: 提供对 log4j 的一种适配实现。

Org.slf4j.slf4j-simple-1.5.6: 是一种 simple 实现，会将 log 直接打到控制台。

……

那么这个地方就要注意了：如果有任意两个实现slf4j 的包同时出现，那就有可能酿就悲剧，你可能会发现日志不见了、或都打到控制台了。原因是这两个jar 包里都有各自的org.slf4j.impl.StaticLoggerBinder ，编译时候绑定的是哪个是不确定的。这个地方要特别注意！！出现过几次因为这个导致日志错乱的问题。

**3.Slf4j+logback**

Slf4j 和log4j 作者都是同一个人。

Logback 号称在性能各方面有很多优势，也很诱人。

直接使用SLf4j 也很简单：

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class HelloWorld \{  
  public static void main(String\[\] args) \{  
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);  
    logger.info("Hello World");  
  \}  
\}

代码里也看不到任何具体日志实现方案的痕迹。

Logback 没用过，看到过一些诱人介绍。具体大家可以去研究。logback 。

**注意事项**

使用日志配置的时候一定要明白需求，同时避免冲突。

如使用SLF4j 的时候为了避免冲突，一定要保障只有一种实现类jar 包在里面。

当遇到日志错乱等问题时，可以从这几个方面来排查

[https_blog.csdn.net_backbug_article_details_78655664]: https://blog.csdn.net/backbug/article/details/78655664
[SouthEast]: /images/20220508/c6f60cb613d649cabf3242a5a0fb5f97.png
[SouthEast 1]: /images/20220508/9c125610952d4b728f7e6319d2c10e93.png
[SouthEast 2]: /images/20220508/28321ca7437c4a79bdc336d4f0df0cd7.png
[SouthEast 3]: /images/20220508/02dfe3ae6ce14d018f5ec5baf8d02da1.png
[https_blog.csdn.net_zengshunyao_article_details_26145409]: https://blog.csdn.net/zengshunyao/article/details/26145409
[a88174245d4bf56bae170fed847dca43.png]: /images/20220508/d372c6d836d84d909232abc08ea25d70.png