2006.05.31 株式会社四次元データ 鈴木 圭
- 2.1. Maven のアーキテクチャ
- 2.2. Maven の実行
- 2.3. プロジェクトの作成
- 2.4. pom.xml について
- 2.5. コンパイル
- 2.6. ユニットテスト
- 2.7. ドキュメンテーション
- 2.8. JAR ファイルの作成
- 2.9. ローカルリポジトリへのインストール
- 2.10. リモートリポジトリへの配備
- 2.11. プロジェクトのクリーン
- 2.12. まとめ
2.5. コンパイル
プロジェクトをコンパイルするには次のコマンドを実行します:
mvn compile
先ほど作成したプロジェクトには、"Hello World!" と出力するだけのソースファイル (src/main/java/com/example/App.java) が含まれているので、それのコンパイルが行われます。
コンパイルにより作成されたクラスファイルは target/classes ディレクトリに出力されます。
2.6. ユニットテスト
ユニットテストを実行するには次のコマンドを実行します:
mvn test
デフォルトでは、以下のパターンにマッチするファイルがテストとして実行されます:
- **/Test*.java
- **/*Test.java
- **/*TestCase.java
また、以下のファイルはデフォルトで除外されます:
- **/Abstract*Test.java
- **/Abstract*TestCase.java
- **/*$*
先ほど作成したプロジェクトには、常に成功するユニットテスト(src/test/com/example/AppTest.java) が含まれているので、それが実行されます。
2.7. ドキュメンテーション
Maven では Javadoc の作成やプロジェクトのサイトの作成など、ドキュメンテーションに関する機能も存在します。
2.7.1. Javadoc の作成
Javadoc を作成するには次のコマンドを実行します:
mvn javadoc:javadoc
実行すると、target/javadoc ディレクトリに Javadoc が作成されます。
2.7.2. サイトの作成
オープンソース・プロジェクトではドキュメンテーションなどの情報発信が貧弱になりがちだといわれることもありますが、 Maven ではプロジェクトのサイトを簡単に作成することができます。
サイトの作成は次のコマンドを実行します:
mvn site
作成されるサイトには、プロジェクトの依存するライブラリの情報などが含められます。
ただ、現状では文字列処理が正しく行われないらしく、 日本語などのマルチバイト文字が文字化けしてしまう問題があります。
Maven の標準ディレクトリ構成では、サイトの作成に必要なデータを src/site ディレクトリ以下に配置することになっています。 しかし、通常のプロジェクトを作成すると、src/site ディレクトリは作成されません。
サイトの作成に関する情報は src/site/site.xml に記述しますが、 このファイルが無い場合はデフォルトの設定でサイトが作成されます。 デフォルトのままでもそれなりのサイトが作成されますが、 もう少し情報量のある (例えば Javadoc やユニットテストのレポートを持つ) サイトを作成する場合は、 手作業で src/site ディレクトリ以下のファイルを作成するか、別にサイト用のプロジェクトを作成します。 または、サイト用のプロジェクトを作成し、そこから src/site 以下のファイルだけコピーします。