log4j2 配置不会加载自定义模式转换器

Question

我正在尝试为 log4j 2.0 创建自定义模式转换器，但在让我的 log4j 配置识别模式时遇到问题。这是自定义转换器：

package com.test.log4j.plugins;

import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.pattern.ConverterKeys;
import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;

@Plugin(name="MarkerNamePatternConverter", category="Converter")
@ConverterKeys({"markername"})
public class MarkerNamePatternConverter extends LogEventPatternConverter {

    public static MarkerNamePatternConverter newInstance(final String[] options) {
        return new MarkerNamePatternConverter("markername", "markername");
    }

    protected MarkerNamePatternConverter(String name, String style) {
        super(name, style);
    }

    @Override
    public void format(LogEvent event, StringBuilder toAppendTo) {
        Marker marker = event.getMarker();
        if (marker != null) {
            // MarkerPatternConverter appends Marker.toString()
            // which includes the parents of the marker.  We just
            // want the marker's name
            toAppendTo.append(marker.getName());
        }
    }
}

这是我的 log4j 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="trace" packages="com.test.log4j.plugins">
  <Appenders>
    <Console name="console" target="SYSTEM_OUT">
      <PatternLayout pattern=" %-6level %markername  %d{YYYY-MM-dd HH:mm:ss}  %msg%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="debug">
      <AppenderRef ref="console"/>
    </Root>
  </Loggers>
</Configuration>

请注意，我在我的配置中包含了包含自定义转换器的包，缺少它似乎是使用自定义插件时出现问题的常见原因。

执行测试代码时，配置状态输出并不表示插件已加载或找到，log4j 将 %markername 视为“%marker”后跟“name”的转换模式。例如，

Marker marker = MarkerManager.getMarker("TEST");
log.info(marker, "test message");

产生以下输出：

INFO   TESTname  2014-07-23 14:47:57  test message

我尝试将转换键更改为不是以标准转换模式开头的值，例如“fmarker”，并且在执行 log4j 时会产生以下错误：

2014-07-23 14:44:55,814 ERROR Unrecognized format specifier [fmarker]
2014-07-23 14:44:55,816 ERROR Unrecognized conversion specifier [fmarker] starting at     position 18 in conversion pattern.
INFO   %fmarker  2014-07-23 14:44:55  test message

文档表明插件是在构建时而不是运行时收集的，但我没有发现任何表明我需要做一些特定的事情才能找到我的自定义转换器的东西，而不是：

1. 使用 @Plugin 和 @ConverterKeys 对其进行注释
2. 将插件的类别指定为“转换器”
3. 包含一个静态的“newInstance(String[])”方法
4. 实现“格式”方法
5. 使用配置的“packages”参数指定插件包。

有一个 Maven 插件的文档，但我的简单测试只是一个在 Eclipse 中开发的基本 Java 项目。

关于我做错了什么的任何想法？

Answer 1

长话短说，从 2.0-rc2 版本开始，packages 属性不再起作用。相反，log4j-core 中有一个注释处理器，它将（应该？）在构建期间运行，并为 jar 文件中的自定义插件生成元数据文件。当 log4j2 启动时，它将在所有 jar 文件中查找元数据文件并快速发现所有可用的插件。

注释处理器在使用 Maven 或普通 javac 编译时可以正常工作，但在 Eclipse 中编译时可能无法正常工作。您需要通过右键单击项目 > 属性 > Java 编译器 > 注释处理来启用注释处理。

不过，我并不能 100% 确定这在 Eclipse 中是否有效。目前，一种替代方法是使用 Maven 构建自定义插件。

我将尝试在即将发布的版本中使 packages 属性再次发挥作用。

此问题在此处跟踪：https ://issues.apache.org/jira/browse/LOG4J2-741

更新（7/28）这已在主干中修复，并将包含在 2.0.1 版本中。