jdk-logging log4j1 log4j2 logback 日志框架介绍

最新推荐文章于 2022-06-28 11:25:36 发布
最新推荐文章于 2022-06-28 11:25:36 发布
阅读量982 收藏
点赞数
分类专栏： Spring 文章标签： java 框架 log4j
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jeikerxiao/article/details/62417352
版权

1. 日志框架

目前的日志框架有：

  1. jdk-logging
  2. log4j1
  3. log4j2
  4. logback

用于实现日志统一的框架有：

  1. commons-logging
  2. slf4j

1. jdk-logging

使用方法

1.Demo

package com.jeiker.demo.controller;

import java.util.logging.Logger;

/**
 * @Author : xiao
 * @Date : 17/3/15 下午7:47
 */
public class JdkTest {

    private static final Logger logger = Logger.getLogger(JdkTest.class.getName());

    public static void main(String[] args){
        logger.info("jdk logging info: a msg");
    }
}

简单分析

(可跳过)

1.创建LogManager

默认是java.util.logging.LogManager，但是也可以自定义。

源码如下（manager就是LogManager）：

try {

   cname = System.getProperty("java.util.logging.manager");
   if (cname != null) {
       try {
           Class clz = ClassLoader.getSystemClassLoader().loadClass(cname);
           manager = (LogManager) clz.newInstance();
       } catch (ClassNotFoundException ex) {
           Class clz = Thread.currentThread().getContextClassLoader().loadClass(cname);
           manager = (LogManager) clz.newInstance();
       }
   }
} catch (Exception ex) {

   System.err.println("Could not load Logmanager \"" + cname + "\"");
   ex.printStackTrace();
} if (manager == null) {

   manager = new LogManager();
}

2.加载配置文件

默认是jre目录下的lib/logging.properties文件，也可以自定义修改系统属性”java.util.logging.config.file”。

源码如下：

String fname = System.getProperty("java.util.logging.config.file");

if (fname == null) {

    fname = System.getProperty("java.home");
    if (fname == null) {
        throw new Error("Can't find java.home ??");
    }
    File f = new File(fname, "lib");
    f = new File(f, "logging.properties");
    fname = f.getCanonicalPath();
}

InputStream in = new FileInputStream(fname);
BufferedInputStream bin = new BufferedInputStream(in);

try {

    readConfiguration(bin);
}catch (Exception ex){

}

3.创建Logger

创建Logger，并缓存起来，放置到一个Hashtable中,并把LogManager设置进新创建的logger中。

2. log4j1

使用方法

1.pom文件增加依赖

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

依赖的jar包：

  1. log4j-1.2.17.jar

2.配置文件 ：log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>

    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
        </layout>
    </appender>

    <root>
        <appender-ref ref="STDOUT" />
    </root>

</log4j:configuration>

3.Demo

package com.jeiker.demo.controller;

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

/**
 * @Author : xiao
 * @Date : 17/3/15 下午7:29
 */
public class Log4jTest {

    private static final Logger logger = LogManager.getLogger(Log4jTest.class);

    public static void main(String[] args){

        if(logger.isTraceEnabled()){
            logger.debug("log4j trace message");
        }

        if(logger.isDebugEnabled()){
            logger.debug("log4j debug message");
        }

        if(logger.isInfoEnabled()){
            logger.debug("log4j info message");
        }
    }
}

简单分析

(可跳过)

简单的说明获取一个Logger的过程。

分三种情况来说明：

（一）没有指定配置文件路径

  1. 引发LogManager的类初始化

    Logger.getLogger(Log4jTest.class)的源码如下：

    static public Logger getLogger(Class clazz) {

  return LogManager.getLogger(clazz.getName());
}

  2. 初始化一个logger仓库Hierarchy

    Hierarchy的源码如下：

    public class Hierarchy implements LoggerRepository, RendererSupport, ThrowableRendererSupport {

    private LoggerFactory defaultFactory；
    Hashtable ht;
    Logger root;
    //其他略
}
    • LoggerFactory defaultFactory： 就是创建Logger的工厂
    • Hashtable ht：用来存放上述工厂创建的Logger
    • Logger root：作为根Logger

  3. 在LogManager的类初始化的过程中默认寻找类路径下的配置文件

    • 通过org.apache.log4j.helpers.Loader类来加载类路径下的配置文件：
    Loader.getResource("log4j.xml");

