Maven3 チュートリアル

settings.xmlやparentのpomを含めた設定値を出力します。

# 標準出力に出力する場合
mvn help:effective-pom

# ファイルに出力する場合
mvn help:effective-pom -Doutput=epom.xml

mvn dependency:tree

[INFO] com.example:hello:jar:1.0-SNAPSHOT
[INFO] \- junit:junit:jar:3.8.1:test
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

ソースを編集してみる。

vi src/main/java/com/example/App.java

public static void main( String[] args )
{
    System.out.println( "Hello Maven!" );
}

実行します。

java -cp target/classes com.example.App

src/main配下のクラスで、junitのクラスを使ってみる。

public static void main( String[] args )
{
    // JUnitのクラスを使ってみる。
    junit.framework.TestCase.assertTrue(true);
    System.out.println( "Hello World!" );
}

テストを実行します。

mvn test

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:compile (default-compile) on project hello: Compilation failure
[ERROR] /home/hoge/mvn3-tutorial/example/hello/src/main/java/com/example/App.java:[11,24] パッケージjunit.frameworkは存在しません

なぜコンパイルは失敗したのでしょうか？

hoge.txtを配置してコンパイルしてみよう。 hoge.txtはコピーされる？理由は？

usage: mvn [options] [<goal(s)>] [<phase(s)>]

Options:
 -D,--define <arg>                      Define a system property
 -f,--file <arg>                        Force the use of an alternate POM
                                        file (or directory with pom.xml).
 -h,--help                              Display help information
 -o,--offline                           Work offline
 -P,--activate-profiles <arg>           Comma-delimited list of profiles
                                        to activate
 -s,--settings <arg>                    Alternate path for the user
                                        settings file
 -U,--update-snapshots                  Forces a check for missing
                                        releases and updated snapshots on
                                        remote repositories
 -v,--version                           Display version information
 -X,--debug                             Produce execution debug output

JUnitはtestスコープで使用しているので、 hamcrestもtestスコープとなる。

svnを使用しているとします。

アプリ開発チームが、朝一番でsvn updateすると、PJライブラリに大幅に変更が入っていました。 アプリ開発チームは、新機能作成の途中で、変更されたライブラリの取り込みを余儀なくされました。

• ライブラリ開発者は、バージョン番号をインクリメントして、ライブラリをインハウスリポジトリにデプロイします。
• アプリ開発者は、pom.xmlの<dependency>の<version>を変更して、新しいライブラリを取得します。

アプリ開発チームは、任意のタイミングでバージョンアップを行えます。

そもそも、クラスパスというものが、どのような場面で現れるのか おさらいしましょう。

• src/main/javaがソースフォルダとして認識されている
• src/test/javaがソースフォルダとして認識されている
• 依存ライブラリが追加されている(junit, hamcrest)

• 依存ライブラリJunitが、Mavenローカルリポジトリのjarを参照している

• Text file encoding が UTF-8 に設定されている

pom.xmlを編集して、Eclipse上でUpdate Projectを実行してみましょう。

依存ライブラリを追加します。

<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.9.2</version>
</dependency>

Update Projectを実行し、設定がどう変更したか確認します。

インハウスリポジトリを仲介して、ライブラリの配布を行うことができます。

インハウスリポジトリは、リモートリポジトリへのプロキシ、キャッシュを兼ねることが多いです。

インハウスリポジトリにキャッシュされている場合、リモートリポジトリへのアクセスは発生しません。

以下のプロパティを表示して、どのような値が設定されているか見てみよう。

• project.basedir
• project.name
• project.version
• project.build.finalName
• project.artifactId

# pom.xmlの内容を確認する
cd example/maven_props
vi pom.xml

# 実行してプロパティを表示する。
mvn antrun:run

# mvn verifyを実行する
cd example/plugin
mvn -f pom-checkstyle.xml clean verify

# プラグインを実行するフェーズを変更する。
# 旧: <phase>verify</phase>
# 新: <phase>validate</phase>
vi pom-checkstyle.xml

# mvn verifyを実行する
mvn -f pom-checkstyle.xml clean verify

CheckStyleが実行されるタイミングに変化がありましたか？

どうして、mvn installしたらCheckStyleも実行されたのだろうか？

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <java.version>1.8</java.version>
</properties>

<build>
  <plugins>
    <!-- ここにプラグインの記述を記載します -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.5.1</version>
      <configuration>
        <source>${java.version}</source>
        <target>${java.version}</target>
      </configuration>
    </plugin>
  </plugins>
</build>

vi pom.xml
mvn compile  # mvn -f pom-java8.xml でもOK

