Maven マルチモジュールプロジェクト管理

Maven マルチモジュールプロジェクト(Multi-module Project)とは、親プロジェクト(parent project)が複数の子モジュール(submodules)を含むプロジェクト構造のことです。この構造により、大規模なプロジェクトを論理的に独立しつつ相互に関連する複数のモジュールに分割でき、各モジュールは単独でビルドすることも、全体として一緒にビルドすることもできます。

マルチモジュールプロジェクトの利点

  1. コードの再利用:共通コードを独立したモジュールに抽出して、他のモジュールで使用できる
  2. 責務の分離:異なるチームが異なるモジュールの開発に集中できる
  3. ビルド効率:変更されたモジュールのみをビルドし、ビルド時間を短縮する
  4. 依存関係の管理:すべてのモジュールの依存関係を一元管理する
  5. バージョン管理:すべてのモジュールが統一されたバージョン番号を使用するため、管理が容易になる

適用シナリオ

  • 大規模プロジェクトの階層化(例:web、service、dao)

  • マイクロサービスアーキテクチャ(各サービスを1つのモジュールにする)

  • 共通コードの共有(例:commonモジュール)

標準ディレクトリ構造

parent-project/          # 父项目根目录
├── pom.xml             # 父POM(packaging=pom)
├── module-a/           # 子模块A
│   ├── src/
│   └── pom.xml         # 子模块A的POM
├── module-b/           # 子模块B
│   ├── src/
│   └── pom.xml         # 子模块B的POM
└── module-web/         # Web模块
    ├── src/
    └── pom.xml

主な特徴:

  1. 親POM:

    • には <modules> の設定が必須です<packaging>pom</packaging>

    • <modules> を通じて<modules>子モジュールを管理します

  2. 子モジュールは:

    • <parent> を通じて<parent>親POMを継承します

    • 独自の依存関係とビルド設定を持つことができます


Maven マルチモジュールプロジェクトの作成

1. 親プロジェクトの作成

親プロジェクト自体には通常コードは含まれず、主に子モジュールと共通設定を管理するために使用されます。

親プロジェクトの pom.xml ファイルでは、packaging を pom に設定する必要があります:

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>parent-project</artifactId>
    <version>1.0.0</version>
    <packaging>pom</packaging>
   
    <modules>
        <module>module1</module>
        <module>module2</module>
    </modules>
</project>

2. 子モジュールの作成

子モジュールは実際のコードモジュールであり、通常の Java プロジェクトや Web アプリケーションなどにすることができます。各子モジュールには独自の pom.xml ファイルがありますが、親プロジェクトを宣言する必要があります:

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>1.0.0</version>
    </parent>
   
    <modelVersion>4.0.0</modelVersion>
    <artifactId>module1</artifactId>
</project>

マルチモジュールプロジェクトの依存関係管理

マルチモジュールプロジェクトでは、モジュール間で相互に依存できます。例えば、module2 が module1 に依存する場合:

<project>
    <!-- module2 の pom.xml -->
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>module1</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>

依存関係の継承

親プロジェクトは共通の依存関係を定義でき、子モジュールはこれらの依存関係を自動的に継承します:

<project>
    <!-- 親プロジェクト pom.xml -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

子モジュールは依存関係の groupId と artifactId を宣言するだけでよく、バージョンを指定する必要はありません:

<project>
    <!-- 子モジュール pom.xml -->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

マルチモジュールプロジェクトのビルド

1. プロジェクト全体のビルド

親プロジェクトのディレクトリで実行します:

mvn clean install

これにより、依存順序に従ってすべての子モジュールがビルドされます。

2. 単一モジュールのビルド

特定のモジュールのディレクトリに移動して実行します:

cd module1
mvn clean install

または、親プロジェクトのディレクトリからモジュールを指定します:

mvn -pl module1 clean install

3. モジュールとその依存関係のビルド

mvn -pl module1 -am clean install

マルチモジュールプロジェクトのベストプラクティス

合理的なモジュール分割

  • 機能ごとにモジュールを分割する
  • 階層ごとにモジュールを分割する(例:dao、service、web)
  • 共通ユーティリティを独立したモジュールに抽出する

2. バージョン管理

  • 親プロジェクトでバージョン番号を一元管理する
  • Maven のバージョンプラグインを使用したバージョンアップグレードの管理を検討する

3. ビルドの最適化

  • 適切なビルド順序を設定する
  • profile を使用して異なる環境のビルドを管理する
  • 並行ビルドを検討して効率を向上させる

4. 依存関係の管理

  • 親プロジェクトで共通の依存関係を集中的に管理する
  • dependencyManagement を使用してバージョンを統一する
  • 循環依存を回避する

よくある問題と解決策

1. 循環依存の問題

問題:モジュール A がモジュール B に依存し、モジュール B もモジュール A に依存している
解決策:

  • モジュール構造を再設計し、共通コードを3つ目のモジュールに抽出する
  • インターフェースを使用して疎結合にする

2. ビルド順序の問題

問題:Maven がモジュール間の依存順序を正しく認識できない
解決策:

  • モジュールの依存関係を明示的に宣言する
  • reactor プラグインを使用してビルド順序を分析する

3. バージョン不一致の問題

問題:異なるモジュールが異なるバージョンの依存関係を使用している
解決策:

  • 親プロジェクトで依存関係のバージョンを一元管理する
  • dependencyManagement を使用する

Maven のマルチモジュールプロジェクト管理を適切に使用することで、大規模プロジェクトの保守性とビルド効率を大幅に向上させることができます。これらのテクニックを習得することで、複雑な Java プロジェクトをより適切に組織化・管理できるようになります。

その他の拡張