Loader.getResource("log4j.properties")
    • 优先选择xml配置文件

  4. 解析上述配置文件

    • 如果是xml文件则org.apache.log4j.xml.DOMConfigurator类来解析

    • 如果是properties文件，则使用org.apache.log4j.PropertyConfigurator来解析

    不再详细说明解析过程，看下解析后的结果：

    • 设置RootLogger的级别

    • 对RootLogger添加一系列我们配置的appender（我们通过logger来输出日志，通过logger中的appender指明了日志的输出目的地）

  5. 获取Logger

    使用logger仓库Hierarchy中内置的LoggerFactory工厂来创建Logger了，并缓存起来，同时将logger仓库Hierarchy设置进新创建的Logger中。

（二）手动加载不在路径下的配置文件

PropertyConfigurator.configure 执行时会去进行上述的配置文件解析。

源码如下：

public static void configure(java.net.URL configURL) {

    new PropertyConfigurator().doConfigure(configURL, LogManager.getLoggerRepository());
}

  1. 仍然先会引发LogManager的类加载，创建出logger仓库Hierarchy，同时尝试加载类路径下的配置文件，此时没有则不进行解析，此时logger仓库Hierarchy中的RootLogger默认采用debug级别，没有appender而已。

  2. 然后解析配置文件，对上述logger仓库Hierarchy的RootLogger进行级别的设置，添加appender

  3. 此时再去调用Logger.getLogger，不会导致LogManager的类初始化（因为已经加载过了）

（三）配置文件在类路径下，而我们又手动使用PropertyConfigurator去加载

也就会造成2次加载解析配置文件，仅仅会造成覆盖而已（对于RootLogger进行从新设置级别，删除原有的appender，重新加载新的appender），所以多次加载解析配置文件以最后一次为准。

3. log4j2

使用方法

1.pom文件增加依赖：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.8.1</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.8.1</version>
</dependency>

依赖的jar包：

  1. log4j-api-2.8.1.jar

  2. log4j-core-2.8.2.jar

    • log4j-api： 作为日志接口层，用于统一底层日志系统
    • log4j-core : 作为上述日志接口的实现，是一个实际的日志框架

2.配置文件: log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>

    <Loggers>
        <Root level="debug">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>

</Configuration>

3.Demo

package com.jeiker.demo.controller;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 * @Author : xiao
 * @Date : 17/3/15 下午7:29
 */
public class Log4j2Test {

    private static final Logger logger= LogManager.getLogger(Log4j2Test.class);

    public static void main(String[] args){

        if(logger.isTraceEnabled()){
            logger.debug("log4j2 trace message");
        }
        if(logger.isDebugEnabled()){
            logger.debug("log4j2 debug message");
        }
        if(logger.isInfoEnabled()){
            logger.debug("log4j2 info message");
        }
    }
}

简单分析

(可跳过)

1. 获取底层使用的LoggerContextFactory

同样LogManager的类加载会去寻找log4j-api定义的LoggerContextFactory接口的底层实现，获取方式有三种：

  • 第一种： 尝试从jar中寻找log4j2.component.properties文件，如果配置了log4j2.loggerContextFactory则使用该LoggerContextFactory

  • 第二种：如果没找到，尝试从jar包中寻找META-INF/log4j-provider.properties文件，如log4j-core-2.2中就有该文件

    如果找到多个，取优先级最高的（该文件中指定了LoggerContextFactory，同时指定了优先级FactoryPriority），如log4j-core-2.2中log4j-provider.properties的文件内容如下：

    LoggerContextFactory = org.apache.logging.log4j.core.impl.Log4jContextFactory 
Log4jAPIVersion = 2.1.0 
FactoryPriority= 10

  • 第三种情况：上述方式还没找到，就使用默认的SimpleLoggerContextFactory

2.使用LoggerContextFactory获取LoggerContext

