Maven2 プラグイン入門

Maven2 プラグイン入門第一回チキチキ『 ant から maven2 へ』〜血があつい鉄道ならばこまるよね〜船戸　隆 [email_address]

自己紹介
舩戸　隆
株式会社エーティーエルシステムズ所属
日本一暑い町、岐阜県多治見市出身
Java プログラマ
id:tfunato
http://www.canetrash.jp
Twitter http ://twitter.com/tfunato

アジェンダ
Maven Plugin とは？
どのように動いているか？
プラグインの作り方
ファーストステップ
パラメータの受け渡し
登録の方法
起動の方法
まとめ

MavenPlugin とは

MavenPlugin とは
プロジェクトのライフサイクルの各フェーズにおける、ゴールを実行する
ビルド、テスト、レポート出力・・・
プロセスを簡素・共通化
コマンドの引数を変えるだけ
誰がやっても同じ手順
Javaでできることは何でもできる

アーキテクチャ概要 Java Classworlds Plexus Maven-core MOJO M aven plain O ld J ava O bject maven-site-plugin maven-eclipse-plugin maven-clean-plugin

主要な使用ライブラリ
Classworlds
シンプルなクラスローディングライブラリ
Maven コアとプラグインのクラスローダを切り分ける
Plexus
軽量 DI コンテナ
Maven ２の本体そのもの
コンポーネントのライフサイクルのサポート
ネストしたコンテナ
コンポーネント単位のクラスローダーの分離
http://classworlds.codehaus.org/ http://plexus.codehaus.org/

Mojo
Mojo
Maven プラグインインターフェース
M aven plain O ld J ava O bject
org.apache.maven.plugin.Mojo インターフェース
定義されてるのは
setLog(Log log) 、 getLog() 、 void execute() だけ！
org.apache.maven.plugin.AbstractMojo
継承して Plugin を作る
void execute() を実装するだけ！

Maven2の仕組み
Classworlds MavenCore Mojo Mojo Mojo Classworlds Plexus Classloader Classloader Classloader Plugin ごとに Classloader が別

BuildLifeCycle とは
BuildLifeCycle
Maven ではコアコンセプトとして BuildLifeCycle という考えに基づいている
LifeCycle としてビルド、配布、成果物作成、テストなどのプロセスを明確に分離して定義している
その分離した単位を Phase という
Phase は Plugin のまとまり
デフォルトの Phase は
${M2_HOME}/lib/maven-core-2.0.X-uber.jar の META － INF/plexus/components.xml に定義

BuildLifeCycle
定義済み LifeCycle
大きく分けて３つ
Default
プロジェクトのライフサイクル
Clean
プロジェクトのクリーン
生成物のお掃除
Site
プロジェクトのサイト作成
ドキュメント、レポート作成
派生成果物
<configuration> <lifecycles> <lifecycle> <id>default</id> <phases> <phase>validate</phase> <phase>initialize</phase> <phase>generate-sources</phase> <phase>process-sources</phase> <phase>generate-resources</phase> <phase>process-resources</phase> <phase>compile</phase> <phase>process-classes</phase> <phase>generate-test-sources</phase> <phase>process-test-sources</phase> <phase>generate-test-resources</phase> <phase>process-test-resources</phase> <phase>test-compile</phase> <phase>process-test-classes</phase> <phase>test</phase> <phase>package</phase> <phase>pre-integration-test</phase> <phase>integration-test</phase> <phase>post-integration-test</phase> <phase>verify</phase> <phase>install</phase> <phase>deploy</phase> </phases> <configuration>

BuildLifeCycle
定義済み Phase – Default
Via:Maven 2.0.8 テストコードコンパイル後処理 process-test-classes 成果物の配備 deploy 成果物のインストール install パッケージング後チェック verify インテグレーションテスト後処理 post-integration-test インテグレーションテスト integration-test インテグレーションテスト準備 pre-integration-test 成果物のパッケージング package テスト実行 test テストコードコンパイル test-compile 概略 Phase リソース成形 process-resources リソース生成 generate-resources テストリソース成形 process-test-resources テストリソース生成 generate-test-resources テストコード成形 process-test-sources テストコード生成 generate-test-sources コンパイル後処理 process-classes コンパイル compile ソースコードの成形 process-sources ソースコード生成 generate-sources ビルドプロセスの準備 initialize POM の精査 validate 概略 Phase

