Tomcat クラスローダーの実装方法とサンプルコード

Tomcat は内部的に複数の ClassLoader を定義し、アプリケーションとコンテナーが異なるリポジトリ内のクラスとリソースにアクセスできるようにしながら、アプリケーション間のクラスの分離を実現します。

1. Javaクラスローディングメカニズム

クラスのロードとは、コンパイルされたクラスファイルを JVM メモリ (永続世代/メタスペース) にロードすることです。

クラスローダーがクラスの分離を実現できる理由は、2 つのクラスが同じクラスローダーによってロードされた場合にのみ等しくなり、そうでない場合は等しくなくなるためです。

ロード時に、JVM は親委任メカニズムを使用します。クラスローダーがクラスをロードする場合、ロード順序は次のようになります。

まず、リクエストは親ローダーに委任されます。親ローダーがロードするクラスを見つけられない場合は、独自のリポジトリを探してロードを試みます。

このメカニズムの利点は、コアクラスライブラリが上書きされないようにできることです。

サーブレット仕様によると、Web アプリケーションローダーは少し異なります。Web アプリケーションローダーは、上位に委任するのではなく、まず独自のリソースライブラリを検索し、標準の委任メカニズムを破壊します。Tomcat の設計と実装を見てみましょう。

2. Tomcatクラスローダーの設計

Tomcat の全体的なクラスローダー構造は次のとおりです。

JDK が提供するクラスローダーは次のとおりです。

ブートストラップ - ブートストラップクラスローダーは JVM の一部で、<JAVA_HOME>/lib/ ディレクトリ内の特定のファイルをロードします。拡張機能 - 拡張機能クラスローダーは、<JAVA_HOME>/lib/ext/ ディレクトリ内のクラスライブラリをロードします。アプリケーション - アプリケーションクラスローダーはシステムクラスローダーとも呼ばれ、CLASSPATH で指定されたクラスライブラリをロードします。

Tomcat が実装するクラスローダーは次のとおりです。

Common - 親ローダーは AppClassLoader で、デフォルトで ${catalina.home}/lib/ ディレクトリのクラスライブラリをロードします。 Catalina - 親ローダーは Common クラスローダーで、catalina.properties 構成ファイルの server.loader によって構成されたリソースをロードします。これらのリソースは通常、Tomcat によって内部的に使用されるリソースです。 Shared - 親ローダーは Common クラスローダーで、catalina.properties 構成ファイルの shared.loader によって構成されたリソースをロードします。これらのリソースは通常、すべての Web アプリケーションによって共有されるリソースです。 WebappX - 親ローダーは Shared ローダーで、/WEB-INF/classes のクラスと /WEB-INF/lib/ の jar パッケージをロードします。 JasperLoader - 親ローダーは Webapp ローダーで、作業ディレクトリの JSP アプリケーションをコンパイルすることによって生成されたクラスファイルをロードします。

実装上、上図は継承関係ではなく、組み合わせによる親子関係となります。 Tomcat クラスローダーのソースコードクラスダイアグラム:

Common、Catalina、Shared はすべて StandardClassLoader のインスタンスです。デフォルトでは、それらは同じオブジェクトを参照します。 StandardClassLoader と URLClassLoader の間に違いはありません。WebappClassLoader は仕様に従って次の順序で検索して読み込みます。

JVM 内の Bootstrap リポジトリからロードアプリケーションローダーパス (CLASSPATH) からロード Web プログラム内の /WEB-INF/classes ディレクトリからロード Web プログラム内の /WEB-INF/lib 内の jar ファイルからロードコンテナの共通ローダーリポジトリ (すべての Web プログラムで共有されるリソース) からロード

次に、ソースコードの実装を見てみましょう。

3. カスタムローダーの初期化

共通クラスローダーは、Bootstrap の initClassLoaders で初期化されます。ソースコードは次のとおりです。

