淺談Apache Maven ToolChains的使用

更新時(shí)間：2021年06月02日 10:17:40 作者：flydean

Maven是java中非常有用和常用的構(gòu)建工具，基本上現(xiàn)在大型的java項(xiàng)目都是Maven和gradle的天下了。本文將介紹Apache Maven ToolChains的使用。

簡(jiǎn)介

因?yàn)镴DK的版本現(xiàn)在以每半年一次的速度在飛速發(fā)展。不同的JDK版本就有不同的java路徑，我們?cè)谑褂肕aven的過(guò)程中，可能經(jīng)常會(huì)需要切換JDK的版本。

一般來(lái)說(shuō)我們可以在maven-compiler-plugin中配置好executable的路徑。如下所示：

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

看起來(lái)還不錯(cuò)，但是如果想切換executable的路徑可能就比較麻煩。更有問(wèn)題的是，如果你是團(tuán)隊(duì)來(lái)發(fā)，一個(gè)人在mac環(huán)境一個(gè)人在windows環(huán)境，兩邊的executable的路徑完全是不同的，這會(huì)導(dǎo)致代碼沖突，和代碼難以維護(hù)。

Toolchains的介紹

為了解決這個(gè)問(wèn)題，Maven為我們推出了Toolchains。使用Toolchains,我們可以將這些可執(zhí)行文件的路徑，版本號(hào)，還有類型都定義在一個(gè)toolchains.xml文件里面。

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

針對(duì)上面的windows和linux路徑不一致的問(wèn)題，我們可以保證pom.xml是完全一致的，大家只需要適配自己的toolchains.xml文件即可。

Toolchains的例子

Toolchains是和pom中其他的plugin結(jié)合起來(lái)使用的，比如最常用的maven-compiler-plugin。

下面我們舉一個(gè)例子來(lái)說(shuō)明。首先定義toolchains.xml文件，這個(gè)文件最好放在${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個(gè)JDK的toolchains。一個(gè)JDK14，一個(gè)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配置文件中，我們通過(guò)簡(jiǎn)單的引用toolchains中的定義，即可無(wú)縫的進(jìn)行JDK版本的切換。

Toolchains支持

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

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