Mavenでは多数の条件をmvnコマンドのオプションで指定することが多いですが、指定するオプションにはプロジェクトや環境が同じであればに常に同じとなるオプションがあるため、オプションを固定化したい場合があったりします。また 「ローカルリポジトリの分割」で紹介したような長いオプションを都度指定するのが面倒だったりもします。このような場合、実行コマンドをbatファイルやシェルスクリプトでスクリプト化する方法がよく行われますが、Mavenにはオプションを固定化し実行ごとに必要なる入力を省略可能にする機能があります。今回はこのMavenのオプションを固定化する機能を紹介します。

オプションを固定化する方法はその種類によって分かれているため、本題に入る前にMavenの実行時に指定するオプションの種類について簡単に説明します。

Mavenの実行時に指定するオプションは大きく次の２つに大別できます。

• VMオプション
• Mavenオプション

Mavenはご存じのとおりJavaVM上で実行されますが、VMオプションはこのMavenを実行する土台となるJavaVMに対するオプションとなります。具体的には最大ヒープサイズを指定する-Xmx1024mなどjavaコマンドで定義されているオプションとなります。

これに対してMavenオプションはMaven機能に対するオプションとなります。この具体的なものとしてはプロファイルを指定する-Pオプションやバッチモードで実行する-Bオプションなどmvnコマンドで定義されているオプションとなります。

本題に入ってまずはVMオプションを固定化する方法ですが、これには次の２つの方法があります。

• 環境変数MAVEN_OPTSによる設定
• .mvn/jvm.configによる指定

例えば、最大ヒープサイズを2GB(2048MB)、最小ヒープサイズを1GB(1024MB)でMavenを実行する指定をMAVEN_OPTSを使って行う場合は、次のようになります。

export MAVEN_OPTS="-Xmx2048m -Xms1024m"
mvn clean compile

これと同じ内容を.mvn/jvm.configで指定する場合は、プロジェクト直下に.mvn/jvm.configファイルを作成し、そのファイルに固定化するオプションを次のようにそのまま記述します。

-Xmx2048m -Xms1024m

なおMAVEN_OPTSとjvm.configの指定は併存可能性です。
現実的な例ではないですが、MAVEN_OPTSに-Xmx2048m、jvm.configに-Xms1024mを設定した場合、実行時にはこの２つが連結され、JavaVMには-Xmx2048m -Xms1024mが渡るようになっています。

このことから、この２つの使い分けは、プロジェクトごとに共通となる設定はビルド担当者が.mvn/jvm.configを作成してプロジェクトのリポジトリにコミットしておき、環境変数MAVEN_OPTSはその環境ごとに個別に設定するといった、プロジェクトの共通設定と環境ごとの個別設定になると思います。

次にMavenオプションを固定化する方法ですが、これはVMオプションと同様に次の2つになります。

• 環境変数MAVEN_ARGSによる設定
• .mvn/maven.configによる指定

VMオプションと同様に例をもとに説明すると、例えばMavenのバージョン情報を出力する-Vオプションとリモートとローカルの取得元別にアーティファクトを別々に格納するようにする-Daether.enhancedLocalRepository.splitオプション^[1]が常に指定されるようにしたい場合、設定は次のようになります。

• 環境変数MAVEN_OPTSによる指定

export MAVEN_ARGS="-V -Daether.enhancedLocalRepository.split"
 mvn clean compile

• maven.configの設定内容

-V
-Daether.enhancedLocalRepository.split

maven.configはjvm.configと同様に.mvnディレクトリの直下にファイルを作成して設定を行います。

-V -Daether.enhancedLocalRepository.split

<project xmlns=...>
  ...
  <properties>
    <sample.arg>arg1</sample.arg>
  </properties>
  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
          ...
          <arguments>
            <argument>${sample.arg}</argument>
          </arguments>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project> 

mvn clean compile -Dsample.arg=hello

mvn --help
> usage: mvn [options] [<goal(s)>] [<phase(s)>]
> 
> Options:
>  -D,--define <arg>       Define a user property
> ...

MAVEN_ARGSとmaven.configの併存と双方に同じオプションが指定された場合の扱いはVMオプションと同じとなりますが、VMオプションはmvnコマンドで直接指定することができないのに対し、Mavenオプションは(通常行っているように)mvnコマンドでオプションを都度指定することができるといった違いがあります。

このため、次のようなオプション指定を行うコマンドがあった場合、

mvn clean compile exec:java -P product -V -Daether.enhancedLocalRepository.split

-Vと-DオプションをMAVEN_ARGSやmaven.configで固定化することで次のように実行の都度指定が変わるものだけを指定して実行することができるようになります。

mvn clean compile exec:java -P product

記事ではMaven実行時のオプション指定を固定する方法として4つを説明しましたが、この4つの用途は次のようにまとめることができます。

Mavenが持つオプションの固定化機能はbatファイルやシェルスクリプトによるスクリプト化よりも簡潔に設定することができるため、ここぞ！というオプション指定があった場合は是非使ってみたいと思います。

参照資料

• Maven – Configuring Apache Maven