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

生徒

「Javaのサーブレットで、自分のWebアプリケーションのパスを取得する方法ってありますか？」

先生

「ありますよ。HttpServletRequestWrapperのgetContextPathメソッドを使うと、そのWebアプリケーションがどのコンテキストパスに配置されているかがわかります。」

生徒

「それって具体的にはどんなときに使うんですか？」

先生

「それでは、初心者向けにわかりやすく解説していきましょう！」

1. javax.servlet.httpパッケージについて

JavaでWebアプリケーションを開発する際には、javax.servlet.httpパッケージをよく使用します。このパッケージには、HTTP通信を扱うために必要なクラスやインターフェースが豊富に用意されています。

HttpServlet、HttpServletRequest、HttpServletResponseなどがその代表例です。今回紹介するHttpServletRequestWrapperもこのパッケージに含まれており、リクエストの処理をカスタマイズしたいときに役立つクラスです。

2. HttpServletRequestWrapperクラスとは

HttpServletRequestWrapperは、HttpServletRequestを継承したラッパークラスで、既存のリクエストの動作を部分的に上書きしたり追加したりしたいときに使います。

リクエストヘッダーの変更や、リクエストパラメータの加工、セキュリティチェックの追加など、さまざまなカスタマイズに対応できます。HttpServletRequestと同じメソッドが使えるため、初心者でも扱いやすいクラスです。

3. getContextPathメソッドの役割

getContextPathメソッドは、現在アクセスされているWebアプリケーションのコンテキストパス（ルートパス）を返してくれるメソッドです。

例えば、URLがhttp://localhost:8080/myapp/index.jspだった場合、getContextPathの戻り値は/myappとなります。アプリケーションのルートURLを動的に取得したいときに非常に便利です。

4. getContextPathの使いどころ

getContextPathメソッドは以下のような場面で役立ちます：

HTMLのリンクやフォームのアクションにアプリケーションのルートパスを動的に埋め込みたいとき
複数のWebアプリケーションを同一サーバーで動かしているときに、アプリケーションごとにパスを切り替える必要があるとき
ログ出力やデバッグ用に、アクセスされたコンテキストパスを記録しておきたいとき

特にフロントエンドのリンク生成時には、ハードコーディングせずにgetContextPathで取得した値を使うことで、移植性の高いコードが書けます。

5. HttpServletRequestWrapperでgetContextPathを使う例

それでは、HttpServletRequestWrapperを使って、getContextPathの値を取得するJavaサーブレットのサンプルコードを見てみましょう。


@WebServlet("/context-check")
public class ContextPathServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        HttpServletRequestWrapper wrapper = new HttpServletRequestWrapper(request);
        String contextPath = wrapper.getContextPath();

        response.setContentType("text/plain; charset=UTF-8");
        response.getWriter().println("アプリケーションのコンテキストパスは: " + contextPath);
    }
}

6. getContextPathの実行結果例

WebアプリケーションがTomcatサーバーで/myappという名前で動作しており、次のURLでアクセスしたとします。

http://localhost:8080/myapp/context-check

このときの出力結果は以下のようになります。


アプリケーションのコンテキストパスは: /myapp

ルートに配置されたアプリケーションの場合、つまりROOTディレクトリとして動かしている場合は、出力は空文字列""になります。


アプリケーションのコンテキストパスは:

7. 初心者が気をつけるポイント

getContextPathで取得できる値は、アプリケーションのURL構造を把握するうえでとても重要です。アプリケーションをサーバーにデプロイする際、設定によってコンテキストパスが変わる場合もあるため、絶対パスでリンクを書くよりも、getContextPathで取得した値を利用する方が安全です。

また、getRequestURIやgetServletPathなどと混同しないように、用途や返される値の違いをきちんと整理しておきましょう。

8. Webアプリケーション開発での活用例

例えば、JavaのJSPやHTMLで画像ファイルやスタイルシート、JavaScriptなどのリソースファイルを読み込むとき、getContextPathを使って動的にルートパスを指定すると、環境の違いに強いWebページが作れます。

以下はJSPでgetContextPathを使ってCSSファイルのパスを指定する例です。


<link rel="stylesheet" href="${pageContext.request.contextPath}/css/style.css">

このようにしておけば、アプリケーションをどのパスに配置してもリンクが正しく動作します。Java ServletやJSPでWebアプリを作る初心者にとって、getContextPathの使い方をしっかり理解しておくことはとても大切です。

JavaのHttpServletRequestWrapperとgetContextPathメソッドを完全解説！初心者向けサーブレット開発ガイド