Maven:如何用不同的属性值多次过滤同一资源?

我们的项目使用Log4J,通过log4j.properties文件配置。我们有多个生产服务器,它们记录到不同的日志文件,以便可以区分日志。所以节点 1 的 log4j.properties 看起来像这样:

...
log4j.appender.Application.File=D:/logs/application_1.log
...
log4j.appender.tx_info.File=D:/logs/tx_info_1.log
...

而节点 2 的 log4j.properties 看起来像

...
log4j.appender.Application.File=D:/logs/application_2.log
...
log4j.appender.tx_info.File=D:/logs/tx_info_2.log
...

我们已经使用 Maven 配置文件来生成服务器配置。到目前为止,它包含几个不同的log4j.properties文件,这些文件仅在日志文件名上有所不同,如上所示。我想使用这样的资源模板文件与Maven一起生成这些文件:

...
log4j.appender.Application.File=${log.location}/application${log.file.postfix}.log
...
log4j.appender.tx_info.File=${log.location}/tx_info${log.file.postfix}.log
...

使用不同的值多次运行 Maven 很容易,每次都生成一个不同的日志属性文件。但是,我想要的是为一个构建中的每个服务器生成一个不同的属性文件(名称/路径不同)。我相当确定这可以完成,例如通过antrun插件,但我不熟悉。实现此目的的最简单方法是什么?${log.file.postfix}


答案 1

(...)我相当确定这可以完成,例如通过antrun插件,但我不熟悉。实现此目的的最简单方法是什么?

您确实可以在POM中使用和几个(请注意,这不允许更改目标文件的名称)。resources:copy-resources<execution>resources:copy-resources

假设您具有以下结构:

$ tree .
.
├── pom.xml
└── src
    ├── main
    │   ├── filters
    │   │   ├── filter-node1.properties
    │   │   └── filter-node2.properties
    │   ├── java
    │   └── resources
    │       ├── log4j.properties
    │       └── another.xml
    └── test
        └── java

Where 使用占位符,并且文件包含值。例如:log4j.propertiesfilter-nodeN.properties

# filter-node1.properties

log.location=D:/logs
log.file.postfix=_1

然后,在 中配置资源插件,并为每个节点定义一个要调用的特定输出目录和要使用的特定过滤器:pom.xml<execution>copy-resources

<project>
  ...
  <build>
    <resources>
      <!-- this is for "normal" resources processing -->
      <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering><!-- you might still want to filter them -->
        <excludes>
          <!-- we exclude the file from "normal" resource processing -->
          <exclude>**/log4j.properties</exclude>
        </excludes>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.4.3</version>
        <executions>
          <execution>
            <id>copy-resources-node1</id>
            <phase>process-resources</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <outputDirectory>${basedir}/target/node1</outputDirectory>
              <resources>
                <resource>
                  <directory>src/main/resources</directory>
                  <filtering>true</filtering>
                  <includes>
                    <include>**/log4j.properties</include>
                  </includes>
                </resource>
              </resources>
              <filters>
                <filter>src/main/filters/filter-node1.properties</filter>
              </filters>
            </configuration>
          </execution>
          <execution>
            <id>copy-resources-node2</id>
            <phase>process-resources</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <outputDirectory>${basedir}/target/node2</outputDirectory>
              <resources>
                <resource>
                  <directory>src/main/resources</directory>
                  <filtering>true</filtering>
                  <includes>
                    <include>**/log4j.properties</include>
                  </includes>
                </resource>
              </resources>
              <filters>
                <filter>src/main/filters/filter-node2.properties</filter>
              </filters>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

运行 mvn 将产生以下结果:process-resources

$ tree .
.
├── pom.xml
├── src
│   ├── main
│   │   ├── filters
│   │   │   ├── filter-node1.properties
│   │   │   └── filter-node2.properties
│   │   ├── java
│   │   └── resources
│   │       ├── log4j.properties
│   │       └── another.xml
│   └── test
│       └── java
└── target
    ├── classes
    │   └── another.xml
    ├── node1
    │   └── log4j.properties
    └── node2
        └── log4j.properties

