Log4j конфигурационный файл в мультимодульном проекте Maven

Я работаю над многомодульным проектом Maven, структура которого выглядит так:

war-module
jar-module

Военный модуль зависит от jar-модуля и добавит артефакт jar в каталог webapp lib после упаковки.

И как военный модуль, так и jar-модуль используют Apache log4j для ведения журнала и совместно используют один и тот же файл конфигурации log4j (log4j.xml), который в настоящее время находится в проекте jar-module. И этот файл log4j.xml будет упакован в файл jar-module.jar, однако я хотел бы сделать его в каталоге WEB-INF/classes в военном пакете, а не в файле jar, чтобы пользователи могли легко найти это конфигурационный файл и, при необходимости, изменить его (им очень сложно найти его, если этот файл находится в WEB-INF/lib/jar-module.jar, потому что в этом каталоге есть много других банок).

Мой вопрос: какой способ Maven решить эту проблему?

Update:

Мой реальный проект немного сложнее, и есть модуль уха, который также зависит от jar-модуля (ака. jar-модуль может использоваться независимо в нескольких разных проектах, и я не могу просто поместить файл в каталог war-module/src/main/resources, чтобы устранить эту проблему). И я не хочу дублировать некоторые файлы конфигурации, такие как log4j.xml(и другие файлы конфигурации, такие как myapp.properties), по нескольким проектам.

Ответ 1

Я нашел ответ через несколько поисков в Интернете.

Как правило, существует три способа совместного использования ресурсов в мультимодульном проекте Maven:

  • Вырезать и вставить их.
  • Используйте плагины сборки и зависимостей
  • Используйте плагин maven-remote-resources-plugin

Вот сообщение в блоге от Sonatype, компании за Maven, о совместном использовании ресурсов в проектах в Maven, и это точный ответ, который мне нужен:

http://www.sonatype.com/people/2008/04/how-to-share-resources-across-projects-in-maven/

Ответ 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>

Теперь в артефакте войны скопируйте 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 в первую очередь: -)

Ответ 3

По моему опыту это можно реализовать простым способом, просто:

  • Создайте ресурс конфигурации log4j в родительском модуле.
  • Вызвать зависимость log4j во всех модулях pom.

Надеюсь, что эта помощь вам поможет.