2008.02.25　株式会社四次元データ　森

7. Maven2 プラグインの作成

7.5. プラグインの配備および実行

7.5.1 プラグインの実行まで

前回作成したプラグインをプロジェクトに配備し、実行します。プラグインを作成したディレクトリに移動し

$ mvn install

を行います。これによりローカルリポジトリに自分の作成したプラグインが配備され、実行可能になりました。

プロジェクトの pom.xml に

<plugin>
	<groupId>com.example.maven.plugins</groupId> 
	<artifactId>maven-countlines-plugin</artifactId> 
	<version>1.0-SNAPSHOT</version> 
	<configuration>
		<dir>${basedir}</dir> 
		<ext>jsp,java</ext> 
	</configuration>
</plugin>

と記述します。configuration タグでパラメータの値に代入を行っています。

プロジェクトのディレクトリに移動し

$ mvn $plugin:$goal

つまりこの場合は

$ mvn countlines:countlines

を実行すると、行数がコマンドプロンプトに表示されます。

pom.xml に記述する方法とは別にパラメータを指定する方法もあります。プラグインの作成における 実行部分の作成 を参照すると、パラメータを定義している javadoc において、@parameter expression="${ext}" などとなっていることがわかります。この書式を追加することで、pom.xml を書き換えずとも、コマンドラインから -Dext="xml,java" のように指定することができるようになります。

$ mvn countlines:countlines -Ddir="C\workspace\com\example\maven\plugins" -Dext="xml,java"

なお pom.xml にパラメータを指定した状態で、コマンドラインで更に指定を行っても、pom.xml の指定の方が優先されます。

7.5.2 Tips およびまとめ

Maven Compiler Plugin - Plugin documentation であらわされるような概略ページを、プラグインのプロジェクトのサイトを作成しておく際にプロジェクト用の pom.xml に以下を追加しておくことにより Project Reports 内に作成できます。

<reporting>
	<plugins>
		<plugin>
			<artifactId>maven-plugin-plugin</artifactId>
		</plugin>
		:
	</plugins>
:
</reporting>

このように Maven2 プラグインは Mojo クラスを作成するだけで比較的手軽につくれることがお分かりいただけたと思います。Maven を利用しているプロジェクトで独自の作業を行いたい場合には作成を検討してもよいでしょう。