# classファイルの中身を確認する
javap -v target/classes/com/example/App.class

  Last modified 2016/02/15; size 537 bytes
  MD5 checksum b675c50db7181ec07a659cfe45c5d67f
  Compiled from "App.java"
public class com.example.App
  minor version: 0
  major version: 52
  flags: ACC_PUBLIC, ACC_SUPER

0x50=Java1.6だけは覚えておくとよい。

モジュールが増えてくると、それぞれのpom.xmlに重複が発生するようになります。 複数のモジュール間で共通の設定を使用したい場合に使用します。

• 共通のプロパティを使用したい（ファイルパス、ファイルエンコーディング等）
• 使用するプラグインのバージョンを揃えたい
• プラグインの設定を共通化したい（CheckStyle, FindBugs等）

cd example/mulit_module/my-batch
# 中身を確認
less pom.xml

# コンパイルしてみる
mvn compile

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building my-batch 1.0.1
[INFO] ------------------------------------------------------------------------
Downloading: https://repo.maven.apache.org/maven2/com/example/my-lib/1.0.1/my-lib-1.0.1.pom
[WARNING] The POM for com.example:my-lib:jar:1.0.1 is missing, no dependency information available
Downloading: https://repo.maven.apache.org/maven2/com/example/my-lib/1.0.1/my-lib-1.0.1.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.875 s
[INFO] Finished at: 2016-03-21T09:44:40+09:00
[INFO] Final Memory: 9M/155M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal on project my-batch: Could not resolve dependencies for project com.example:my-batch:jar:1.0.1: Could not find artifact com.example:my-lib:jar:1.0.1 in central (https://repo.maven.apache.org/maven2) -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/DependencyResolutionException

• コンパイルに必要な依存ライブラリmy-libをローカルリポジトリに探しに行く
• my-lib:1.0.1はまだmvn installされていない
• Mavenセントラルリポジトリからダウンロードしようとする
• ダウンロードできない（見つからない）のでビルドは失敗する

# pom.xml
cd example/multi_module
vi pom.xml

<modules>
  <module>my-batch</module>
  <module>my-lib</module>
  <module>my-web</module>
</modules>

mvn install

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] 
[INFO] my-lib
[INFO] my-batch
[INFO] my-web
[INFO] my-aggregate
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------

cd example/profile/
less pom.xml

<profiles>
  <profile>
    <id>en</id>
    <properties>
      <greeting.message>Hello!</greeting.message>
    </properties>
  </profile>
  <profile>
    <id>ja</id>
    <properties>
      <greeting.message>こんにちは!</greeting.message>
    </properties>
  </profile>
</profiles>

• enとjaというプロファイルが定義されています。
• enというプロファイルはデフォルトで有効になっています。

mvn -P morning antrun:run

メッセージが表示されます。

[INFO] --- maven-antrun-plugin:1.3:run (default-cli) @ profile-test ---
[INFO] Executing tasks
     [echo] Hello!
[INFO] Executed tasks

mvn antrun:run

[INFO] --- maven-antrun-plugin:1.3:run (default-cli) @ profile-test ---
[INFO] Executing tasks
     [echo] ${greeting.message}
[INFO] Executed tasks

プロパティgreeting.messageが設定されなくなったので、プロパティがそのまま表示されてしまいました。

ほぼ毎回、有効にしているプロファイルがある場合、 そのプロファイルをデフォルトで有効になるよう設定できます。

<profiles>
  <profile>
    <id>en</id>
    <!-- このプロファイルをデフォルト有効にする。-->
    <activation>
      <activeByDefault>true</activeByDefault>
    </activation>
    <properties>
      <greeting.message>Hello!</greeting.message>
    </properties>
  </profile>

mvn antrun:run

デフォルトでプロファイルenが有効になりました。

[INFO] --- maven-antrun-plugin:1.3:run (default-cli) @ profile-test ---
[INFO] Executing tasks
     [echo] Hello!
[INFO] Executed tasks

デフォルトでenが有効になっているので、これを無効にして、jaを有効にします。

mvn -P-en,ja antrun:run

[INFO] --- maven-antrun-plugin:1.3:run (default-cli) @ profile-test ---
[INFO] Executing tasks
     [echo] こんにちは!
[INFO] Executed tasks

mvn help:all-profiles

[INFO] --- maven-help-plugin:2.2:all-profiles (default-cli) @ profile-test ---
[INFO] Listing Profiles for Project: com.example:profile-test:jar:1.0.0
  Profile Id: en (Active: true , Source: pom)
  Profile Id: ja (Active: false , Source: pom)

mvn -P-en,ja help:all-profiles

どう変化しましたか？