JavaのHttpFilterクラスとは？Servletフィルタの基本を初心者向けにやさしく解説！

1. HttpFilterクラスとは何か？

1. HttpFilterクラスとは何か？

Javaのjavax.servlet.http.HttpFilterクラスは、Servletに対して処理を追加するためのフィルタを作成する際に使用される抽象クラスです。このクラスはjavax.servlet.Filterインターフェースを実装しており、HTTPに特化した便利なフィルタ処理が可能になります。

Servletのリクエストやレスポンスを共通で加工したいときや、アクセスログの記録、認証処理、文字コードの設定などに使われます。

2. なぜHttpFilterを使うのか？

2. なぜHttpFilterを使うのか？

HttpFilterを使うメリットは、フィルタ処理を簡潔に実装できる点にあります。HTTP専用のHttpServletRequestやHttpServletResponseに特化しているため、ダウンキャストする必要がなく、コードがシンプルになります。

また、共通処理をまとめることで、個々のServletのコードをスッキリ保つことができます。

3. HttpFilterの基本的な使い方

3. HttpFilterの基本的な使い方

ここでは、HttpFilterクラスを使ってリクエストの処理前後にログを出力するフィルタの例を紹介します。

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebFilter("/*")
public class LoggingFilter extends HttpFilter {
    @Override
    protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        System.out.println("リクエスト受信: " + request.getRequestURI());

        chain.doFilter(request, response);

        System.out.println("レスポンス送信: " + response.getStatus());
    }
}

4. @WebFilterアノテーションでのフィルタ登録

4. @WebFilterアノテーションでのフィルタ登録

HttpFilterを使う場合、クラスに@WebFilterアノテーションを付けることで、web.xmlファイルを使わずに簡単にフィルタを登録できます。たとえば、@WebFilter("/*")と指定すると、すべてのリクエストに対してフィルタが適用されます。

5. doFilterメソッドの役割

5. doFilterメソッドの役割

doFilterメソッドは、リクエスト処理の前後に実行されるメソッドです。この中で、前処理を行ってからchain.doFilter()を呼び出すことで、次のフィルタまたはServletに処理を進めます。

chain.doFilter()の後に書いた処理は、Servletの処理が終わった後に実行されます。

6. HttpFilterの活用例

6. HttpFilterの活用例

HttpFilterは、次のような用途で活用されることが多いです。

• ユーザー認証チェック
• アクセスログの記録
• リクエストやレスポンスの文字コード設定
• 不要なアクセスのブロック

たとえば、ログインしていないユーザーをログインページにリダイレクトする処理なども、フィルタを使えば共通化して効率的に実装できます。

7. ServletフィルタとHttpFilterの違い

7. ServletフィルタとHttpFilterの違い

HttpFilterは、基本的にFilterインターフェースを実装したクラスと同じ目的で使いますが、HTTP専用のリクエストとレスポンスを扱える点が違います。

従来のFilterでは、ServletRequestやServletResponseをHttpServletRequestなどにキャストする必要がありましたが、HttpFilterではその手間がなくなります。

8.まとめ

8.まとめ

今回はJavaのWebアプリケーション開発における非常に重要な機能であるHttpFilterクラスについて、初心者にもわかりやすく詳しく解説しました。HttpFilterはjavax.servlet.Filterインターフェースを継承したHTTP専用のフィルタクラスであり、Servletの処理の前後に共通処理を挟む際にとても便利な仕組みです。Java Servletフィルタの中でも特にHttpServletRequestやHttpServletResponseといったHTTP特化型のオブジェクトをそのまま扱える点が特徴であり、doFilterメソッドを簡潔に記述できるという大きな利点があります。

フィルタはWebアプリケーションのリクエストとレスポンスを共通して処理したい場合に非常に有効です。例えば、全ページに共通するアクセスログの記録、リクエストのエンコーディング設定、不正アクセスの制御、認証処理などは、Servletクラスに毎回書くのではなく、フィルタにまとめることで保守性と再利用性が高まります。HttpFilterを使えば、これらの処理をHTTPに特化した形でより簡単に書くことができます。

また、アノテーションである@WebFilterを使えば、web.xmlによる複雑な設定を省略でき、クラスに直接対象URLパターンを指定することで、非常にスマートに導入できます。これにより、開発スピードも保守性も向上し、初心者にとっても学びやすく実装しやすいフィルタ処理が可能になります。

