由 Maven 构建

过滤一些分发文件

介绍

文件过滤用于将文件内部的变量字段替换为其表示的值。对于 Assembly Plugin 和大多数 Maven 过滤程序，这些变量包含在 ${ 和 } 之间。例如，在过滤文件之前，它包含${project.artifactId}。但是在过滤完成后，会使用项目的artifactId替换${project.artifactId}创建一个新文件，并且使用这个新文件而不是原始文件。

尽管可以在流程资源阶段进行过滤，但并非所有进入您的发行版的文件都来自项目资源。因此，程序集插件允许在将文件复制到创建的程序集之前过滤文件。

此示例演示如何在将文件添加到程序集中之前对其进行过滤。在此示例中，我们需要将分发文件过滤到存档中。分发中包含的文件是：

  • 自述文件.txt
  • 许可证.txt
  • 通知.txt

以上所有文件都在项目的根目录下，但只需要过滤 README 和 NOTICE 文件。用于过滤这些文件的属性文件位于src/assembly/filter.properties中。

属性文件是包含变量名称及其对应字符串值的文件。其内容的格式与 Java 属性文件的保存方式相同。下面是一个属性文件的例子：

# lines beginning with the # sign are comments

variable1=value1
variable2=value2

装配描述符

过滤只在 <files> 内部启用，所以我们将使用它。因此，我们的程序集描述符将是：

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
  <id>distribution</id>
  <formats>
    <format>jar</format>
  </formats>
  <files>
    <file>
      <source>README.txt</source>
      <outputDirectory></outputDirectory>
      <filtered>true</filtered>
    </file>
    <file>
      <source>LICENSE.txt</source>
      <outputDirectory></outputDirectory>
    </file>
    <file>
      <source>NOTICE.txt</source>
      <outputDirectory></outputDirectory>
      <filtered>true</filtered>
    </file>
  </files>
</assembly>

上面的描述符告诉 Assembly Plugin 过滤 README.txt 和 NOTICE.txt 文件，并且只复制 LICENSE.txt 文件。

或者，如果 <files> 中包含许多 .txt 文件，我们可以像这样设置 <fileSets> 和 <files>：

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
  <id>distribution</id>
  <formats>
    <format>jar</format>
  </formats>
  <fileSets>
    <fileSet>
      <directory>${basedir}</directory>
      <includes>
        <include>*.txt</include>
      </includes>
      <excludes>
        <exclude>README.txt</exclude>
        <exclude>NOTICE.txt</exclude>
      </excludes>
    </fileSet>
  </fileSets>
  <files>
    <file>
      <source>README.txt</source>
      <outputDirectory></outputDirectory>
      <filtered>true</filtered>
    </file>
    <file>
      <source>NOTICE.txt</source>
      <outputDirectory></outputDirectory>
      <filtered>true</filtered>
    </file>
  </files>
</assembly>

上述描述符将所有 .txt 文件添加到程序集中，但过滤 README.txt 和 NOTICE.txt 文件。

聚甲醛

pom.xml里面的Assembly Plugin的配置应该和其他的没有什么不同，除了过滤器文件的配置，所以：

<project>
  [...]
  <build>
    [...]
    <plugins>
      [...]
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>3.3.0</version>
        <configuration>
          <filters>
            <filter>src/assembly/filter.properties</filter>
          </filters>
          <descriptors>
            <descriptor>src/assembly/distribution.xml</descriptor>
          </descriptors>
        </configuration>
      </plugin>
   [...]
</project>

生成程序集

为了生成分发程序集，我们然后使用：

mvn clean assembly:single