3.根据LoggerContext获取Logger

以log4j-core为例：

  1. 会首先判断LoggerContext是否被初始化过了，没有则进行初始化
  2. 获取ConfigurationFactory,从配置中获取和插件中获取（log4j-core核心包中有三个YamlConfigurationFactory、JsonConfigurationFactory、XmlConfigurationFactory）
  3. 以上文的案例中，会使用XmlConfigurationFactory来加载log4j2.xml配置文件
  4. LoggerContext初始化后，就可以获取或者创建Logger了

Log4J2 主要对象总结

  • LogManager

    它的类加载会去寻找LoggerContextFactory接口的底层实现，会从jar包中的配置文件中寻找，如上面所述

  • LoggerContextFactory

    用于创建LoggerContext，不同的日志实现系统会有不同的实现，如log4j-core中的实现为Log4jContextFactory

  • PropertyConfigurator

    用于解析log4j.properties文件

  • LoggerContext

    它包含了配置信息，并能创建log4j-api定义的Logger接口实例，并缓存这些实例

  • ConfigurationFactory

    上述LoggerContext解析配置文件，需要用到ConfigurationFactory，目前有三个YamlConfigurationFactory、JsonConfigurationFactory、XmlConfigurationFactory，分别解析yuml json xml形式的配置文件

4. logback

使用方法

1.pom文件增加依赖：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.1</version>
</dependency>

依赖的jar包：

  1. slf4j-api-1.7.22.jar
  2. logback-classic-1.2.1.jar
  3. logback-core-1.2.1.jar

2.配置文件：logback.xml

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

3.Demo:

package com.jeiker.demo.controller;

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

/**
 * @Author : xiao
 * @Date : 17/3/15 下午7:29
 */
public class LogbackTest {

    private static final Logger logger = LoggerFactory.getLogger(LogbackTest.class);

    public static void main(String[] args){
        if(logger.isDebugEnabled()){
            logger.debug("slf4j-logback debug message");
        }
        if(logger.isInfoEnabled()){
            logger.debug("slf4j-logback info message");
        }
        if(logger.isTraceEnabled()){
            logger.debug("slf4j-logback trace message");
        }
    }
}

简单分析

(可跳过)

  • 官方使用方式，slf4j的原生实现，其实就和slf4j集成了起来。

  • 上述的Logger、LoggerFactory都是slf4j自己的接口与类。

  • 没有配置文件的情况下，使用的是默认配置。

1.slf4j与底层的日志系统进行绑定

在jar包中寻找org/slf4j/impl/StaticLoggerBinder.class 这个类，如在logback-classic中就含有这个类。

如果找到多个StaticLoggerBinder，则表明目前底层有多个实际的日志框架，slf4j会随机选择一个。

2.使用上述找到的StaticLoggerBinder创建一个实例，并返回一个ILoggerFactory实例

return StaticLoggerBinder.getSingleton().getLoggerFactory()；

以logback-classic中的StaticLoggerBinder为例，在StaticLoggerBinder.getSingleton()过程中,会去加载解析配置文件.

源码如下：

public URL findURLOfDefaultConfigurationFile(boolean updateStatus) {

   ClassLoader myClassLoader = Loader.getClassLoaderOfObject(this);

   //寻找logback.configurationFile的系统属性
   URL url = findConfigFileURLFromSystemProperties(myClassLoader, updateStatus);
   if (url != null) {
     return url;
   }

   //寻找logback.groovy
   url = getResource(GROOVY_AUTOCONFIG_FILE, myClassLoader, updateStatus);
   if (url != null) {
     return url;
   }

   //寻找logback-test.xml
   url = getResource(TEST_AUTOCONFIG_FILE, myClassLoader, updateStatus);
   if (url != null) {
     return url;
   }

   //寻找logback.xml
   return getResource(AUTOCONFIG_FILE, myClassLoader, updateStatus);
}

目前路径都是定死的，只有logback.configurationFile的系统属性是可以更改的，所以如果我们想更改配置文件的位置（不想放在类路径下），则需要设置这个系统属性：

System.setProperty("logback.configurationFile", "/path/to/config.xml");

