JSPの暗黙オブジェクト「config」とは？役割と基本的な使い方を解説

JSPのconfigオブジェクトとは

configオブジェクトは、JSPにあらかじめ用意されている暗黙オブジェクト（implicit object）の一つで、javax.servlet.ServletConfigクラスのインスタンスです。JSPがサーブレットに変換される際に生成されるサーブレットに対して、そのServletConfigオブジェクトを直接ラップしたものとなっています。

このオブジェクトを利用することで、JSPプログラマーはサーブレットコンテナやJSPエンジンに渡された初期化パラメータへアクセスできるようになります。具体的には、アプリケーションのパスや設定ファイルの場所といった情報の取得に役立ちます。

主なメソッド：getServletName()

configオブジェクトの中で、実際に使用する機会が多いのは次のメソッドです。呼び出し方も非常にシンプルです。

config.getServletName();

このメソッドを実行すると、WEB-INF/web.xmlファイル内の<servlet-name>要素に記述された文字列、つまりサーブレット名が戻り値として取得できます。

web.xmlの設定例

たとえば、web.xmlに次のようにサーブレット名が定義されている場合を考えてみましょう。

<servlet>
  <servlet-name>sampleServlet</servlet-name>
  <jsp-file>/index.jsp</jsp-file>
</servlet>

この状態でJSP内から config.getServletName() を呼び出すと、戻り値として「sampleServlet」という文字列が返されます。

まとめ

configオブジェクトは、ServletConfigへの窓口となる暗黙オブジェクトであり、web.xmlで定義されたサーブレット名や初期化パラメータを簡単に参照できるのが特徴です。日常的な開発ではgetServletName()の利用が中心となりますが、初期設定値をJSP側で扱いたい場合には欠かせない存在といえるでしょう。