Javaモジュールシステムによるパッケージ単位の可視性制御☕

はじめに (対象読者・この記事でわかること)

この記事は、Javaプログラミングの中級者以上を対象としています。特に、大規模なアプリケーション開発において、モジュール間の依存関係を明確にし、セキュリティを高めるための可視性制御に興味がある方に最適です。

この記事を読むことで、Javaのモジュールシステムを活用して、特定のパッケージやJARファイルに対してのみ公開する可視性設定を実装できるようになります。また、アクセス修飾子とモジュール宣言を組み合わせた高度な可視性制御テクニックを習得し、より安全で保守性の高いコードを書くことができるようになります。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

• Javaの基本的なプログラミング知識
• パッケージとアクセス修飾子の理解
• JARファイルの基本的な知識
• MavenやGradleなどのビルドツールの基本的な操作

Javaの可視性制御とモジュールシステムの概要

Javaでは、従来からアクセス修飾子（public、protected、private、パッケージプライベート）を用いてクラスやメソッドの可視性を制御してきました。しかし、大規模なアプリケーション開発においては、パッケージ単位での可視性制御や、特定のJARファイルに対してのみ公開する必要が生じることがあります。

Java 9で導入されたモジュールシステムは、このような課題を解決するための強力なツールです。モジュールシステムは、パッケージをまとめて「モジュール」とし、モジュール間の依存関係を明示的に定義することで、より厳密なカプセル化を実現します。これにより、意図しないクラスの公開を防ぎ、セキュリティと保守性を向上させることができます。

本記事では、Javaのモジュールシステムを活用して、特定のパッケージやJARファイルに対してのみ公開する可視性設定を実装する方法について詳しく解説します。

モジュールシステムを活用した可視性制御の実装方法

ここでは、Javaのモジュールシステムを活用して、特定のパッケージやJARファイルに対してのみ公開する可視性設定を実装する具体的な手順を解説します。

ステップ1：モジュール宣言ファイルの作成

まず、モジュールシステムを利用するために、モジュール宣言ファイル（module-info.java）を作成します。このファイルは、モジュールの名前、依存関係、エクスポート（公開）するパッケージを定義します。

以下は、モジュール宣言ファイルの基本的な構造です。

Java

module com.example.myapp {
    // 依存するモジュールを宣言
    requires java.base;
    requires java.sql;

    // 公開するパッケージを宣言
    exports com.example.myapp.api;

    // 特定のモジュールにのみ公開するパッケージを宣言
    exports com.example.myapp.internal to com.example.client, com.example.partner;
}

上記の例では、com.example.myapp.apiパッケージはすべてのモジュールに公開されますが、com.example.myapp.internalパッケージはcom.example.clientモジュールとcom.example.partnerモジュールにのみ公開されます。

ステップ2：パッケージの可視性制御

モジュール宣言ファイルでパッケージをエクスポートすることで、そのパッケージ内のpublicクラスが他のモジュールからアクセス可能になります。エクスポートしないパッケージは、モジュール外からアクセスできず、カプセル化が強化されます。

以下に、パッケージの可視性を制御する具体的な例を示します。

Java

// com.example.myapp.apiパッケージのクラス
package com.example.myapp.api;

public class ApiService {
    public String getData() {
        return "公開されたAPIデータ";
    }
}

// com.example.myapp.internalパッケージのクラス
package com.example.myapp.internal;

public class InternalService {
    public String getInternalData() {
        return "内部データ";
    }
}

上記の例では、ApiServiceクラスはエクスポートされているため、他のモジュールからアクセスできますが、InternalServiceクラスはエクスポートされていないため、モジュール外からアクセスできません。

ステップ3：特定のJARファイル向けの可視性設定

特定のJARファイルに対してのみ公開する可視性設定を実現するには、モジュール宣言ファイルのexportsディレクティブにto句を使用します。これにより、指定されたモジュールのみがエクスポートされたパッケージにアクセスできます。

以下に、特定のJARファイル向けの可視性設定を実装する例を示します。

まず、クライアント側のモジュール宣言ファイルを作成します。

Java

// clientモジュールのmodule-info.java
module com.example.client {
    requires com.example.myapp;
}

次に、パートナー側のモジュール宣言ファイルを作成します。

Java

// partnerモジュールのmodule-info.java
module com.example.partner {
    requires com.example.myapp;
}

これにより、com.example.myapp.internalパッケージはcom.example.clientモジュールとcom.example.partnerモジュールにのみ公開され、他のモジュールからはアクセスできなくなります。

ハマった点やエラー解決

モジュールシステムを活用した可視性制御を実装する際には、いくつかの落とし穴があります。

1. モジュールパスの設定ミス モジュールシステムを正しく動作させるためには、JARファイルがモジュールパスに配置されている必要があります。クラスパスに配置してしまうと、モジュールとして認識されず、意図しない動作を引き起こす可能性があります。

エラーメッセージ例： java.lang.module.FindException: Module com.example.myapp not found, required by com.example.client

2. エクスポートしていないパッケージへのアクセス試行 エクスポートしていないパッケージにアクセスしようとすると、コンパイル時や実行時にエラーが発生します。

エラーメッセージ例： java.lang.IllegalAccessError: class com.example.client.ClientService (in module com.example.client) cannot access class com.example.myapp.internal.InternalService (in module com.example.myapp) because module com.example.myapp does not export com.example.myapp.internal to module com.example.client

3. 循環依存の問題 モジュール間で循環依存が発生すると、コンパイルエラーや実行時の問題が発生します。モジュールの依存関係を慎重に設計する必要があります。

解決策

上記の問題を解決するための対策を以下に示します。

1. モジュールパスの設定ミスの解決 ビルドツール（MavenやGradle）を使用している場合、pom.xmlやbuild.gradleファイルでモジュールパスを正しく設定します。以下にMavenの例を示します。

xml <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <release>11</release> <compilerArgs> <arg>--module-path</arg> <arg>${project.build.directory}/modules</arg> </compilerArgs> </configuration> </plugin>

2. エクスポートしていないパッケージへのアクセス試行の解決 モジュール宣言ファイルで必要なパッケージをエクスポートするか、アクセス元のモジュールをto句で指定します。

java module com.example.myapp { // ... exports com.example.myapp.internal to com.example.client; }

3. 循環依存の問題の解決 モジュールの依存関係を再設計し、循環依存を解消します。必要に応じて、共通のインターフェースモジュールを導入することも検討します。

まとめ

本記事では、Javaのモジュールシステムを活用して、特定のパッケージやJARファイルに対してのみ公開する可視性設定を実装する方法について解説しました。

• モジュール宣言ファイル（module-info.java）を作成し、exportsディレクティブで公開するパッケージを指定する
• to句を使用することで、特定のモジュールにのみパッケージを公開できる
• エクスポートしていないパッケージはモジュール外からアクセスできず、カプセル化が強化される

この記事を通して、Javaのモジュールシステムを活用した高度な可視性制御テクニックを習得し、より安全で保守性の高いコードを書くことができるようになったことと思います。

今後は、Javaモジュールシステムを活用したマイクロサービスアーキテクチャの設計や、モジュール間の通信最適化についても記事にする予定です。

参考資料

• Java Platform, Standard Edition 9 - The Java™ Tutorials
• Java Module System - Baeldung
• Java Module System - Oracle Documentation
• Effective Java 3rd Edition - Joshua Bloch