解析完配置文件后，返回的ILoggerFactory实例的类型是LoggerContext（它包含了配置信息）

3.根据返回的ILoggerFactory实例，来获取Logger

就是根据上述的LoggerContext来创建一个Logger，每个logger与LoggerContext建立了关系，并放到LoggerContext的缓存中，就是LoggerContext的如下属性：

private Map<String, Logger> loggerCache;

其实上述过程就是slf4j与其他日志系统的绑定过程。不同的日志系统与slf4j集成，都会有一个StaticLoggerBinder类，并会拥有一个ILoggerFactory的实现。

jeikerxiao
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springmvc log4j2 logback 注解 jackson 日志脱敏实现源码
12-30
几乎是网上 能找到的 日志脱敏的所有实现 1、基于正则表达式的 日志脱敏实现 ，扩展logback 、log4j 2、springmvc 返回报文脱敏。 3、基于注解方式的脱敏。 大家选择使用。
【硬核】Log4j2 与 Logback 当初的选型以及在当前云原生环境下的反思与展望
hashcon
02-20 683
log4j2.xml配置：关闭输出代码位置（RingBuffer 满了的策略，以及增加对于 RingBuffer 的 metric 监控与暂时下线的机制通过批量 flush 进一步提高吞吐量（配置 Disruptor 的等待策略为 SLEEP，但是最好能将其中的 Thread.yield 修改为 Thread.onSpinWait (这个修改仅针对 x86 机器部署)
Logback 对比 Log4j2
热门推荐
qq_19663899的博客
10-31 1万+
Logback 对比 Log4j2 测试分为本地测试端和服务器端,分别对gateway网关进行日志输出的压测 同步日志,不打印日志 logback(150并发,0间隔,循环50次) log4j2(150并发,0间隔,循环50次) 同步日志,打印日志(大小4k,循环输出100次) logback(150并发,0间隔,循环50次) log4j2(150并发,0间隔,循环50次) 异步打...
日志 log4j、log4j2、logback的配置、引用及作用
Burnup_110的博客
08-10 433
一、日志作用 日志用户程序调试、运行、异常处理等，最开始接触程序时需要了解程序运行中各个变量属性的状态，通过System.out进行打印到控制台查看，日志更像是这种方式的抽象版本，他可以打印程序运行时的状态，可以控制是否打印日志，因为打印日志本身是需要消耗程序性能的，所以在程序正式使用的时候只有一些级别较高的日志需要记录打印出来，以免影响使用 二、日志级别 log4j定义了8个级别的log（除去OFF和ALL，可以说分为6个级别），优先级从高到低依次为：OFF、FATAL、ERROR、WARN、INFO、D
log4j log4j2 logback 如何使用
矛头小子的博客
05-01 698
相信每个人的项目都有日志记录的功能，不过采用了什么方式。从System.out.println(),JDK Logger,到Apache commons logging,Apache Log4j,再到slf4j,Logback,Log4j2。你清楚他们的区别吗。本文详细介绍他们的区别和使用。 1.System.out.println() 同步阻塞，日志会打印到控制台，应杜绝在生产环境使用。同样...
日志版本-log4j2版本jar
03-07
log4j的升级版本，包含日志配置文件，要注意的是部分jar包的日志默认是log4j，需要在tomcat、jdk等其他中间件设置默认日志
jdk1.6log4j2.3.zip
05-17
jdk1.6支持的最高版本所有的log4jjar包
log4j-api-2.15.0.jar log4j-2.15.0-rc2
12-10
Apache log4j2零日漏洞，根据 log4j-2.15.0-rc2 版本编译生成log4j-api-2.15.0.jar 1.解压你的jar jar xvf XXX.jar 2. 删除旧版本jar cd ./BOOT-INF/lib rm -rf log4j-api-*.jar 3. 上传新版本log4j-api-...
springboot3.2.4+lombok+log4j2+swagger集成demo
最新发布
04-12
平滑升级相当困难，在用springboot3做新项目时也遇到了很多官方文档不详细的原因，所以特整理了一个干净版本的开发框架，集成了最基础的功能，下载本地后，可以导入到idea中，demo分两个工程：root工程和...
Log4j日志体系结构
02-25
我们在写日志的时候首先要获取logger，在每一个使用log4j的项目都有很多个地方要获取logger，这些logger是真实的被实例化的Logger对象，他们有可能被分散在无数不同的类中，日志体系结构讲的是这些logger对象是如何...
java日志框架之Logback和Log4j2
从基础到源码解析的学习记录
06-27 4498
依赖 导包 日志级别：trace < debug < info < warn < error 默认的日志级别是debug 输出结果：logback默认输出格式 在resources下面，创建一份配置文件，命名为logback.xml 输出结果： 执行两次查看文件输出内容：logback.xml 26日，27日分别执行一次，文件拆分输出结果：当前日志为roll_bogback.log，当日志文件超过100k或者切换日期则会压缩成日期格式gzlogback.xml 输出结果： additi
【Log】（三）Java 中的日志框架 logback、log4j2
sco5282的博客
12-06 1677
1. logback 学习 1.1 logback 介绍 logback 是由 log4j 创始人设计的另一个开源日志组件，性能比 log4j 好 logback 主要分为 3 个模块： logback-core：其它两个模块的基础模块 logback-classic：它是 log4j 的一个改良版本，同时它完整实现了 slf4j API logback-access：访问模块与 Servlet
Java日志，需要知道的几件事(commons-logging,log4j,slf4j,logback)
kobejayandy的专栏
12-15 9635
如果对于commons-loging、log4j、slf4j、LogBack等都已经非常清楚了，可以忽略本文。几次解决日志冲突问题时对这几个概念的简单总结，希望对这块基础没有理解透的同学能有所帮助，当然如果对这块有更深刻理解的同学，也贡献出自己的知识和见解。 一、    概念 Commons-logging:apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC的a
Log4j2 / Logback - 日志框架
mcgrady1234的博客
01-27 344
日志框架 1. 概述 一套能实现日志输出的工具包 ; System.out ? 1). 代码侵入性高, 一旦编写的输出语句 , 该语句会一直输出 , 直到被删除/注释 ; 2). 输出的信息不详细 , 传递什么内容, 就输出什么内容 ; 3). 功能单一 , 只能是往控制台输出 ; 2. 主流日志框架 日志框架具有的能力 : 1). 定制输出目标 2). 运行时选择性输出 3). 定制输出格式 4). 灵活的配置 5). 携带上下文信息
【日志问题】JDK Logging、Commons Logging和Log4j、Slf4j和Logbacck的介绍和简单使用
风吹海洋浪的博客
02-21 396
【日志问题】JDK Logging、Commons Logging和Log4j、Slf4j和Logbacck的介绍和简单使用是什么简介如何使用log4j +slf4j1.导入依赖2.配置文件log4j.rootCategory = [ level ] , appenderName, appenderName配置日志信息输出目的地AppenderAppender的一些选项3.使用方式 是什么 产生原因： 因为System.out.println()使用起来太麻烦，需要删除和添加 什么是日志？日志就是Loggi
Log4j,Log4j2,logback,slf4j日志框架比较
li___jun的博客
06-28 1374
Log4j,Log4j2,logback,slf4j日志框架比较
log4j、log4j2和logback学习
weixin_36098377的博客
08-03 113
log4j： log4j的配置详解： https://www.cnblogs.com/imsoft/p/log4j.html 不重复输出log： https://blog.csdn.net/ygd266/article/details/51967491 教程：https://blog.csdn.net/andyzhaojianhui/article/category/2781525/2?...
logback log4j log4j2 性能实测
justlpf的专栏
12-26 921
https://blog.csdn.net/yjh1271845364/article/details/70888262
被LOG4J2影响的JDK版本
05-25
目前，由于Log4j 2的漏洞，建议升级至 JDK 8u311、JDK 11.0.13、JDK 16.0.2 或 JDK 17.0.1。这些版本已经包含了修复此漏洞的补丁。如果您无法升级到这些版本，建议在生产环境中使用Log4j 2.15.0或更高版本，并配置...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值