在每个 .log4j.properties

$ cat target/node1/log4j.properties 
log4j.appender.Application.File=D:/logs/application_1.log
log4j.appender.tx_info.File=D:/logs/tx_info_1.log

这有点工作,但很详细,如果你有相当数量的节点,这可能是一个问题。


我试图使用Maven AntRun插件编写更简洁和可维护的东西,但是我无法将for任务从ant-contrib中获取到Maven下工作(由于未知原因,for任务无法识别),我放弃了

这是使用Maven AntRun插件的替代方案。没有什么复杂的,没有循环,我只是将源文件复制到另一个位置,动态更改其名称并过滤内容:

  <plugin>
    <artifactId>maven-antrun-plugin</artifactId>
    <version>1.3</version>
    <executions>
      <execution>
        <id>copy-resources-all-nodes</id>
        <phase>process-resources</phase>
        <configuration>
          <tasks>
            <copy file="src/main/resources/log4j.properties" toFile="target/antrun/log4j-node1.properties">
              <filterset>
                <filter token="log.location" value="D:/logs"/>
                <filter token="log.file.postfix" value="_1"/>
              </filterset>
            </copy>
            <copy file="src/main/resources/log4j.properties" toFile="target/antrun/log4j-node2.properties">
              <filterset>
                <filter token="log.location" value="D:/logs"/>
                <filter token="log.file.postfix" value="_2"/>
              </filterset>
            </copy>
          </tasks>
        </configuration>
        <goals>
          <goal>run</goal>
        </goals>
      </execution>
    </executions>
  </plugin>

请注意,Ant 默认使用作为标记的分隔符(无法让它使用 maven 样式分隔符),因此变成了:@log4j.properties

log4j.appender.Application.File=@log.location@/application@log.file.postfix@.log
log4j.appender.tx_info.File=@log.location@/tx_info@log.file.postfix@.log

但是,由于这些值似乎是特定于节点的,您是否考虑过改用系统属性(可以放在启动脚本中)?这是我已经做过的事情(使用a),它工作得很好,它会高度简化事情。log4j.xml


答案 2

虽然这有点旧,但我最近遇到了这个线程,并希望使用迭代器- maven-插件提出一个更新的解决方案。概述可在此处找到:http://khmarbaise.github.io/iterator-maven-plugin/

如何实现目标的一个具体示例是将迭代器插件与启用的副本资源和过滤器相结合。您甚至可以添加自定义属性文件以用作筛选器,以防您有使用此方法的每个节点唯一的其他属性。

<plugin>

    <groupId>com.soebes.maven.plugins</groupId>
    <artifactId>iterator-maven-plugin</artifactId>
    <version>0.3</version>

    <executions>
        <execution>
            <id>configure-log-properties</id>
            <phase>validate</phase>
            <goals>
                <goal>iterator</goal>
            </goals>
            <configuration>
                <iteratorName>log.file.postfix</iteratorName>
                <content>1,2,3,4,5</content>
                <pluginExecutors>

                    <pluginExecutor>
                        <plugin>
                            <artifactId>maven-resources-plugin</artifactId>
                            <version>2.7</version>
                        </plugin>

                        <goal>copy-resources</goal>

                        <configuration>
                            <outputDirectory>${project.build.directory}/nodes/${log.file.postfix}</outputDirectory>

                            <resources>
                                <resource>
                                    <directory>src/main/resources</directory>
                                    <includes>
                                        <include>log4j.properties</include>
                                    </includes>
                                    <filtering>true</filtering>
                                </resource>
                            </resources>
                        </configuration>

                    </pluginExecutor>
                </pluginExecutors>
            </configuration>
        </execution>
    </executions>
</plugin>