# Java Mavenでマルチモジュールを構成する方法

## 目次

1. はじめに

2. Mavenの基礎知識

   1. Mavenとは

   2. Mavenの基本用語

3. マルチモジュールプロジェクトの概念

   1. マルチモジュールとは

   2. メリットとデメリット

4. マルチモジュールプロジェクトの作成ステップ

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

   2. 子モジュールの追加

   3. parent pom.xmlの設定

   4. 各子モジュールの設定

5. 具体的な設定例

   1. parent pom.xmlの例

   2. 子モジュールのpom.xmlの例

6. プロジェクトのビルド

   1. ビルド方法

   2. よくある問題とその対処法

7. 実践例: Sampleプロジェクト構成

   1. ディレクトリ構成

   2. コンパイルと実行

8. まとめ

## 1. はじめに

Javaのプロジェクト管理ツールであるMavenを使用する際、複数のモジュールを組み合わせたプロジェクトが必要になることがあります。ここでは、Mavenでマルチモジュールを構成する方法を詳しく説明します。

## 2. Mavenの基礎知識

### 2-1. Mavenとは

Mavenは、Javaプロジェクトの依存関係管理やビルド自動化を行うツールです。プロジェクトのライフサイクル管理を簡素化し、ビルドを標準化することができます。

### 2-2. Mavenの基本用語

- **POM (Project Object Model):** プロジェクトの設定や依存関係を記述するXMLファイル。

- **依存関係:** プロジェクトが使用する外部ライブラリやモジュール。

- **リポジトリ:** ビルドに必要なライブラリが格納される場所。

## 3. マルチモジュールプロジェクトの概念

### 3-1. マルチモジュールとは

マルチモジュールプロジェクトとは、複数のJavaモジュール（サブプロジェクト）で構成される大規模なアプリケーションを指します。親プロジェクトに複数の子モジュールが存在し、各子モジュールは個別、または共同でビルドが可能です。

### 3-2. メリットとデメリット

- **メリット:**

  - 共通コードの再利用が容易になる。

  - プロジェクトの管理が一元化され、構成が明確になる。

  - 複雑な依存関係を扱いやすくなる。

- **デメリット:**

  - 最初の設定が複雑。

  - モジュール間の依存関係が増えると管理が難しくなる。

## 4. マルチモジュールプロジェクトの作成ステップ

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

親プロジェクトは、他のモジュールをまとめる役割を担います。以下のコマンドで作成します。

```bash

mvn archetype:generate -DgroupId=com.example -DartifactId=parent-project -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

```

### 4-2. 子モジュールの追加

子モジュールは、親の下に作成します。親プロジェクトのディレクトリに移動して以下のコマンドで追加します。

```bash

cd parent-project

mvn archetype:generate -DgroupId=com.example -DartifactId=module1 -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

```

### 4-3. parent pom.xmlの設定

親プロジェクトの`pom.xml`に子モジュールを定義します。

```xml

<modules>

    <module>module1</module>

</modules>

```

### 4-4. 各子モジュールの設定

各子モジュールの`pom.xml`には親への参照を追加します。

```xml

<parent>

    <groupId>com.example</groupId>

    <artifactId>parent-project</artifactId>

    <version>1.0-SNAPSHOT</version>

</parent>

```

## 5. 具体的な設定例

### 5-1. parent pom.xmlの例

親プロジェクトの`pom.xml`は以下のようになります。

```xml

<project xmlns="http://maven.apache.org/POM/4.0.0"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>

    <artifactId>parent-project</artifactId>

    <version>1.0-SNAPSHOT</version>

    <packaging>pom</packaging>

    <modules>

        <module>module1</module>

        <module>module2</module>

    </modules>

    <dependencyManagement>

        

    </dependencyManagement>

    <build>

        

    </build>

</project>

```

### 5-2. 子モジュールのpom.xmlの例

子モジュールの`pom.xml`は以下のようになります。

```xml

<project xmlns="http://maven.apache.org/POM/4.0.0"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>

        <groupId>com.example</groupId>

        <artifactId>parent-project</artifactId>

        <version>1.0-SNAPSHOT</version>

    </parent>

    <artifactId>module1</artifactId>

    <dependencies>

        

    </dependencies>

</project>

```

## 6. プロジェクトのビルド

### 6-1. ビルド方法

Mavenでマルチモジュールプロジェクトをビルドする際は、親プロジェクトのディレクトリで以下のコマンドを実行します。

```bash

mvn clean install

```

このコマンドにより、全てのモジュールがクリーンされ、個々にビルドされます。

### 6-2. よくある問題とその対処法

- **依存関係が解決できない:**

  - `pom.xml`内のグループID、アーティファクトID、バージョンを確認。

  - リポジトリが正しく設定されているか確認。

- **ビルドエラーが発生する:**

  - エラーメッセージを確認し、該当モジュールの設定を修正。

## 7. 実践例: Sampleプロジェクト構成

### 7-1. ディレクトリ構成

以下は、プロジェクトのディレクトリ構成の一例です。

```

parent-project/

│

├── pom.xml

├── module1/

│   └── pom.xml

└── module2/

    └── pom.xml

```

### 7-2. コンパイルと実行

プロジェクトをビルドした後、各モジュールのJarファイルを実行できます。以下は例としてのコマンドです。

```bash

java -jar module1/target/module1-1.0-SNAPSHOT.jar

```

## 8. まとめ

Java Mavenでのマルチモジュールプロジェクト構成は、複数モジュールの管理を容易にし、大規模プロジェクトに適したアプローチです。正確な依存関係の管理やプロジェクトの構造化が可能になり、持続可能な開発をサポートします。本記事を通して、マルチモジュール構成の基礎を理解し、実際のプロジェクトに活用してください。

Java Mavenでマルチモジュールを構成する方法

目次

続きを読むには単価診断を受けてください（30秒）