mevenについてのメモ2

Apache Maven(自サイト)

■eclipseのmavenプラグインについて。
環境はos:windows7 64bit,eclipse:pleiades indigo(3.7)
all in oneのpleiadesなのにmavenのプラグインは入っていないのでそれを導入。ヘルプ⇒eclipseマーケットプレースでmavenかm2eで検索してMaven Integration for Eclipse WTP(juno)をインストールする。junoは4.2なんだけど・・・このインストールはマーケットプレースウインドウで完了を押してからも結構時間がかかる。インストールが完了したらeclipseの再起動を要求される。

再起動してmavenがインストールされていれば、新規⇒プロジェクトでmavenプロジェクトが作れるようになっているし、mavenプロジェクトがあってpom.xmlを右クリックして実行しようとするとmaven clean,install,ビルドとかが実行できるようになっている。あと、pom.xmlのdependencyで必要なライブラリを書けば、リアルタイムでそのjライブラリarファイルをmaven依存関係に導入してくれる。やはりこれ便利。実際にjarがあるディレクトリはデフォだとC:\Users\ユーザ名\.m2\repositoryディレクトリ以下

mavenプロジェクトをeclipseプロジェクトに変換前にインポートはできるけど、それでmainメソッドがあるクラスファイルを選択して実行してもエラーが発生する。「エラー: メイン・クラスHogeEntryが見つからなかったかロードできませんでした」しっかりeclipseように変換する必要がある。コマンドは「mvn eclipse:eclipse」。

eclipseからのインポートについて。mavenの「Existing Maven Projects」でできる。一般の既存プロジェクトからワークスペースへだと文字化けした。ただ、mavenプロジェクトに変換前にインポートして、その後にmavenプロジェクトへ変換すれば問題なかった。

バッチとかのただのmavenプロジェクトの場合、エントリポイントのmainメソッドがあるクラスを指定する必要があり、それはpom.xmlファイルのpluginタグの中のmainClassタグ。結構階層が深い。下に例を書く。

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>lib</classpathPrefix>
<mainClass>hogepackage1.HogeEntry</mainClass>
</manifest>
</archive>
</configuration>
</plugin>

■mavenでよく使うコマンド
・mvn clean
⇒targetディレクトリを削除する
・mvn compile
⇒target\classesディレクトリを作成し、その下にクラスファイルを生成する
・mvn package
⇒mvn compileに加え、targetディレクトリ下にクラスファイルを纏めたjarファイルを生成してくれる。ただ、外部jarを使う場合(mavenを使うぐらいなら必ず外部jarを使っている)、その外部jarを取り込んでいたいので実行しようとするとエラーが出る。
また、jarファイルの中身一覧を見たい場合「jar tvf target\hoge1.0.jar」
・mvn install
⇒mvn packageに加え、target\libディレクトリを作成し、その下にpom.xmlで書いた外部jarと依存関係のあるjarをすべて取り込んでくれる。なので、java -jar hoge1.0.jarが実行できるようになる。
(mavne installでtestのコンパイル・実行をスキップしたい時は「mvn install -Dmaven.test.skip=true」、テストの実行だけをスキップしたい時は「mvn install -DskipTests=true」)

コマンドラインからの実行とeclipse上のpom.xmlファイルから実行する場合の結果は少し異なる。上で書いたことはコマンドラインから実行した場合。あと、mvn installで外部jarを取り込んだり実行可能なjarを生成したい場合に必要なプラグインが二つある。それをpom.xmlファイルに書く。


<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>2.8</version>
<executions>
<execution>
<id>copy-dependencies</id>
<phase>install</phase>
<goals>
<goal>copy-dependencies</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>lib</classpathPrefix>
<mainClass>hogepackage.HogeEntry</mainClass>
</manifest>
</archive>
</configuration>
</plugin>

ref : 今まで知らなかった 5 つの事項: Apache Maven.実行可能なjarファイル

■実行可能なjarを生成する
targetディレクトリ下の成果物のjarとlibディレクトリの外部jarを一緒にして実行可能なjarを生成したい場合、pom.xmlファイルのpluginsディレクトリに下のように書く。

<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptorRefs>
<!-- ここはこのままでOK -->
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<!-- ここにmain関数のあるクラスを指定。これがManifest.mfに設定されます -->
<mainClass>hogePackge.hogeEntry</mainClass>
</manifest>
</archive>

</configuration>
<executions>
<!-- ここでpackageのPhaseで実行されるように設定している-->
<execution>
<id>make-assembly</id> <!-- this is used for inheritance merges -->
<phase>package</phase> <!-- append to the packaging phase. -->
<goals>
<goal>single</goal> <!-- goals == mojos -->
</goals>
</execution>
</executions>

</plugin>

参考サイト:Mavenで、依存ライブラリのjarを含んだ実行可能なjarを生成する方法

これでmvn installを実行すると、targetディレクトリ下にhogeBatch1.0-jar-with-dependencies.jarを生成する。ただ、外部jarはhoge-1.0-jar-with-dependencies.jarの中にjarを展開してクラスファイル一覧にしている。これはうざい。うまくやれば、外部jarのままで成果物のjarの中に取り込んでくれると思うんだけど、今は緊急性を求められていないので放置している。

■pom.xmlのデフォルトプロパティ
・pom.xmlには${project.build.directory}のような組み込みのプロパティがいくつもある。
ref:pom.xmlファイルからプロパティ取得

■jenkinsからmavenを呼び出しjarを生成する
jenkinsの新規ジョブでMaven2/3プロジェクトのビルドを選択する。ビルドのpom.xmlで「C:\pleiades\maven\HogePrj\pom.xml」みたいな感じでpom.xmlファイルを指定する。ゴールとオプションは例えばinstallとか。これはコマンド「mvn install」と同じ。これで単純な設定は完了。ビルド実行し、正常に終了すれば、targetディレクトリ下にゴール成果物のjarファイルが生成される。jenkinsからはもっといろいろできる・・・

■eclipse上でエラー
mavenプロジェクトで実行できるし、mvnコマンドもできるんだけど、エラーアイコンが表示されることがある。マーカーびゅーの問題項目を見ると、「Project configuration is not up-to-date with pom.xml. Run Maven->Update Project or use Quick Fix」というメッセージ。解決方法は、プロジェクトを右クリック⇒maven⇒プロジェクトの更新(Alt+F5)。これで直るはず。

■ビルドサイクル
mavenにはビルドサイクルがある。dafault,clean,siteの3つ。defaultは、validate,compile,test,package,integration-test,verify,install,deploy。mvn installを実行した場合、validate~installが実行される。