第3章 クラスローディングとモジュール

1. モジュールの依存関係を追加するソフトウェアプロジェクト。
2. 依存関係として追加するモジュールの名前を知っている必要があります。JBoss EAP に含まれる静的モジュールのリストについては、「含まれるモジュール」を参照してください。モジュールが他のデプロイメントである場合は、JBoss EAP『設定ガイド』の「動的モジュールの命名規則」を参照してモジュール名を判断してください。

1. MANIFEST.MF ファイルがプロジェクトにない場合は、この名前のファイルを作成します。Web アプリケーション (WAR) では、このファイルを META-INF/ ディレクトリーに追加します。EJB アーカイブ (JAR) では、このファイルを META-INF/ ディレクトリーに追加します。

2. 依存関係モジュール名をコンマで区切り、依存関係エントリーを MANIFEST.MF ファイルへ追加します。

   Dependencies: org.javassist, org.apache.velocity, org.antlr

   • 依存関係をオプションにするには、依存関係エントリーのモジュール名に optional を付けます。

     Dependencies: org.javassist optional, org.apache.velocity

   • 依存関係エントリーのモジュール名に export を付けると、依存関係をエクスポートすることができます。

     Dependencies: org.javassist, org.apache.velocity export

   • annotations フラグは、EJB インターセプターを宣言するときなど、アノテーションのスキャン中に処理する必要があるアノテーションがモジュールの依存関係に含まれる場合に必要になります。この設定を行わないと、モジュールに宣言された EJB インターセプターをデプロイメントで使用できません。アノテーションのスキャンが関係するその他の状況でも、この設定が必要になる場合があります。

     Dependencies: org.javassist, test.module annotations

   • デフォルトでは、依存関係の META-INF 内のアイテムにはアクセスできません。services 依存関係により META-INF/services のアイテムにアクセスできるようになり、モジュール内の services をロードできるようになります。

     Dependencies: org.javassist, org.hibernate services

   • beans.xml ファイルをスキャンし、生成される Bean をアプリケーションが利用できるようにするために、meta-inf 依存関係を使用できます。

     Dependencies: org.javassist, test.module meta-inf

1. jboss-deployment-structure.xml という名前の新しいファイルを作成し (アプリケーションにない場合)、プロジェクトに追加します。このファイルは <jboss-deployment-structure> がルート要素の XML ファイルです。

   <jboss-deployment-structure>
   
   </jboss-deployment-structure>

   Web アプリケーション (WAR) では、このファイルを WEB-INF/ ディレクトリーに追加します。EJB アーカイブ (JAR) では、このファイルを META-INF/ ディレクトリーに追加します。

2. <deployment> 要素をドキュメントルート内に作成し、その中に <dependencies> 要素を作成します。

