Apache-Maven-ToolChains的使用

Maven 是 java 中非常有用和常用的构建工具，基本上现在大型的 java 项目都是 Maven 和 gradle 的天下了。

因为 JDK 的版本现在以每半年一次的速度在飞速发展。不同的 JDK 版本就有不同的 java 路径，我们在使用 Maven 的过程中，可能经常会需要切换 JDK 的版本。

一般来说我们可以在 maven-compiler-plugin 中配置好 executable 的路径。如下所示：

更多内容请访问 www.flydean.com


<build>
    <plugins>
        <!-- target Java 14 -->
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <!-- fork compilation and use the
                         specified executable -->
                <fork>true</fork>
                <executable>/usr/bin/javac14</executable>
            </configuration>
        </plugin>
    </plugins>
</build>

看起来还不错，但是如果想切换 executable 的路径可能就比较麻烦。更有问题的是，如果你是团队来发，一个人在 mac 环境一个人在 windows 环境，两边的 executable 的路径完全是不同的，这会导致代码冲突，和代码难以维护。

为了解决这个问题，Maven 为我们推出了 Toolchains。使用 Toolchains, 我们可以将这些可执行文件的路径，版本号，还有类型都定义在一个 toolchains.xml 文件里面。

而在 pom.xml 文件中只需要引用 toolchains.xml 中定义的别名就可以了。

针对上面的 windows 和 linux 路径不一致的问题，我们可以保证 pom.xml 是完全一致的，大家只需要适配自己的 toolchains.xml 文件即可。

Toolchains 是和 pom 中其他的 plugin 结合起来使用的，比如最常用的 maven-compiler-plugin。

下面我们举一个例子来说明。首先定义 toolchains.xml 文件，这个文件最好放在 ${user.home}/.m2/ 中。

<?xml version="1.0" encoding="UTF8"?>
<toolchains>
  <!-- JDK toolchains -->
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>14</version>
      <vendor>oracle</vendor>
    </provides>
    <configuration>
      <jdkHome>/path/to/jdk/14</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>11</version>
      <vendor>oracle</vendor>
    </provides>
    <configuration>
      <jdkHome>/path/to/jdk/11</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

上面的例子中，我们定义了 2 个 JDK 的 toolchains。一个 JDK14，一个 JDK11。下面看下怎么在 pom 文件中使用。

<plugins>
 ...
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.1</version>
  </plugin>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-toolchains-plugin</artifactId>
    <version>1.1</version>
    <executions>
      <execution>
        <goals>
          <goal>toolchain</goal>
        </goals>
      </execution>
    </executions>
    <configuration>
      <toolchains>
        <jdk>
          <version>14</version>
          <vendor>oracle</vendor>
        </jdk>
      </toolchains>
    </configuration>
  </plugin>
  ...
</plugins>

上面的 pom 配置文件中，我们通过简单的引用 toolchains 中的定义，即可无缝的进行 JDK 版本的切换。

Toolchains 需要 Maven 2.0.9 以上版本的支持。

Toolchains 是需要和 pom 中的 plugin 一起使用的，下面的图中列出了 toolchains 支持的 plugin 名字和最低的版本要求。

本文介绍了 Apache Maven 中 toolchain 的使用，希望大家能够在实际工作中用起来。

更多精彩内容且看：

区块链从入门到放弃系列教程 - 涵盖密码学, 超级账本, 以太坊,Libra, 比特币等持续更新
Spring Boot 2.X 系列教程: 七天从无到有掌握 Spring Boot- 持续更新
Spring 5.X 系列教程: 满足你对 Spring5 的一切想象 - 持续更新
java 程序员从小工到专家成神之路（2020 版）- 持续更新中, 附详细文章教程

本文作者：flydean 程序那些事

本文链接：http://www.flydean.com/apache-maven-toolchains/

本文来源：flydean 的博客

欢迎关注我的公众号: 程序那些事，更多精彩等着您！

Apache-Maven-ToolChains的使用

简介

Toolchains 的介绍

Toolchains 的例子

Toolchains 支持

总结