プライベートvoid initClassLoaders() {
 試す {
 commonLoader = createClassLoader("common"、null);
 共通ローダーが null の場合
  // 設定ファイルはありません。このローダーがデフォルトになります。単一の環境にある可能性があります。
  共通ローダー = this.getClass().getClassLoader();
 }
 //リポジトリ パス構成ファイルのプレフィックスと親ローダーを指定して、ClassLoader インスタンスを作成します。catalinaLoader = createClassLoader("server", commonLoader);
 sharedLoader = createClassLoader("shared", commonLoader);
 } キャッチ (Throwable t) {
 log.error("クラスローダーの作成時に例外が発生しました", t);
 システム終了(1);
 }
}

3 つのクラスローダーが作成されていることがわかります。CreateClassLoader は構成に従ってリソースウェアハウスアドレスを取得し、最終的に StandardClassLoader インスタンスを返します。コアコードは次のとおりです。

プライベート ClassLoader createClassLoader(文字列名、ClassLoader 親)
 例外をスローします {

 文字列値 = CatalinaProperties.getProperty(name + ".loader");
 ((値 == null) || (値.equals("")) の場合
  return parent; // 設定されていない場合は、渡された親ローダーを返します ArrayList repositoryLocations = new ArrayList();
 ArrayList リポジトリタイプ = 新しい ArrayList();
 ...
 // リソースリポジトリパスを取得します。String[] locations = (String[]) repositoryLocations.toArray(new String[0]);
 Integer[] タイプ = (Integer[]) リポジトリタイプ.toArray(新しい Integer[0]);
 // StandardClassLoader オブジェクトを作成する ClassLoader classLoader = ClassLoaderFactory.createClassLoader
   (場所、タイプ、親);
 ...
 classLoader を返します。
}

クラスローダーが初期化されると、Catalina オブジェクトが作成され、その load メソッドが最終的に呼び出されて server.xml が解析され、コンテナーの内部コンポーネントが初期化されます。では、Engine などのコンテナーは、この設定の親ローダーとどのように関係するのでしょうか?

Catalina オブジェクトには、すべてのコンポーネントの親ローダーである parentClassLoader メンバー変数があります。デフォルトは AppClassLoader です。このオブジェクトが作成されると、その setParentClassLoader メソッドが反映され、親ローダーが sharedLoader に設定されます。

Tomcat のトップレベルコンテナエンジンが初期化されると、Digester には SetParentClassLoaderRule ルールがあり、Engine.setParentClassLoader メソッドを通じて Catalina の parentClassLoader を関連付けます。

4. 親の委任メカニズムを解除する方法

答えは、Thread.getContextClassLoader() を使用することです。これは、現在のスレッドのコンテキストローダーであり、コードの実行中に Thread.setContextClassLoader() を介して動的に設定できます。

デフォルトでは、スレッドコンテキストローダーは親スレッドから継承されます。つまり、すべてのスレッドのデフォルトのコンテキストローダーは最初に開始されたスレッド、つまりメインスレッドと同じであり、そのコンテキストローダーは AppClassLoader です。

StandardContext が起動すると、Tomcat はまず WebappClassLoader を初期化し、それを現在のスレッドのコンテキストローダーとして設定します。最後に、それを Loader オブジェクトとしてカプセル化し、コンテナー間の親子関係を利用して Servlet クラスをロードするときに使用します。

5. Webアプリケーションのクラスローディング

Web アプリケーションのクラスのロードは、WebappClassLoader メソッド loadClass(String, boolean) によって完了します。コアコードは次のとおりです。

J2SEの上書き防止

パブリック同期クラス loadClass(String name, boolean resolve)
 ClassNotFoundException をスローします {
 ...
 クラス clazz = null;
 // (0) 内部キャッシュにロードされているかどうかを確認します clazz = findLoadedClass0(name);
 （clazz != null）の場合{
 （log.isDebugEnabled()）の場合
  log.debug("キャッシュからクラスを返す");
 もし (解決) が、resolvClass(clazz) を解決した場合;
 戻る（clazz）
 }
 // (0.1) JVM キャッシュにすでにロードされているかどうかを確認します clazz = findLoadedClass(name);
 （clazz != null）の場合{
 （log.isDebugEnabled()）の場合
  log.debug("キャッシュからクラスを返す");
 もし、(解決)resolveClass(clazz) が見つかったら;
 戻る（clazz）
 }
 // (0.2) J2SEクラスの上書きを防ぐためにシステムクラスローダーを使用する try {
 clazz = system.loadClass(名前);
 （clazz != null）の場合{
  もし、(解決)resolveClass(clazz) が見つかったら;
  戻る（clazz）;
 }
 } catch (ClassNotFoundException e) { // 無視 }
 // (0.5) SecurityManagerを使用してこのクラスへのアクセス権があるかどうかを確認します。if (securityManager != null) {
 int i = name.lastIndexOf('.');
 もし (i >= 0) {
  試す {
  セキュリティマネージャのパッケージアクセスをチェックします(名前のサブ文字列(0,i));
  } キャッチ (SecurityException se) {
  文字列エラー = "セキュリティ違反、" + を使用しようとしました
   「制限クラス: 」+ 名前;
  log.info(エラー、se);
  新しい ClassNotFoundException(error, se) をスローします。
  }
 }
 }
 ブール型 delegateLoad = delegate || filter(name);
 // (1) 親クラスに委譲するかどうか。デフォルト値は false
 if (delegateLoad) {
  ...
 }
 // (2) 独自のリポジトリを見つけてロードしてみる try {
 clazz = findClass(名前);
 （clazz != null）の場合{
  （log.isDebugEnabled()）の場合
  log.debug("ローカルリポジトリからクラスをロードしています");
  もし、(解決)resolveClass(clazz) が見つかったら;
  戻る（clazz）;
 }
 } キャッチ (ClassNotFoundException e) {}
 // (3) この時点でも読み込みが失敗する場合は、読み込み要求を親ローダーに委任します。if (!delegateLoad) {
 （log.isDebugEnabled()）の場合
  log.debug(" 最後に親クラスローダーに委任しています: " + parent);
 ClassLoader ローダー = 親;
 if (ローダー == null)
  ローダー = システム;
 試す {
  clazz = loader.loadClass(名前);
  （clazz != null）の場合{
  （log.isDebugEnabled()）の場合
   log.debug("親からクラスをロードしています");
  もし (解決) が、resolvClass(clazz) を解決した場合;
  戻る（clazz）
  }
 } キャッチ (ClassNotFoundException e) {}
 }
 //最後に、読み込みが失敗し、例外がスローされます throw new ClassNotFoundException(name);
}

