自定义MavenResourcesFiltering难以实现?

时间:2016-10-24 10:52:27

标签: java maven maven-resources-plugin plexus

我想为某些源文件编写自定义资源过滤器,以便添加一行

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

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

我关注了Maven Custom resources filters文档,说我需要编写接口MavenResourcesFiltering的自定义实现。

在查看org.apache.maven.shared.filtering.DefaultMavenResourcesFiltering后,我认为从头开始编写MavenResourcesFiltering实现并非易事。所以我一直在寻找从DefaultMavenResourcesFiltering扩展的方法,并发现我需要为它提供一个自定义的MavenFileFilter来实现行的实际前置。

现在,除了复制DefaultMavenResourcesFiltering的整个源代码之外,我无法做到这一点,以便能够为@Requirement重新定义MavenFileFilter注释。 }:

@Requirement
private MavenFileFilter mavenFileFilter;

可能有办法通过配置Plexus DI container来实现我的目标,也许是通过Plexus Component Descriptor。唉,有点异国情调,也许有人知道一个类似问题的好例子?

1 个答案:

答案 0 :(得分:1)

  

可能有办法通过配置Plexus DI容器来实现我的目标,可能是通过Plexus组件描述符

是的,有办法。您需要覆盖"default"使用的MavenFileFilter DefaultMavenResourcesFiltering组件,并提供您自己的组件。这很容易完成:只需为MavenFileFilter角色创建自己的Plexus组件并覆盖"default"提示,并将其添加为Resources Plugin的依赖项。由于这些类直接出现在插件的依赖项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项目后,您可以将其作为依赖项添加到Resources插件中:

<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>

这是您的自定义文件过滤器,将在DefaultMavenResourcesFiltering内注入。