Log4j2自定义插件-使用Maven组件插件进行注释处理

Question

我对Maven不太熟悉，我昨天才开始使用它，但是我喜欢它。在我的项目中，我使用 Log4j2
库进行日志记录，并且由于高级插件（如追加程序，转换器）的不足， 我需要使用自定义插件
。log4j-api和log4j-core（还有许多其他库）作为依赖项添加到与我的项目关联的 pom.xml
中。实际上，我正在使用Log4j的2.0版。

Log4j使用注释处理来预加载标记为的类@Plugin。据我所知，在较旧的log4j版本中，必须在 pom.xml中
指定其他插件条目以触​​发插件处理，或者必须将带有自定义插件的软件包键入packages配置文件中的属性（https：//
logging.apache.org/log4j/2.x/manual/configuration.html#ConfigurationSyntax）。但是从2.0-rc2开始不支持此功能。

在v2.0中，只要log4j-core构建引擎可用，它应该自动完成。在 myproject-0.0.1-SNAPSHOT.jar / META-INF
/ org / apache / logging / log4j / core / config / plugins / 中有一个文件
Log4j2Plugins.dat ，其中包含我的自定义插件的映射-可以。 __

为了使用Maven进行构建，我还使用了Maven Assembly
Plugin。其目标single与package阶段绑定。打包项目后，我自然会在 目标 目录中再添加一个jar -
myproject-0.0.1-SNAPSHOT-jar-with-dependencies.jar 。但是，此jar中的
Log4j2Plugins.dat
文件包含原始插件的映射，与log4j-core库中的文件相同。这就是问题所在，因为它不包含对我的自定义插件的任何引用。看来
myproject-0.0.1-SNAPSHOT.jar 中的文件已被log4j库中的原始文件覆盖，但我不确定情况如何。

因此，当我运行 myproject-0.0.1-SNAPSHOT-jar-with-dependencies.jar时
，log4j从我的项目中找不到插件类。我认为 myproject-0.0.1-SNAPSHOT.jar 可以正常运行，但没有依赖项我就无法运行。

packages应该在2.0.1版本中重新启用配置中的属性，但是如果我不想等待版本发布，则必须使用注释处理方法。

您有解决办法吗？

我尝试使用log4j的 2.0-rc1 版运行它，其中packages配置元素的属性可用。结果是： log4j成功加载了 我的自定义插件
的类 。但是，还有许多其他错误（在此特定发行版中出现）使该程序更加无法使用。

这是一个优点，可以确保如果packages在下一版本2.0.1中启用该属性，则我的插件 可以
正常工作。应该根据此问题跟踪将其恢复：https :
//issues.apache.org/jira/browse/LOG4J2-741

添加了我的 pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.jjurm</groupId>
  <artifactId>twbot</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>twbot</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.1</version>
          <configuration>
            <source>1.7</source>
            <target>1.7</target>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.4</version>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
          <archive>
            <manifest>
              <mainClass>com.jjurm.twbot.system.Run</mainClass>
            </manifest>
          </archive>
        </configuration>
        <executions>
          <execution>
            <id>make-assembly</id> <!-- this is used for inheritance merges -->
            <phase>package</phase> <!-- bind to the packaging phase -->
            <goals>
              <goal>single</goal>
            </goals>
            <configuration>
              <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
              </descriptorRefs>
              <archive>
                <manifest>
                  <mainClass>com.jjurm.twbot.system.Run</mainClass>
                </manifest>
              </archive>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.mariadb.jdbc</groupId>
        <artifactId>mariadb-java-client</artifactId>
        <version>1.1.7</version>
    </dependency>
    <dependency>
        <groupId>joda-time</groupId>
        <artifactId>joda-time</artifactId>
        <version>2.3</version>
    </dependency>
    <dependency>
        <groupId>commons-configuration</groupId>
        <artifactId>commons-configuration</artifactId>
        <version>1.10</version>
    </dependency>
    <dependency>
        <groupId>net.snaq</groupId>
        <artifactId>dbpool</artifactId>
        <version>6.0</version>
    </dependency>
    <dependency>
        <groupId>org.fusesource.jansi</groupId>
        <artifactId>jansi</artifactId>
        <version>1.11</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.0</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.0</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.7</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.0</version>
    </dependency>
    <dependency>
        <groupId>commons-jxpath</groupId>
        <artifactId>commons-jxpath</artifactId>
        <version>1.3</version>
    </dependency>
    <dependency>
        <groupId>net.sourceforge.htmlunit</groupId>
        <artifactId>htmlunit</artifactId>
        <version>2.15</version>
    </dependency>
  </dependencies>
</project>

Answer 1

我认为问题源于将依赖项打包到jar中。快速浏览一下代码，看起来插件处理器会覆盖其处理的每组插件的dat文件。我的猜测是，在打包过程中，将处理您的自定义插件并将其写入dat文件，然后在处理log4j依赖项以将其包含在包中时将其覆盖。可能有更好的解决方案，但是我不建议您执行以下操作之一：

1. 不要将依赖项打包到jar中。只需打包您的项目，然后在执行时在类路径中包括依赖项。即使您希望将所有内容打包在一个便携式jar中，执行此操作也可以让您至少确认您的插件是否被覆盖，或者是否存在其他问题。

2. 为您的自定义插件创建一个单独的项目，将其与主项目分开打包，然后将生成的jar作为依赖项。与选项1一样，请确保在此软件包中不包括log4j jar。一旦创建了自定义插件jar，就可以将其与其他依赖项一起打包在主jar中，由于自定义插件jar将具有自己的插件dat文件，因此可以正常工作。

祝好运！