JavaのHttpServletMappingインターフェースを徹底解説！Servletのマッピング情報を取得する方法

HttpServletMapping

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

生徒

「ServletのURLにマッピングされている情報って、実行時に取り出せるんですか？」

先生

「はい、Java Servletではjavax.servlet.http.HttpServletMappingインターフェースを使えば、実行時にServletへのマッピング情報を取得できますよ。」

生徒

「どういうときに使うんですか？」

先生

「URLパターンによって処理を分岐させたいときや、どのServletがどのパターンで呼ばれたかをログに残したいときに便利です。それでは、詳しく見ていきましょう。」

1. HttpServletMappingとは？

Javaのjavax.servlet.http.HttpServletMappingは、Servletにリクエストが届いたときに、そのリクエストがどのURLパターンによってマッピングされたかの情報を提供するインターフェースです。

Servlet 4.0以降で追加されたこの機能を使うと、リクエストごとにマッピングされたパターンやServlet名、リクエストパスなどを取得できます。

2. HttpServletMappingを取得する方法

HttpServletRequestオブジェクトのgetHttpServletMapping()メソッドを使うことで、HttpServletMappingインターフェースのインスタンスを取得できます。


HttpServletMapping mapping = request.getHttpServletMapping();

このmappingオブジェクトから、マッピングに関する詳細な情報を取得できます。

将来を見据えて、＋αのスキルを身につけたい方へ

JavaやLinuxを学んでいても、「このままで市場価値は上がるのか」「キャリアの選択肢を広げたい」と感じる方は少なくありません。

AIを学ぶならアイデミープレミアム

3. 主なメソッド一覧

HttpServletMappingには以下のようなメソッドがあります。

getMatchValue()：実際にマッチしたパターン（例：*.jsp）
getPattern()：Servletに指定されたマッピングパターン
getServletName()：呼び出されたServletの名前
getMappingMatch()：マッピングの種類（EXACT、DEFAULT、EXTENSIONなど）

これらを使えば、リクエストされたURLがどのようにServletと対応づけられているかがわかります。

4. サンプルコード：Servletでマッピング情報を取得


@WebServlet("/sample/*")
public class MappingExampleServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        HttpServletMapping mapping = request.getHttpServletMapping();

        System.out.println("Servlet名: " + mapping.getServletName());
        System.out.println("マッチした値: " + mapping.getMatchValue());
        System.out.println("パターン: " + mapping.getPattern());
        System.out.println("マッチ種別: " + mapping.getMappingMatch());

        response.getWriter().println("マッピング情報を出力しました。");
    }
}