将 log4j.properties 文件从 Log4j 版本 1 迁移到 2 的合适指南

Posted 2023-02-26

【中文标题】将 log4j.properties 文件从 Log4j 版本 1 迁移到 2 的合适指南

【英文标题】：A suitable guide for migrating log4j.properties files from Log4j version 1 to 2

【发布时间】：2020-12-07 21:48:07

【问题描述】：

我目前正在开发一个专门使用 log4j 版本 1 的大型项目（因为它是很久以前开发的），我们最近正在考虑迁移到 log4j 版本 2。虽然我已经替换了很多代码引用并添加了依赖项，该项目使用了几十个 log4j.properties 文件形式的自定义配置文件。

我只是想知道是否有详细说明如何在 log4j.properties 和 log4j2.properties 之间转换的指南，因为似乎属性文件格式仍在使用中。由于该项目涵盖了各种各样的属性，因此我们希望避免尝试转换为 xml 格式，因为我们之前没有使用过它。

【参考方案1】：

不，没有指南告诉您如何在 Log4j 1 属性和 Log4j 2 属性之间进行转换。这实际上会相当复杂，因为它必须完成两件事：

描述 Log4j 2 属性的语法以及它与 Log4j 1 属性的区别。 描述 ConsoleAppender、RollingFileAppender 等各种元素之间的配置差异。

Log4j configuration guide 确实提供了属性语法的概述，尽管它可以使用一些更详细的解释。

说实话，我拒绝使用属性来实现配置，因为配置在 Log4j 2 中的工作方式非常不同。无论使用什么配置语法，配置都会转换为节点定义的层次结构，每个定义都包含键/值属性。就其性质而言，属性文件不是分层的。要模拟您必须创建属性名称，其中元素以点表示法表示。例如，appender.console 表示这是控制台附加程序的配置，所有以它开头的字段都是属性或子节点。当定义像 RollingFileAppender 这样的东西时，这变得非常麻烦（IMO）。在您拥有的属性中：

appender.rolling.type = RollingFile
appender.rolling.name = RollingFile
appender.rolling.fileName = $filename
appender.rolling.filePattern = target/rolling2/test1-%dMM-dd-yy-HH-mm-ss-%i.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d %p %C1. [%t] %m%n
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 2
appender.rolling.policies.time.modulate = true
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.rolling.policies.size.size=100MB
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.max = 5

vs 对应的 XML

<RollingFile name="RollingFile" fileName="$filename" filePattern="target/rolling2/test1-%dMM-dd-yy-HH-mm-ss-%i.log.gz">
  <PatternLayout pattern="%d %p %C1. [%t] %m%n"/>
  <Policies>
    <TimeBasedTriggeringPolicy interval="2" modulate="true" />
    <SizeBasedTriggeringPolicy size="100MB" />
  </Policies>
  <DefaultRolloverStrategy max="5"/>
</RollingFile>

同样，YAML 和 JSON 本质上是分层的，因此也是配置的不错选择。在 JSON 中，这将是：

"RollingFile": 
  "name": "RollingFile,
  "fileName": "$filename",
  "filePattern": "target/rolling2/test1-%dMM-dd-yy-HH-mm-ss-%i.log.gz",
  "PatternLayout": 
    "Pattern": "%d %p %C1. [%t] %m%n"
  ,
  "Policies": 
    "TimeBasedTriggeringPolicy": 
      "interval": 2,
      "modulate": true,
    ,
    "SizeBasedTriggeringPolicy": 
      "size": "100MB"
    
  

但是您会注意到，即使在这里，XML 占用的空间也比 JSON 少。这主要是因为在 XML 中，属性既可以表示为元素上的属性，也可以表示为子元素。如果在 XML 示例中使用了子元素，它的大小将与 JSON 示例基本相同。

也就是说，如果您将此处显示的属性语法与相应的 XML 或 JSON 进行比较，它应该会提供有关您必须为其他元素做什么的指导。