先生と生徒の会話形式で理解しよう

生徒

「先生、JakartaEEのサーブレットで設定値を外部から渡したい場合ってどうするんですか？」

先生

「いい質問だね。サーブレットでは初期化パラメータと呼ばれる仕組みを使って設定値を渡すことができます。さらにServletConfigを利用すれば簡単にその値を取得できるんだ。」

生徒

「なるほど！でも初期化パラメータってどこで設定して、どうやって読み込むんですか？」

先生

「それをこれから順番に解説していくよ。初心者でも理解できるように、実際の設定ファイルとサーブレットコードを見ながら学んでいこう。」

1. 初期化パラメータとは？

JakartaEE サーブレットの初期化パラメータとは、サーブレットごとにあらかじめ設定しておく固定的な値のことです。例えばデータベースの接続情報やアプリケーションで共通して利用する文字コードなどを定義できます。これを使うことでソースコードに値を直接書かずに済み、柔軟でメンテナンスしやすいWebアプリケーションを構築できます。

2. web.xmlでの初期化パラメータ設定

古典的な方法として、web.xmlに初期化パラメータを定義する方法があります。サーブレットごとに記述でき、明示的に値を渡せます。


<web-app>
    <servlet>
        <servlet-name>ConfigServlet</servlet-name>
        <servlet-class>example.ConfigServlet</servlet-class>
        <init-param>
            <param-name>adminEmail</param-name>
            <param-value>admin@example.com</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>ConfigServlet</servlet-name>
        <url-pattern>/config</url-pattern>
    </servlet-mapping>
</web-app>

ここではadminEmailという初期化パラメータを設定しています。この値をサーブレット側で取り出すことができます。

3. アノテーションでの初期化パラメータ設定

JakartaEE では@WebServletアノテーションを使ってサーブレットを定義できます。その際にinitParams属性を指定すれば、web.xmlを使わずに初期化パラメータを設定できます。


import jakarta.servlet.annotation.WebInitParam;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;

@WebServlet(
    name = "ConfigServlet",
    urlPatterns = {"/config"},
    initParams = {
        @WebInitParam(name = "adminEmail", value = "admin@example.com"),
        @WebInitParam(name = "siteName", value = "Sample Site")
    }
)
public class ConfigServlet extends HttpServlet {
    // 実装部分は後で解説
}

アノテーションを使うとコードだけで設定が完結するため、小規模なアプリケーションでは便利です。

4. ServletConfigで初期化パラメータを取得する

サーブレット内で初期化パラメータを利用するには、ServletConfigオブジェクトを通して値を取得します。以下は実際の例です。


import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;

public class ConfigServlet extends HttpServlet {
    private String adminEmail;
    private String siteName;

    @Override
    public void init(ServletConfig config) throws ServletException {
        super.init(config);
        this.adminEmail = config.getInitParameter("adminEmail");
        this.siteName = config.getInitParameter("siteName");
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/plain; charset=UTF-8");
        resp.getWriter().println("管理者メール: " + adminEmail);
        resp.getWriter().println("サイト名: " + siteName);
    }
}


管理者メール: admin@example.com
サイト名: Sample Site

このようにgetInitParameterを使えば、設定ファイルやアノテーションで定義した値を簡単に取得できます。

5. 初期化パラメータとコンフィグの活用シーン

初期化パラメータは以下のようなケースで役立ちます。

管理者メールアドレスやサポート窓口の設定
データベース接続URLやドライバ名の定義
外部APIキーや接続先URLの指定

もしこれらをソースコードに直接書き込むと変更時に再コンパイルが必要になり、メンテナンスが大変になります。しかし初期化パラメータを使えば設定を外部化できるため、変更に柔軟に対応できるのです。

6. ServletConfigとServletContextの違い

初心者が混乱しやすいのが、ServletConfigとServletContextの違いです。ServletConfigは特定のサーブレットに対する設定値を扱うのに対し、ServletContextはアプリケーション全体に共通する設定値を扱います。

つまり、サーブレットごとに異なる値を持たせたい場合はServletConfig、アプリ全体で共通の値を持たせたい場合はServletContextを利用すると覚えておくとわかりやすいです。

7. 初期化パラメータ理解のメリット

サーブレットの初期化パラメータとServletConfigを理解すると、以下のようなメリットがあります。

アプリケーションの設定値を外部化できるため保守性が向上する
コードの再利用性が高まり、環境ごとの切り替えが簡単になる
開発から本番環境への移行がスムーズになる

JakartaEEで安定したWebアプリケーションを開発するためには欠かせない知識の一つです。

JakartaEE サーブレットの初期化パラメータとコンフィグを徹底解説！初心者向けガイド