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

我对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 绑定(bind)到 package 阶段。打包项目后，我自然会在 target 目录中多一个 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 可以正常运行，但没有依赖项我无法运行它。

configuration中的packages属性应该在2.0.1版本重新启用，但如果不想等到release，就得用注解处理的方式。

你知道如何解决它吗？

我尝试使用 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>

最佳答案

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

不要将依赖项打包到您的 jar 中。只需打包您的项目，然后在执行时将依赖项包含在您的类路径中。即使您想将所有内容打包到一个可移植 jar 中，这样做至少可以让您确认您的插件是否被覆盖，或者是否存在其他问题。
为您的自定义插件创建一个单独的项目，将其与主项目分开打包，然后将生成的 jar 作为依赖项包含在内。与选项 1 一样，请确保您不在此包中包含 log4j jar。创建自定义插件 jar 后，您可以将它与主 jar 中的其他依赖项一起打包，它应该可以正常工作，因为您的自定义插件 jar 将有自己的插件 dat 文件。

祝你好运!

关于java - Log4j2 自定义插件 - 使用 Maven Assembly Plugin 进行注释处理，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/25065580/

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

上一篇：java - javac 命令是否自动创建包声明中指定的目录？

下一篇：java - Mockito/Powermockito 模拟私有(private)无效方法