それではここで、HttpFilterクラスを使ってログイン状態をチェックする簡単なサンプルコードを紹介します。これは、未ログインのユーザーをログインページに強制的にリダイレクトする例です。

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebFilter("/secure/*")
public class AuthFilter extends HttpFilter {
    @Override
    protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        Object user = request.getSession().getAttribute("user");
        if (user == null) {
            response.sendRedirect("/login.jsp");
        } else {
            chain.doFilter(request, response);
        }
    }
}

このように、HttpFilterを使えばログインチェックのような共通処理も簡潔に実装でき、すべてのServletに重複して同じようなコードを書く必要がなくなります。Java Webアプリケーションのセキュリティや保守性を高めるためには、フィルタの使い方をしっかりマスターしておくことが重要です。

今後さらにServletやJSP、Spring Frameworkなどに発展していく際にも、このHttpFilterクラスの考え方や使い方が基盤となります。Javaのサーブレット技術を習得する第一歩として、今回の内容は非常に価値ある知識といえるでしょう。

この記事を読んだ人からの質問

この記事を読んだ人からの質問

プログラミング初心者からのよくある疑問／質問を解決します

JavaでServletのリクエストを共通処理したいときはどうすればいいですか？

JavaでServletのリクエストを共通処理したい場合は、HttpFilterクラスを使ってフィルタを実装するのが一般的です。これによりリクエストがServletに届く前に一括で処理を行うことができます。

HttpFilterクラスとFilterインターフェースの違いは何ですか？

HttpFilterクラスはFilterインターフェースを拡張した抽象クラスで、HTTP専用に最適化されています。ServletRequestやServletResponseをHttpServletRequestやHttpServletResponseにキャストする必要がなく、初心者にも扱いやすいです。

JavaのHttpFilterでログ出力するにはどうすればよいですか？

HttpFilterクラスのdoFilterメソッド内でリクエストURIやレスポンスのステータスコードをSystem.out.printlnなどで出力することで、簡単にログを記録することができます。

Javaで@WebFilterアノテーションを使うメリットは何ですか？

@WebFilterアノテーションを使うと、web.xmlファイルでフィルタを設定する必要がなくなり、より簡潔で保守しやすいコードになります。Java初心者にも理解しやすい書き方です。

HttpFilterのdoFilterメソッドでは何をするのが一般的ですか？

doFilterメソッドでは、リクエストに対する前処理やレスポンスに対する後処理を記述します。chain.doFilterで処理をServletに引き継ぎ、その後にログ記録やエラーチェックなどの後処理を行います。

JavaのHttpFilterは認証チェックに使えますか？

はい、HttpFilterを使えばログイン済みかどうかの判定を行い、未ログインのユーザーをログインページへリダイレクトするなど、認証処理を簡潔に共通化できます。

HttpFilterで全てのリクエストにフィルタを適用するにはどうすればいいですか？

@WebFilter("/*")と指定することで、すべてのURLパターンに対してHttpFilterが適用されます。JavaのServlet全体に共通の処理を追加する際に便利です。

JavaのHttpFilterで不要なアクセスをブロックできますか？

はい、HttpFilterを使えば条件に応じてリクエストを中断し、エラーページにリダイレクトすることで不正アクセスや不必要な通信を遮断することが可能です。

JavaのWebアプリケーションでHttpFilterはどのタイミングで使われますか？

HttpFilterは、Servletにリクエストが届く前と、Servletの処理が完了した後に自動的に呼び出されます。これにより前処理と後処理を一括で記述できます。

JavaのServlet開発でHttpFilterは学んでおいたほうがいいですか？

はい、HttpFilterの知識はJavaでのWebアプリケーション開発においてとても重要です。共通処理やセキュリティ対策を効率よく実装できるため、初心者でも早い段階で学んでおくべき技術です。

HttpFilterの処理順序はどう決まりますか？

複数のフィルタがある場合、@WebFilterのurlPatternsや設定順に基づいて処理されます。フィルタの順序を制御するには、web.xmlを併用することも可能です。

Servletフィルタの処理が終わった後に実行される処理はどこに書けばいいですか？

doFilterメソッド内でchain.doFilterを呼び出した後のコードに記述します。これにより、Servletでの処理が終わった後に実行される後処理を記述できます。