3. <dependencies> ノード内に各モジュールの依存関係に対するモジュール要素を追加します。name 属性をモジュールの名前に設定します。

   <module name="org.javassist" />

   • 値が true のモジュールエントリーに optional 属性を追加することにより依存関係をオプションにすることができます。この属性のデフォルト値は false です。

     <module name="org.javassist" optional="true" />

   • 値が true のモジュールエントリーに export 属性を追加することにより依存関係をエクスポートできます。この属性のデフォルト値は false です。

     <module name="org.javassist" export="true" />

   • アノテーションのスキャン中に処理する必要があるアノテーションがモジュール依存関係に含まれる場合は、annotations フラグが使用されます。

     <module name="test.module" annotations="true" />

   • services 依存関係は、この依存関係にある services を使用するかどうか、およびどのように使用するかを指定します。デフォルト値は none です。この属性に import の値を指定することは、依存関係モジュールの META-INF/services パスを含むインポートフィルターリストの最後にフィルターを追加することと同じです。この属性に export の値を設定することは、エクスポートフィルターリストに対して同じアクションを実行することと同じです。

     <module name="org.hibernate" services="import" />

   • META-INF 依存関係は、この依存関係の META-INF エントリーを使用するかどうか、およびどのように使用するかを指定します。デフォルト値は none です。この属性に import の値を指定することは、依存関係モジュールの META-INF/** パスを含むインポートフィルターリストの最後にフィルターを追加することと同じです この属性に export の値を設定することは、エクスポートフィルターリストに対して同じアクションを実行することと同じです。

     <module name="test.module" meta-inf="import" />

Jandex インデックスの作成:

1. インデックスを作成します。

   java -jar modules/system/layers/base/org/jboss/jandex/main/jandex-jandex-2.0.0.Final-redhat-1.jar $JAR_FILE

2. 一時作業領域を作成します。

   mkdir /tmp/META-INF

3. インデックスファイルをワーキングディレクトリーへ移動します。

   mv $JAR_FILE.ifx /tmp/META-INF/jandex.idx

   1. オプション 1: インデックスを新しい JAR ファイルに含めます。

      jar cf index.jar -C /tmp META-INF/jandex.idx

      JAR をモジュールディレクトリーに置き、 module.xml を編集してリソースルートへ追加します。

   2. オプション 2: インデックスを既存の JAR に追加します。

      java -jar /modules/org/jboss/jandex/main/jandex-1.0.3.Final-redhat-1.jar -m $JAR_FILE

4. アノテーションインデックスを使用するようモジュールインポートに指示し、アノテーションのスキャンでアノテーションを見つけられるようにします。

   1. オプション 1: MANIFEST.MF を使用してモジュールの依存関係を追加する場合は、annotations をモジュール名の後に追加します。例を以下に示します。

      Dependencies: test.module, other.module

      上記を以下に変更します。

      Dependencies: test.module annotations, other.module

   2. オプション 2: jboss-deployment-structure.xml を使用してモジュールの依存関係を追加する場合は、モジュールの依存関係に annotations="true" を追加します。

      注記

      静的モジュール内のクラスで定義されたアノテーション付き Java EE コンポーネントをアプリケーションで使用する場合は、アノテーションインデックスが必要です。JBoss EAP 7.1 では、静的モジュールのアノテーションインデックスは自動的に生成されるため、作成する必要がありません。ただし、MANIFEST.MF または jboss-deployment-structure.xml ファイルのいずれかに依存関係を追加して、アノテーションを使用するようモジュールインポートに指示する必要があります。

1. プロジェクトの pom.xml ファイルにあるパッケージングプラグイン設定に次の設定を追加します。

   <configuration>
      <archive>
         <manifestEntries>
            <Dependencies></Dependencies>
         </manifestEntries>
      </archive>
   </configuration>

2. モジュール依存関係のリストを <Dependencies> 要素に追加します。MANIFEST.MF ファイルに依存関係を追加するときと同じ形式を使用します。

   <Dependencies>org.javassist, org.apache.velocity</Dependencies>

   ここでは、optional 属性と export 属性を使用することもできます。

   <Dependencies>org.javassist optional, org.apache.velocity export</Dependencies>

3. Maven アセンブリーゴールを使用してプロジェクトをビルドします。

   [Localhost ]$ mvn assembly:single

   アセンブリーゴールを使用してプロジェクトをビルドすると、指定のモジュール依存関係を持つ MANIFEST.MF ファイルが最終アーカイブに含まれます。

   例: pom.xml で設定されたモジュール依存関係

   注記

   この例は WAR プラグインの例になりますが、JAR や EJB プラグイン (maven-jar-plugin や maven-ejb-plugin) でも動作します。

   <plugins>
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-war-plugin</artifactId>
         <configuration>
            <archive>
               <manifestEntries>
                  <Dependencies>org.javassist, org.apache.velocity</Dependencies>
               </manifestEntries>
            </archive>
         </configuration>
      </plugin>
   </plugins>

jboss-deployment-structure.xml への依存関係除外設定の追加

1. jboss-deployment-structure.xml という名前の新しいファイルを作成し (アプリケーションにない場合)、プロジェクトに追加します。このファイルは <jboss-deployment-structure> がルート要素の XML ファイルです。

   <jboss-deployment-structure>
   
   </jboss-deployment-structure>

   Web アプリケーション (WAR) では、このファイルを WEB-INF/ ディレクトリーに追加します。EJB アーカイブ (JAR) では、このファイルを META-INF/ ディレクトリーに追加します。

2. <deployment> 要素をドキュメントルート内に作成し、その中に <exclusions> 要素を作成します。

   <deployment>
      <exclusions>
   
      </exclusions>
   </deployment>

3. exclusions 要素内で、除外する各モジュールに対して <module> 要素を追加します。 name 属性をモジュールの名前に設定します。

   <module name="org.javassist" />

   例: 2 つのモジュールの除外

   <jboss-deployment-structure>
      <deployment>
         <exclusions>
            <module name="org.javassist" />
            <module name="org.dom4j" />
         </exclusions>
      </deployment>
   </jboss-deployment-structure>

サブシステムの除外

1. jboss-deployment-structure.xml ファイルを編集します。

2. <deployment> タグ内に以下の XML を追加します。

   <exclude-subsystems>
     <subsystem name="SUBSYSTEM_NAME" />
   </exclude-subsystems>

3. jboss-deployment-structure.xml ファイルを保存します。

1. 管理 CLI を使用して、JBoss EAP インスタンスへ接続し、以下のコマンドを実行して TLD JAR が含まれるカスタムモジュールを作成します。

   module add --name=MyTagLibs --resources=/path/to/TLDarchive.jar

   重要

   module 管理 CLI コマンドを使用したモジュールの追加および削除は、テクノロジープレビューとしてのみ提供されます。このコマンドは、管理対象ドメインでの使用や、リモートによる管理 CLI への接続時には適していません。本番環境では、モジュールを手作業で追加および削除する必要があります。詳細は、JBoss EAP『設定ガイド』の「カスタムモジュールの手動作成」および「手作業によるカスタムモジュールの削除」を参照してください。

   テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあるため、Red Hat は本番環境での使用は推奨しません。テクノロジープレビューの機能は、最新の技術をいち早く提供して、開発段階で機能のテストやフィードバックの収集を可能にするために提供されます。

   テクノロジープレビュー機能のサポート範囲については、Red Hat カスタマーポータルの「テクノロジプレビュー機能のサポート範囲」を参照してください。

   TLD が依存関係を必要とするクラスとともにパッケージ化されている場合は、--dependencies オプションを使用して、カスタムモジュールの作成時にこれらの依存関係を指定するようにします。

   モジュールを作成するときに、システムのファイルシステム固有の区切り文字を使用して複数の JAR リソースを指定できます。

   • Linux の場合 - : 例、--resources=<path-to-jar>:<path-to-another-jar>

   • Windows の場合 - : 例、--resources=<path-to-jar>;<path-to-another-jar>

     注記

     --resources

     これは --module-xml を使用しない限り必要です。ファイルシステム固有のパス区切り文字 (たとえば、java.io.File.pathSeparatorChar) で区切られたファイルシステムパス (通常は JAR ファイル) をリストします。指定されたファイルは作成されたモジュールのディレクトリーにコピーされます。

     --resource-delimiter

     これは、リソース引数のオプションのユーザー定義パス区切り文字です。この引数が存在する場合、コマンドパーサーはファイルシステム固有のパス区切り文字の代わりにその値を使用します。これにより、modules コマンドをクロスプラットフォームのスクリプトで使用できるようになります。

2. ご使用のアプリケーションで、デプロイメントへの明示的なモジュール依存関係の追加で説明されているいずれかの方法を使用して新しい MyTagLibs カスタムモジュールの依存関係を宣言します。