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

Question

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

Log4j使用注释处理预加载标记为@plugin的类。据我所知，在log4j的旧版本中，必须在pom.xml中指定附加的插件条目以触发插件处理，或者必须将带有自定义插件的包键入配置文件(https://logging.apache.org/log4j/2.x/manual/configuration.html#ConfigurationSyntax)中的packages属性。但自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组装插件。其目标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成功加载了我的自定义插件的类。然而，还有很多其他错误（出现在这个特定的发行版中）使得程序更加不可用。

添加了我的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依赖项被处理以包含在包中时被覆盖。也许有更好的解决办法，但我还是建议你做下面的一个：

>

不要将依赖项打包到JAR中。只需打包项目，然后在执行时包含类路径上的依赖项。即使你想把所有的东西都打包在一个便携的jar中，这样做至少可以让你确认你的插件是否被覆盖，或者是否有其他的问题。

为您的自定义插件创建一个单独的项目，将其与主项目分开打包，然后将得到的jar作为依赖项包含在内。与选项1一样，确保不在此包中包含log4j jar。一旦您创建了自定义插件jar，您就可以将它与主jar中的其他依赖项一起打包，并且它应该可以很好地工作，因为自定义插件jar将有自己的插件dat文件。

祝你好运！