java - 自定义 MavenResourcesFiltering 很难实现？

Question

我想为一些源文件编写一个自定义资源过滤器，以便在前面添加一行

// @sourceURL=<path-to-file> 

在资源过滤期间，其中<path-to-file>是文件相对于 ${project.basedir} 的路径.

我关注了 Maven Custom resources filters文档，说我需要编写接口(interface)的自定义实现 MavenResourcesFiltering .

查看org.apache.maven.shared.filtering.DefaultMavenResourcesFiltering后我想写一个 MavenResourcesFiltering从头开始实现并非易事。所以我正在寻找从 DefaultMavenResourcesFiltering 扩展的方法，并发现我需要为其提供自定义 MavenFileFilter这实际上是在行前面添加。

现在我想到，除了复制 DefaultMavenResourcesFiltering 的整个源代码之外，没有办法做到这一点。 ，以便能够重新定义其 @Requirement MavenFileFilter 的注释:

@Requirement
private MavenFileFilter mavenFileFilter;

也许有办法通过配置 Plexus DI container 来实现我的目标，也许通过Plexus Component Descriptor 。唉，这有点奇怪，也许有人知道类似问题的好例子？

Answer 1

Probably there are ways to achieve my goals by configuration of the Plexus DI container, perhaps by means of a Plexus Component Descriptor

是的，有办法。您需要覆盖 DefaultMavenResourcesFiltering 使用的 "default" MavenFileFilter 组件，并提供您自己的组件。这很容易完成:只需为 MavenFileFilter 角色创建您自己的 Plexus 组件并覆盖 "default" 提示，并将其添加为资源插件的依赖项。由于类直接存在于插件的依赖项 are loaded first 下，它们将覆盖默认的。

设置如下。创建一个具有以下 POM 的新 Maven 项目:

<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>my.groupId</groupId>
  <artifactId>my-file-filter</artifactId>
  <version>0.0.1</version>
  <dependencies>
    <dependency>
      <groupId>org.apache.maven.shared</groupId>
      <artifactId>maven-filtering</artifactId>
      <version>3.1.1</version>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.plexus</groupId>
        <artifactId>plexus-component-metadata</artifactId>
        <version>1.6</version>
        <executions>
          <execution>
            <goals>
              <goal>generate-metadata</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

这依赖于 Maven Filtering共享组件，并声明 plexus-component-metadata 插件，以便自动生成 Plexus component.xml (以便我们的类正确注册为 Plexus 组件)。

然后，自定义文件过滤器很简单:可以继承默认的文件过滤器，即 DefaultMavenFileFilter :

@Component(role = MavenFileFilter.class, hint = "default")
public class MyMavenFileFilter extends DefaultMavenFileFilter {

    public void copyFile(File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers, String encoding, boolean overwrite) throws MavenFilteringException {
        super.copyFile(from, to, filtering, filterWrappers, encoding, overwrite);
        // your logic of modifying the "to" file here
    }

}

这只是覆盖了所有其他方法最终调用的 copyFile 方法，通过调用 super 方法确保默认行为仍然发生，然后执行自定义代码。在此部分中，您可以处理 to 文件并在其中添加所需的行。

使用 mvn clean install 安装此 Maven 项目后，您可以将其作为依赖项添加到资源插件中:

<plugin>
  <artifactId>maven-resources-plugin</artifactId>
  <version>3.0.1</version>
  <dependencies>
    <dependency>
      <groupId>my.groupId</groupId>
      <artifactId>my-file-filter</artifactId>
      <version>0.0.1</version>
    </dependency>
  </dependencies>
</plugin>

这是您的自定义文件过滤器，将被注入(inject)到 DefaultMavenResourcesFiltering 中。