maven - 在maven中配置不同文件类型的编码？

Question

我使用maven-resource-plugin过滤我的 Maven 项目中的一些资源。在我的父项目中，我有:

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

在一个子项目中，我有一个 test.properties 文件，它是一个普通的 java properties file默认编码=ISO-8859-1。该文件包含:

aboutText=Version ${project.version} © 2012 blabla

为了确保此文件正确过滤，我已将 maven-resource-plugin 拆分为单独的执行，每个执行都有其编码:

  <plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <configuration>
      <nonFilteredFileExtensions>
        <nonFilteredFileExtension>ico</nonFilteredFileExtension>
        <nonFilteredFileExtension>jar</nonFilteredFileExtension>
      </nonFilteredFileExtensions>
    </configuration>
    <executions>
      <execution>
        <id>filter-properties-files</id>
        <phase>generate-resources</phase>
        <goals>
          <goal>copy-resources</goal>
        </goals>
        <configuration>
          <!-- java properties files are encoded in ISO-8859-1 so when 
            filtering those files we stick with that encoding. -->
          <encoding>ISO-8859-1</encoding>
          <outputDirectory>${basedir}/after</outputDirectory>
          <resources>
            <resource>
              <filtering>true</filtering>
              <directory>${basedir}/before</directory>
              <includes>
                <include>**/*.properties</include>
              </includes>
            </resource>
          </resources>
        </configuration>
      </execution>
      <execution>
        <id>filter-non-properties-files</id>
        <phase>generate-resources</phase>
        <goals>
          <goal>copy-resources</goal>
        </goals>
        <configuration>
          <encoding>${project.build.sourceEncoding}</encoding>
          <outputDirectory>${basedir}/after</outputDirectory>
          <resources>
            <resource>
              <filtering>true</filtering>
              <directory>${basedir}/before</directory>
              <includes>
                <include>**/*.product</include>
                <include>**/*.inf</include>
              </includes>
            </resource>
          </resources>
        </configuration>
      </execution>
    </executions>
  </plugin>

这似乎太过分了，我有一种感觉，我要么没有正确使用该插件，要么应该以其他方式处理这个问题。也许坚持直接在属性文件中编码特殊字符:

aboutText=Version ${project.version} \u00a9 2012 blabla

？

Answer 1

这个问题本身就是一个非常宝贵的答案，因为显然作者提供的复杂过程是为各种过滤文件类型配置不同编码的唯一方法。然而，给出的示例特定于作者的非标准用例，并掩盖了一些重要的细节，如果没有这些细节，该示例的实际使用就会充满陷阱:

• 这并不明显，但在作者的示例中默认资源复制目标resources仍然启用并且除了两个定义的目标之外还运行!
• 您会注意到，作者使用了生命周期阶段 generate-resources 而不是默认的 process-resources。这是绕过上面第一点的技巧；通过使两个 copy-resources 目标发生在较早的生命周期阶段，资源将根据给定的规则进行复制，然后当 default-resources 目标出现时原始资源复制保持不变，显然是因为它的覆盖设置默认为 false。但最好disable altogether default-resources 执行。
• 作者提供了一个 outputDirectory 声明。人们很自然地认为作者提供这个只是因为需要自定义输出目录；毕竟，资源目标为此设置提供了默认值。但奇怪的是，对于复制资源目标，这个设置实际上是必需的!不过，有一个标准 Maven 变量 ${project.build.outputDirectory} 可以用作该值。

基于作者在问题中自己的示例，这里是一种使用 ISO-8859-1 过滤属性文件的剪切和粘贴方法，复制其他文件而不进行过滤，并防止发生默认资源复制；全部使用标准源目录和目标目录:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-resources-plugin</artifactId>
  <version>2.7</version>
  <executions>
    <execution>
      <!-- Turn off default resource copying. -->
      <id>default-resources</id>
      <phase />
    </execution>
    <execution>
      <!-- Filter resources in properties files. -->
      <id>filter-properties-files</id>
      <phase>process-resources</phase>
      <goals>
        <goal>copy-resources</goal>
      </goals>
      <configuration>
        <encoding>ISO-8859-1</encoding>
        <outputDirectory>${project.build.outputDirectory}</outputDirectory>
        <resources>
          <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
              <include>**/*.properties</include>
            </includes>
          </resource>
        </resources>
      </configuration>
    </execution>
    <execution>
      <!-- Do not do property substitution in files that are not properties files, such as binary files. -->
      <id>copy-other-resources</id>
      <phase>process-resources</phase>
      <goals>
        <goal>copy-resources</goal>
      </goals>
      <configuration>
        <outputDirectory>${project.build.outputDirectory}</outputDirectory>
        <resources>
          <resource>
            <directory>src/main/resources</directory>
            <filtering>false</filtering>
            <excludes>
              <exclude>**/*.properties</exclude>
            </excludes>
          </resource>
        </resources>
      </configuration>
    </execution>
  </executions>
</plugin>

更新:经过更多研究，我相信，除了禁用默认执行之外，还可以简单地修改默认执行以忽略属性文件，并添加对属性文件的过滤作为附加执行。此外，如果使用资源目标而不是复制资源，则无需指示输出目录或阶段，如资源:资源code> 自动绑定(bind)到 process-resources 阶段并输出到 ${project.build.outputDirectory}。请注意，我已经更新到该插件的 3.1.0 版本，因此其中一些选项可能在我上面使用的版本中不可用。 我还没有测试过这个新的、更短的配置。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-resources-plugin</artifactId>
  <version>3.1.0</version>
  <executions>
    <execution>
      <!-- Ignore properties files by default. -->
      <id>default-resources</id>
      <configuration>
        <resources>
          <resource>
            <directory>${project.basedir}/src/main/resources</directory>
            <excludes>
              <exclude>**/*.properties</exclude>
            </excludes>
          </resource>
        </resources>
      </configuration>
    </execution>
    <execution>
      <!-- Filter resources in properties files using ISO-8859-1. -->
      <id>filter-properties-files</id>
      <goals>
        <goal>resources</goal>
      </goals>
      <configuration>
        <encoding>ISO-8859-1</encoding>
        <resources>
          <resource>
            <directory>${project.basedir}/src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
              <include>**/*.properties</include>
            </includes>
          </resource>
        </resources>
      </configuration>
    </execution>
  </executions>
</plugin>

也许有人可以测试这个新配置，并让我知道它是否与我上面给出的原始配置相同。