log4j配置文件加载逻辑调试方法

Posted 解析与重构

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了log4j配置文件加载逻辑调试方法相关的知识,希望对你有一定的参考价值。

使用Spark开发弹性计算框架时,由于Scala语言对Spark的原生支持比较好,所以一般会采用Scala编写代码。

Scala底层使用的还是JVM虚拟机,和Java本身是共通的,所以Log4J原则上肯定是可以兼容Scala应用。

Log4J框架使用配置文件进行日志系统的初始化,由于引入的各类jar包都有可能会包含Log4J的配置文件,首次配置起来会比较痛苦。

下面备注下Log4J框架该如何找到实际生效的配置文件。

1. 包依赖

主要是如下三个包,log4j-api-scalalog4jscala环境下使用的桥接包,log4j-api是应用接入框架的接口定义,log4j-core是框架核心功能包。

[INFO] +- org.apache.logging.log4j:log4j-api-scala_2.12:jar:11.0:compile
[INFO] +- org.apache.logging.log4j:log4j-api:jar:2.11.2:compile
[INFO] +- org.apache.logging.log4j:log4j-core:jar:2.11.2:compile

2. 初始化堆栈

在应用初始化时,最终会顺着Logger -> Logging -> LoggerManager -> Log4JContextFactory -> LoggerContext -> ConfigurationFactory -> ConfigurationFactory$Factory的调用链,最终触发对ConfigurationFactory$Factory.getConfiguration方法的调用。

  • Logger:具体的业务Logger类,在实际的业务代码中
  • LoggingScalatrait类型,jar -> log4j-api-scala
  • LoggerManager:jar -> log4j-api
  • Log4JContextFactory:jar -> log4j-core
  • LoggerContext:jar -> log4j-core
  • ConfigurationFactory:jar -> log4j-core

从调用链看,查找配置文件的核心逻辑在log4j-core包中。

3. 调用方法

逻辑:

  • 查找带 contextName(指的是: name)的测试类型的配置文件
  • 没有则查找不带 contextName的测试类型的配置文件
  • 还没有则查找带 contextName的非测试类型的配置文件
  • 最后再查找不带 contextName的非测试类型的配置文件

4. 调试断点

  • 类名称: ConfigurationFactory$Factory
  • 方法签名: Configuration getConfiguration(loggerContext, isTest, name)
  • 代码段: log4j-core的2.11.2版本在449行, configName就是框架尝试加载的配置文件名称,比如log4j.properties这种。
for (final String suffix : types) {
    if (suffix.equals(ALL_TYPES)) {
        continue;
    }
    configName = named ? prefix + name + suffix : prefix + suffix;

    final ConfigurationSource source = ConfigurationSource.fromResource(configName, loader);
    if (source != null) {
        if (!factory.isActive()) {
            LOGGER.warn("Found configuration file {} for inactive ConfigurationFactory {}", configName, factory.getClass().getName());
        }
        return factory.getConfiguration(loggerContext, source);
    }
}

5. 结论

经过debug后确认,在/resources目录下放置log4j.properties文件不生效的原因,是因为配置文件名称是log4j2.properties文件,所以框架根本就没有尝试加载log4j.properties文件。


以上是关于log4j配置文件加载逻辑调试方法的主要内容,如果未能解决你的问题,请参考以下文章

log4j配置

不需要配置log4j , 调试打印ibatis执行的sql语句和参数

log4j.properties 的作用是啥?求详解

log4j配置文件加载

log4j默认加载的配置文件

springboot 关于log4j日志配置