BuildLifeCycle
定義済み Phase – Clean
clean フェーズの後に実行されるフェーズ生成物を削除するフェーズ clean フェーズの前に実行されるフェーズ説明 clean Mojo post-clean maven-clean-plugin clean pre-clean Plugin Phase

BuildLifeCycle
定義済み Phase – Site
site フェーズで生成されたものをデプロイする site フェーズの後に実行されるフェーズ JavaDoc 、レポートなどを生成するフェーズ site フェーズの前に実行されるフェーズ説明 deploy site Mojo maven-site-plugin site-deploy post-site maven-site-plugin site pre-site Plugin Phase

プラグインの作り方

ファーストステップ
ArchetypePlugin でプロジェクトを作る
Archetype に maven-archetype-mojo を指定
MavenPlugin プロジェクトの雛形ができる
mvn archetype:create -DpackageName= 任意のパッケージ -DgroupId= 任意のグループ ID -DartifactId= maven -sample- plugin -DarchetypeArtifactId= maven-archetype-mojo ・すでに実装コードが用意された状態・ artifactId の maven-#####-plugin が重要・ <packaging>maven-plugin</packaging>

Goal、Phase指定
Goal 、 Phase の指定
Javadoc で記述
上記の例だと、ゴールは sample で compile のフェーズで実行される
/** * @goal sample * @phase compile */ public class MyMojo extends AbstractMojo {

パラメータの受け渡し
Plugin に外部からパラメータを渡す
JavaDoc で記述（ Doclet と同じ）
渡す方法は３つ
起動引数としてパラメータを渡す
-D つきでパラメータを渡す
pom.xml で定義
<configuration> で定義
settings.xml で定義
プロファイルのプロパティに定義
同時に定義された場合
pom.xml ＞ settings.xml ＞起動引数の順で使われる

パラメータの設定
実際のコード例
フィールドに @parameter を記述
例では param という名前で定義される
POM に定義されてるもののみ設定される
起動時パラメータを受け取るには explession を使う
　 /** * @parameter */ private String param;

指定できるパラメータの種類
java.lang.String
java.lang.Integer 、 Double 、 Long
boolean
java.util.Date
java.io.File
java.util.URL
java.util.Map
Collections
配列
その他

登録の仕方
mvn install するだけ
ローカルのリポジトリにインストールされる
${user.home}/.m2/repository
packaging されるときに plugin.xml が作成される
Plugin のパラメータや goal が定義されたもの
mvn install

起動の仕方
mvn {groupID}:{artifactID}:{version}:{goal}
このうち groupID と version は省略できる
POM に plugin が定義されていれば groupID は省略可
Version は最新のものが使われる
groupID が org.apache.maven.plugin は暗黙のうちに省略可
artifactID が maven-XXXXX-plugin であれば maven と plugin が省略できる。
mvn sample:sample mvn jp.canetrash.maven.plugin:maven-sample-plugin:1.0:sample フル指定省略形

デモ

まとめ
MavenPlugin 難しくない！
アイデアしだいでいろんなことができる
3rdParty 製の MavenPlugin もたくさんある
Maven をうまく使ってハッピーに

おわり

http://www.canetrash.jp	267
http://www.slideshare.net	25
http://canetrash.seesaa.net	5
http://blog.seesaa.jp	1
http://72.14.235.132	1
http://webcache.googleusercontent.com	1

Maven2 プラグイン入門

by guestd4898b on Dec 20, 2007

Accessibility

Categories

Tags

Upload Details

Usage Rights

6 Embeds 300

Statistics

Maven2 プラグイン入門 — Presentation Transcript