Micronautプロジェクトを複数モジュール化する方法！Gradleの構成を解説

1. マルチモジュールプロジェクトの基本構成

1. マルチモジュールプロジェクトの基本構成

Micronautで複数モジュール化を行う最大のメリットは、「役割ごとにプログラムを整理できる」点にあります。特に初心者の方は、一つの場所に全てのコードを書くと管理が大変になりますが、モジュール（部品）ごとに分けることで、どこに何が書いてあるか一目でわかるようになります。

例えば、料理をイメージしてみてください。メイン料理（app）、共通の調味料（common）、下準備の工程（service）と分けるようなイメージです。具体的なディレクトリ構成は以下のようになります。

micronaut-multi-module/  (プロジェクト全体を束ねる親フォルダ)
├── build.gradle        (プロジェクト全体の共通設定)
├── settings.gradle     (どのモジュールを使うか登録するファイル)
├── app/                (実際に動くメインアプリケーション)
│   └── build.gradle
├── common/             (共通で使う便利な道具箱・データ定義)
│   └── build.gradle
└── service/            (計算や判定などのビジネスロジック担当)
    └── build.gradle

このように、一つの大きなプロジェクト（親）の中に、複数の小さなプロジェクト（子モジュール）が同居する形をとります。各モジュールには、それぞれの役割に応じたbuild.gradleを配置し、個別に設定を行うことができます。

例えば、プログラミング未経験の方でもイメージしやすいよう、共通モジュール（common）に「挨拶メッセージ」を管理する簡単なクラスを作ってみましょう。

package com.example.common;

// どのモジュールからでも使える「共通の部品」の例
public class GreetingHelper {
    public static String getWelcomeMessage(String name) {
        return "こんにちは、" + name + "さん！Micronautの世界へようこそ。";
    }
}

この構成にすることで、appモジュールは、このcommonにある挨拶プログラムを「借りてくる」だけで使えるようになります。コードがスッキリし、再利用性が高まるのがマルチモジュールの特徴です。それでは、次にこれらのモジュールをどうやって連携させるかを見ていきましょう。

2. settings.gradleでモジュールを登録する手順

2. settings.gradleでモジュールを登録する手順

Javaのマルチモジュール開発において、最初に行う重要な作業が「プロジェクトの全体像（構成）」をGradleに教えることです。ルートディレクトリにある settings.gradle というファイルに、各サブプロジェクトを登録することで、Gradleが複数のフォルダを一つの大きなシステムとして認識できるようになります。

プログラミング未経験の方でも直感的に理解できるよう、以下のようにシンプルに記述します。例えば、アプリ本体、共通部品、サービス機能の3つに分ける場合の書き方は次の通りです。

// プロジェクト全体に名前を付けます
rootProject.name = 'micronaut-multi-module'

// 読み込みたいフォルダ（サブモジュール）をカンマ区切り、または個別に行で指定します
include 'app'
include 'common'
include 'service'

この設定ファイルは、いわば「プロジェクトの目次」のような役割を果たします。include を使って登録することで、Gradleは app、common、service という各フォルダを独立したモジュールとして管理しつつ、お互いの依存関係を解決して一括でビルド（プログラムを動かせる状態にすること）が可能になります。初心者のうちは、新しい機能フォルダを追加したら、まずここに include を書き足すと覚えておけば間違いありません。

3. サブモジュール間の依存関係設定

3. サブモジュール間の依存関係設定

サブモジュール間の依存関係は、各モジュールのbuild.gradleに記述します。例えば、appモジュールがcommonを利用する場合は以下のように設定します。

dependencies {
    implementation project(':common')
    implementation("io.micronaut:micronaut-runtime")
}

同様に、serviceモジュールもcommonを依存関係に加えることで、共通のユーティリティやモデルクラスを再利用できます。

4. Gradleビルドの活用ポイント

4. Gradleビルドの活用ポイント

マルチモジュール構成では、Gradleのビルドキャッシュや並列ビルドを活用すると効率が向上します。特にMicronautはAOTコンパイルやDIコード生成が含まれるため、サブモジュールごとに並列でビルドすると時間を短縮できます。

# gradle.properties
org.gradle.parallel=true
org.gradle.build-cache=true
org.gradle.daemon=true

これにより、モジュール間の再ビルドが最小限になり、開発効率が大幅に向上します。

5. サンプルプロジェクトのアプリケーションモジュール

5. サンプルプロジェクトのアプリケーションモジュール

簡単なサンプルとして、appモジュールでMicronautアプリケーションを起動する例を示します。

import io.micronaut.runtime.Micronaut;

public class Application {
    public static void main(String[] args) {
        Micronaut.run(Application.class, args);
        System.out.println("Micronautマルチモジュールアプリケーションが起動しました。");
    }
}

Micronautマルチモジュールアプリケーションが起動しました。

この構成で./gradlew buildを実行すると、すべてのモジュールがビルドされ、依存関係も正しく解決されます。

6. モジュール化によるメリットと注意点

6. モジュール化によるメリットと注意点

Micronautプロジェクトをモジュール化することで、以下のメリットがあります。

• 共通ライブラリをサブモジュールとして分離でき、コードの再利用性が向上
• ビルド対象を限定できるため、開発中のビルド時間を短縮可能
• CI/CDで部分的なテストやデプロイが可能になる

注意点としては、モジュール間の依存関係が複雑になると管理が難しくなるため、依存関係を整理しながら設計することが重要です。また、GradleのバージョンやMicronautのバージョンにより設定方法が微妙に異なることがあるので、公式ドキュメントも参考にすると安心です。