多模块 Maven 项目中的 log4j 配置文件

Question

我正在做一个多模块Maven项目，其结构是这样的：

war-module
jar-module

war模块依赖于jar模块，并且打包后会将jar工件添加到webapp的lib目录中。

并且war-module和jar-module都使用Apache log4j进行日志记录，并共享相同的log4j配置文件（log4j.xml），目前该文件位于jar-module项目中。而这个log4j.xml会被打包成jar-module.jar文件，但是我想把它放到war包中的WEB-INF/classes目录中而不是jar文件中，这样用户就很容易找到这个配置文件并在必要时修改它（如果该文件位于 WEB-INF/lib/jar-module.jar 中，他们很难找到它，因为该目录下还有许多其他 jars）。

我的问题是：Maven解决这个问题的方法是什么？

更新：

我的真实项目有点复杂，并且有一个ear-module也依赖于jar-module（又名。jar-module可以在多个不同的项目中独立使用，并且我不能只是将文件放入 war-module/src/main/resources 目录来解决这个问题）。我不想在多个项目中重复一些配置文件，例如 log4j.xml（以及其他配置文件，例如 myapp.properties）。

Answer 1

我通过在网络上进行更多搜索找到了答案。

一般来说，多模块Maven项目中共享资源的方式有以下三种：

• 剪切并粘贴它们。
• 使用程序集和依赖项插件
• 使用 maven-remote-resources-plugin

这是 Maven 背后的公司 Sonatype 的一篇博客文章，内容涉及在 Maven 中跨项目共享资源，这正是我需要的答案：

http://www.sonatype.com/people/2008 /04/如何在maven中跨项目共享资源/

Answer 2

在 jar 模块中，从 jar 中排除该文件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.3.1</version>
    <configuration>
      <excludes>
        <exclude>log4j.xml</exclude>
      </excludes>
    </configuration>
</plugin>

使用 buildhelper 插件将 log4j.xml 作为单独的工件附加到构建中

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <version>1.5</version>
    <executions>
      <execution>
        <id>attach-artifacts</id>
        <phase>package</phase>
        <goals>
          <goal>attach-artifact</goal>
        </goals>
        <configuration>
          <artifacts>
            <artifact>
              <file>${project.build.outputDirectory}/log4j.xml</file>
              <type>xml</type>
              <classifier>log4j</classifier>
            </artifact>
          </artifacts>
        </configuration>
      </execution>
    </executions>
</plugin>

现在在您的 war 工件中，将 xml 复制到输出目录：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
      <execution>
        <id>copy</id>
        <phase>prepare-package</phase>
        <goals>
          <goal>copy</goal>
        </goals>
        <configuration>
          <artifactItems>
            <artifactItem>
              <groupId>${project.groupId}</groupId>
              <artifactId>your.jar.project.artifactId</artifactId>
              <version>${project.version}</version>
              <type>xml</type>
              <classifier>log4j</classifier>
              <outputDirectory>${project.build.outputDirectory}
              </outputDirectory>
              <destFileName>log4j.xml</destFileName>
            </artifactItem>
          </artifactItems>
        </configuration>
      </execution>
    </executions>
</plugin>

当然，这会更容易首先将文件放在 [web-artifact]/src/main/resources 中:-)

Answer 3

根据我的经验，这可以通过一种简单的方式实现，只需：

1. 在父模块中创建 log4j 配置资源。
2. 在所有pom模块中调用log4j的依赖。

详细步骤：

1. 使用 common-config 创建项目
2. 在 src/main/resources 文件夹中放入 log4j 或 logback 配置文件
3. 在本地 Maven 存储库中安装工件以供其他项目使用
4. 在后续添加依赖作为普通 Maven 依赖 。

<dependency> 
  <groupId>com.your.group.id</groupId> 
  <artifactId>common-config</artifactId> 
  <scope>provided</scope> 
</dependency>

我更喜欢使用提供的范围并在运行时从类路径配置文件夹中提供文件