如何合并 Maven 程序集中的资源文件？

Question

我使用 Maven 及其组装插件来构建我的项目的分发包，如下所示：

• 一个项目在 ZIP 文件中组装了一个基本运行时（基于 Felix）以及适当的目录和捆绑包。
• 第三方库分别收集在一个项目中，然后转换为 OSGi 捆绑包，或者如果它们已经与 OSGi 兼容，则直接复制它们。
• 我自己的项目也包含几个内置于 OSGi 捆绑包中的模块。

现在，我添加另一个项目，用于解压 ZIP、将所有其他 JAR 放入正确的目录中，然后重新打包以进行分发。现在，我的包可能包含我想要合并到的配置文件，而不是替换运行时程序集中同名的配置文件。我该怎么做？

这些文件是纯文本（属性文件），但稍后我可能会遇到 XML 文件的类似情况。

Answer 1

对于那些偶然发现这一点的人，对 Juergen 的答案进行了一些扩展 - 描述符中的 containerDescriptorHandler 可以采用四个值 (v2.3)，这些是 metaInf-services、文件聚合器、plexus、metaInf-spring。它有点隐藏在代码中（在 org.apache.maven.plugin.assemble.filter 包中找到），但可以聚合配置/属性文件。

下面是一个示例描述符，它聚合了 META-INF/services 和
命名属性文件位于 com.mycompany.actions 中。

descriptor.xml

<assembly>

...

<containerDescriptorHandlers>

    <containerDescriptorHandler>
        <handlerName>metaInf-services</handlerName>
    </containerDescriptorHandler>

    <containerDescriptorHandler>
        <handlerName>file-aggregator</handlerName>
        <configuration>
            <filePattern>com/mycompany/actions/action.properties</filePattern>
            <outputPath>com/mycompany/actions/action.properties</outputPath>
        </configuration>
    </containerDescriptorHandler>

</containerDescriptorHandlers>

....

</assembly>

file-aggregator 可以在 filePattern 中包含正则表达式来匹配多个文件。以下内容将匹配所有文件名“action.properties”。

<filePattern>.+/action.properties</filePattern>

metaInf-services 和 metaInf-spring 用于聚合SPI 和 spring 配置文件，而 plexus 处理程序会将 META-INF/plexus/components.xml 聚合在一起。

如果您需要更专业的东西，您可以通过实现 ContainerDescriptorHandler 并在 META-INF/plexus/components.xml 中定义组件来添加自己的配置处理程序。您可以通过创建一个上游项目来完成此操作，该项目依赖于 maven-assemble-plugin 并包含您的自定义处理程序。也许可以在您正在组装的同一个项目中执行此操作，但我没有尝试这样做。处理程序的实现可以在程序集源代码的 org.apache.maven.plugin. assembly.filter.* 包中找到。

CustomHandler.java

package com.mycompany;

import org.apache.maven.plugin.assembly.filter.ContainerDescriptorHandler;

public class CustomHandler implements ContainerDescriptorHandler {
    // body not shown
}

中定义组件

在 /src/main/resources/META-INF/plexus/components.xml components.xml

<?xml version='1.0' encoding='UTF-8'?>
<component-set>
    <components>
        <component>
            <role>org.apache.maven.plugin.assembly.filter.ContainerDescriptorHandler</role>
            <role-hint>custom-handler</role-hint>
            <implementation>com.mycompany.CustomHandler</implementation>
            <instantiation-strategy>per-lookup</instantiation-strategy>
        </component>
    </components>
</component-set>

然后 将其添加为对要组装的项目中的组装插件的依赖项

pom.xml

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>2.2.1</version>
    <configuration>
        <descriptors>
            <descriptor>...</descriptor>
        </descriptors>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>com.mycompany</groupId>
            <artifactId>sample-handler</artifactId>
            <version>1.0</version>
        </dependency>
    </dependencies>
</plugin>

中定义 handlerName

并在描述符descriptor.xml

...
<containerDescriptorHandler>
    <handlerName>custom-handler</handlerName>
</containerDescriptorHandler>
...

maven-shade-plugin 还可以创建 'uber-jars' 并具有一些用于处理 XML 的资源转换，许可证和清单。

J

Answer 2

老问题，但在尝试解决类似问题时偶然发现了它：Assembly plugin 2.2 has features to merge files:

Answer 3

我不知道这个问题的可靠解决方案。但环顾四周发现有人有 创建了一个插件来合并属性文件。从它的外观来看，您需要告诉它要合并哪些文件，这是一件好事，因为您不希望随意应用此操作。

假设您已使用 dependency-unpack 将 zip 解压到已知位置，则需要配置插件以合并每对属性文件并指定适当的目标位置。

您可以使用 EL4J 中的 xmlmerge 之类的东西来扩展插件来处理 XML，如 这篇 Javaworld 文章。

Answer 4

我还创建了一个合并文件插件，在我的例子中，我使用它将来自各个项目的 SQL 文件合并到单个安装程序 SQL 文件中，该文件可以在单个文件中为我们的应用程序创建所有架构/表/静态数据等，http://croche.googlecode.com/svn/docs/ maven-merge-files-plugin/0.1/usage.html

Answer 5

https://github.com/rob19780114/merge-maven-plugin （在maven上可用中央）似乎也能完成这项工作。
请参阅下面的示例配置

 <plugin>
    <groupId>org.zcore.maven</groupId>
    <artifactId>merge-maven-plugin</artifactId>
    <version>0.0.3</version>
    <executions>
        <execution>
            <id>merge</id>
            <phase>generate-resources</phase>
            <goals>
                <goal>merge</goal>
            </goals>
            <configuration>
              <mergers>
                <merger>
                  <target>${build.outputDirectory}/output-file-1</target>
                  <sources>
                    <source>src/main/resources/file1</source>
                    <source>src/main/resources/file2</source>
                  </sources>
                </merger>
                <merger>
                  <target>${build.outputDirectory}/output-file-2</target>
                  <sources>
                    <source>src/main/resources/file3</source>
                    <source>src/main/resources/file4</source>
                  </sources>
                </merger>
              </mergers>
            </configuration>
        </execution>
    </executions>