Maven を使った Java project 作成方法

はじめに

Maven の Archetype Plugin を使って Java project を作成する方法と、その project に対する Maven の基本操作について説明する。

Maven のコマンドを1つ実行するだけで、
Hellow World プログラムの source file と test file が自動で作成される。

Project の作成

以下の Maven コマンドを実行すると、 Java project が作成される。

mvn archetype:generate \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false \
  -DgroupId={group-id} \
  -DartifactId={project-name}

例えば、 {group-id} を com.sample 、 {project-name} を hello とする場合は、以下のコマンドを実行すればよい。

mvn archetype:generate \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false \
  -DgroupId=com.sample \
  -DartifactId=hello

生成されるディレクトリとファイルの構成は以下の通り。

hello
|-- pom.xml
`-- src
    |-- main
    |   `-- java
    |       `-- com
    |           `-- sample
    |                   `-- App.java
    `-- test
        `-- java
            `-- com
                `-- sample
                        `-- AppTest.java

Maven の基本操作

コンパイルと実行

以下のコマンドを project のトップディレクトリ(上記の例の hello ディレクトリ)で実行すると、src ディレクトリ配下にあるアプリケーションの source file がコンパイルされる。

mvn compile

トップディレクトリ配下に target ディレクトリが作成され、その配下に class file が生成される。

hello
|-- pom.xml
|-- src
|   |-- main
|   |   `-- java
|   |       `-- com
|   |           `-- sample
|   |                   `-- App.java
|   `-- test
|       `-- java
|           `-- com
|               `-- sample
|                       `-- AppTest.java
`-- target
    `-- classes
        `-- com
            `-- sample
                    `-- App.class

トップディレクトリで以下のコマンドを実行すれば、自動生成された class ファイルを実行できる。

java -cp target/classes/ com.sample.App

テスト

mvn test

test ディレクトリ配下のテストコードをコンパイルし、実行する。

clean

mvn clean

target ディレクトリを削除し、 build data を全て削除する。

補足

Maven 3.1.1 をインストールした環境で、上記コマンドの動作確認を行った。

参考

• Maven - Download Apache Maven

  • Maven のダウンロードページ。
  • Maven のインストール方法についても書いてある。

• Maven - Maven Getting Started Guide

  • Maven の基本的な使い方について。

• How to create a Java project with Maven

  • Maven の Archetype Plugin を使って Java project を作成する方法について説明している。