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

生徒

「先生、JakartaEEのServletにフィルタってあるって聞いたんですが、どうやって設定するんですか？」

先生

「そうだね、JakartaServletにはリクエストやレスポンスを横取りして処理できるフィルタ機能があるんだ。設定方法にはweb.xmlを使う方法とアノテーションを使う方法があるよ。」

生徒

「両方あるんですね。どちらを使うのが良いんですか？」

先生

「それはプロジェクトの規模やチームの方針にもよるけれど、両方を知っておくと柔軟に対応できるよ。今からそれぞれの設定方法を具体的に見ていこう！」

1. JakartaEEフィルタとは？

JakartaEEのフィルタは、JakartaServletの仕組みの一部で、クライアントからのリクエストやサーバーからのレスポンスを横取りして処理できる仕組みです。例えば、ログを記録したり、認証やアクセス制御を行ったり、文字コードを統一するなどの用途に使われます。Servletと連携して使うことで、アプリケーションの保守性や拡張性を高めることができます。

2. web.xmlを使ったJakartaEEフィルタの設定方法

古くからある方法として、web.xmlに記述するやり方があります。XMLファイルに明示的にフィルタを登録し、どのリクエストに適用するかを設定します。この方法は設定が見やすく、外部ファイルにまとまっているため、大規模システムでは利用されることが多いです。


<filter>
    <filter-name>EncodingFilter</filter-name>
    <filter-class>com.example.EncodingFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>EncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

このように、<filter>タグでフィルタのクラスを指定し、<filter-mapping>タグで適用するURLパターンを設定します。例えば「/*」とすればすべてのリクエストに適用されます。

3. アノテーションを使ったJakartaEEフィルタの設定方法

JakartaEE6以降ではアノテーションを利用した設定が可能になりました。コードの中に直接記述できるため、設定ファイルを編集せずに簡単に導入できます。


import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")
public class EncodingFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
        throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response);
    }
}

@WebFilterアノテーションを付与するだけでフィルタが有効になります。こちらはシンプルでわかりやすく、小規模なプロジェクトや素早く動作確認を行いたい場合に便利です。

4. web.xmlとアノテーションの比較

ここで両者を比較してみましょう。web.xmlは設定が外部ファイルにまとまっているため、大規模なJakartaEEプロジェクトや運用中のシステムで一括管理がしやすいというメリットがあります。一方、アノテーション方式は設定がソースコード内にあるので手軽に導入でき、初心者でも扱いやすいです。

例えば、チームで運用している大きなJakartaEEアプリケーションではweb.xml方式を使い、個人学習や小規模なサービス開発ではアノテーションを使うといった使い分けが考えられます。どちらも正しい方法なので、状況に応じて選択するのがポイントです。

5. フィルタの実用例と注意点

実際の開発現場では、フィルタは以下のような用途でよく利用されます。

リクエストやレスポンスの文字コード変換
アクセスログの記録
セキュリティチェック（認証やIP制御など）
キャッシュ制御ヘッダの付与

注意点として、フィルタを多用しすぎると処理が複雑になり、パフォーマンスに影響を与える可能性があります。シンプルで再利用性の高い処理をフィルタに任せることが望ましいです。また、複数のフィルタをチェーンさせる場合には処理の順序を意識することが重要です。

6. 初心者が理解しておきたいJakartaEEフィルタのポイント

これからJakartaEEを学ぶ初心者にとって、フィルタは少し難しそうに見えるかもしれません。しかし、リクエストとレスポンスの間に割り込んで便利な処理を追加できる仕組みだと理解すれば、一気に使いやすくなります。まずは簡単な文字コード設定のフィルタを作って動作を確認し、そこから徐々に応用範囲を広げていくのがおすすめです。

特に学習初期ではアノテーションを使って手軽に導入し、プロジェクトが大きくなってきたらweb.xmlに移行するといったステップアップの仕方も実用的です。