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

Question

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

jju*_*urm 7 java annotations log4j maven maven-assembly-plugin

我对Maven不太熟悉,我昨天开始使用它,但我喜欢它.在我的项目中,我使用Log4j2库进行日志记录,并且由于高级插件(如appender,转换器)的不足,我需要使用自定义插件.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>

Run Code Online (Sandbox Code Playgroud)

Answer 1

lit*_*ezz 7

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

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

祝好运!

Answer 2

And*_*ich 5

Log4j 2问题673中提到了另一种解决方案。使用具有特定转换器的maven shade插件而不是maven组件插件。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>2.4.3</version>
  <configuration>
    <transformers>
      <transformer implementation="com.github.edwgiz.mavenShadePlugin.log4j2CacheTransformer.PluginsCacheFileTransformer" />
    </transformers>
  </configuration>
  <dependencies>
    <dependency>
      <groupId>com.github.edwgiz</groupId>
      <artifactId>maven-shade-plugin.log4j2-cachefile-transformer</artifactId>
      <version>2.6.1</version>
    </dependency>
  </dependencies>
  <executions>
    <execution>
      <id>make-assembly</id>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Run Code Online (Sandbox Code Playgroud)

如果我对它的理解正确，则Transformer通过正确合并所有依赖项和主jar中的Log4j2Plugins.dat来创建Log4j2Plugins.dat文件，即将包括所有插件。

归档时间：	11 年，9 月前
查看次数：	4020 次
最近记录：	9 年，8 月前