浅谈 Apache Maven ToolChains 的使用

什么是 Maven ToolChains

在开发中使用 Maven 进行构建时，通常需要使用一些外部工具，例如 Java 编译器、Jar 打包工具等。而这些工具的版本可能会强制要求一些项目，则需要使用 ToolChains 机制。

ToolChains 可以用于解决以下问题：

• 在同一台电脑上管理多个版本的编译器、打包工具等工具。
• 根据项目的需要，Maven 可以自动配置正确的版本。

要使用 ToolChains，需要在 Maven 的 settings.xml 文件中添加以下内容：

<settings>
  <toolchains>
    <toolchain>
      <type>jdk</type>
      <provides>
        <version>1.8</version>
        <vendor>oracle</vendor>
      </provides>
      <configuration>
        <jdkHome>/path/to/jdk</jdkHome>
      </configuration>
    </toolchain>
  </toolchains>
</settings>

如何使用 Maven ToolChains

示例一：使用不同版本的 Java 编译器

假设我们有一个基于 Java 8 开发的项目，但是我们的电脑上同时安装有 Java 8 和 Java 10，我们需要使用 Java 8 编译器进行构建。

在 settings.xml 文件中添加如下内容：

<settings>
  <toolchains>
    <toolchain>
      <type>jdk</type>
      <provides>
        <version>1.8</version>
        <vendor>oracle</vendor>
      </provides>
      <configuration>
        <jdkHome>/path/to/jdk8</jdkHome>
      </configuration>
    </toolchain>
  </toolchains>
</settings>

然后，我们可以在 pom.xml 文件中指定使用 Java 8 编译器：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.8.0</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <compilerVersion>1.8</compilerVersion>
      </configuration>
      <dependencies>
        <dependency>
          <groupId>org.codehaus.plexus</groupId>
          <artifactId>plexus-compiler-javac</artifactId>
          <version>2.8.4</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

示例二：使用不同版本的 Jar 打包工具

假设我们有一个基于 Spring Boot 2.2.0 开发的项目，需要使用 Maven Assembly 插件进行打包，但是默认情况下，Maven Assembly 插件只支持使用 Maven 2.2.1 或更早版本的 JAR 打包工具。

在 settings.xml 文件中添加如下内容：

<settings>
  <toolchains>
    <toolchain>
      <type>jdk</type>
      <provides>
        <version>1.8</version>
        <vendor>oracle</vendor>
      </provides>
      <configuration>
        <jdkHome>/path/to/jdk8</jdkHome>
      </configuration>
    </toolchain>
    <toolchain>
      <type>jdk</type>
      <provides>
        <version>3.0.0</version>
        <vendor>apache</vendor>
      </provides>
      <configuration>
        <jdkHome>/path/to/jdk11</jdkHome>
        <includes>
          <include>jarsigner</include>
        </includes>
      </configuration>
    </toolchain>
  </toolchains>
</settings>

然后，在 pom.xml 文件中添加如下内容：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <version>3.2.0</version>
      <executions>
        <execution>
          <configuration>
            <archive>
              <addMavenDescriptor>false</addMavenDescriptor>
            </archive>
            <descriptorRefs>
              <descriptorRef>jar-with-dependencies</descriptorRef>
            </descriptorRefs>
            <appendAssemblyId>false</appendAssemblyId>
          </configuration>
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
      <dependencies>
        <dependency>
          <groupId>org.apache.maven.shared</groupId>
          <artifactId>maven-jarsigner</artifactId>
          <version>1.4</version>
        </dependency>
      </dependencies>
      <configuration>
        <archiverConfigs>
          <archiverConfig>
            <archiver>jarsigner</archiver>
            <configuration>
              <exePath>/path/to/jarsigner</exePath>
              <arguments>
                <argument>-verbose</argument>
                <argument>-storetype</argument>
                <argument>pkcs12</argument>
              </arguments>
            </configuration>
          </archiverConfig>
        </archiverConfigs>
      </configuration>
    </plugin>
  </plugins>
</build>

总结

Maven ToolChains 可以使得项目的构建更加灵活，提高开发效率。通过本文的介绍，你应该学会了如何正确地配置和使用 Maven ToolChains，例如使用不同版本的 Java 编译器、使用不同版本的 Jar 打包工具等。