J2SE クラスが上書きされないようにするために、Tomcat 6 は AppClassLoader を使用します。rt.jar コア クラス ライブラリは Bootstrap Classloader によってロードされますが、このローダーは Java コードでは使用できません。上位バージョンでは、次の最適化が行われます。
クラスローダー j = String.class.getClassLoader();
j == nullの場合{
 j = getSystemClassLoader();
 (j.getParent() != null) の場合 {
 j = j.getParent();
 }
}
this.javaseClassLoader を j に設定します。

クラスをロードするときに、Tomcat 6 は AppClassLoader を使用します。rt.jar コアクラスライブラリは Bootstrap Classloader によってロードされますが、このローダーは Java コードでは取得できません。上位バージョンでは、次の最適化が行われます。

クラスローダー j = String.class.getClassLoader();
j == nullの場合{
 j = getSystemClassLoader();
 (j.getParent() != null) の場合 {
 j = j.getParent();
 }
}
this.javaseClassLoader を j に設定します。

つまり、Bootstrap ローダーにできるだけ近いクラスローダーを使用します。

6. まとめ

ほとんどの人が ClassNotFoundException 例外に遭遇したことがあると思います。この背後にはクラスローダーがあります。ローディングの原則をある程度理解しておくと、問題のトラブルシューティングに役立ちます。

上記は、編集者が紹介したTomcatクラスローダーの実装方法とサンプルコードです。皆様のお役に立てれば幸いです。ご質問がある場合は、メッセージを残してください。編集者がすぐに返信します。また、123WORDPRESS.COM ウェブサイトをサポートしてくださっている皆様にも感謝申し上げます。
この記事が役に立ったと思われた方は、ぜひ転載していただき、出典を明記してください。ありがとうございます!

以下もご興味があるかもしれません: