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

生徒

「Jakarta EEのServlet Filterってよく聞くんですが、ログ出力にも使えるんですか？」

先生

「はい。Jakarta EEのServlet Filterは、リクエストやレスポンスを横断的に処理できる仕組みなので、アクセスログや処理ログの出力にとてもよく使われます。」

生徒

「ログ出力というと、プログラムの中に書くイメージがあります。」

先生

「その方法でも書けますが、Servlet Filterを使うと全てのリクエストをまとめて監視できます。例えばアクセスURLや処理時間なども簡単に記録できます。」

生徒

「なるほど。共通処理としてログを管理できるんですね。」

先生

「その通りです。それではJakarta EEでログ出力を行うフィルタの作り方を順番に見ていきましょう。」

1. Jakarta EEのログ出力フィルタとは

Jakarta EEのServlet Filterは、Webアプリケーションに届くリクエストやレスポンスの前後で処理を追加できる仕組みです。特にアクセスログ出力、認証処理、セキュリティチェック、文字コード設定などの共通処理を実装する際によく利用されます。

ログ出力フィルタとは、ユーザーがアクセスしたURLや処理の開始時間、終了時間などを記録するフィルタです。Webシステムの運用ではログ分析が非常に重要であり、アクセス状況の確認、エラー調査、パフォーマンス改善などに役立ちます。

Jakarta EEではServlet Filterを使うことで、すべてのHTTPリクエストを一括で監視できます。これにより、各Servletにログ処理を書く必要がなくなり、保守性の高い設計になります。

2. Servlet Filterでログ出力が重要な理由

Webアプリケーション開発ではログの管理が非常に重要です。ログがあることでシステムの状態を確認でき、問題が発生した場合の原因調査が簡単になります。

例えば次のような情報をログとして記録することが一般的です。

アクセスされたURL、ユーザーのIPアドレス、処理開始時間、処理終了時間、レスポンス時間などです。

Jakarta EEのServlet Filterを利用すると、これらの情報をすべてのリクエストに対して自動的に記録できます。特に大規模なWebアプリケーションでは、ログ出力フィルタを導入することで運用管理が大幅に楽になります。

3. 基本的なログ出力フィルタの作成方法

まずはJakarta EEで基本的なログ出力フィルタを作成してみます。Servlet FilterはFilterインターフェースを実装して作成します。

doFilterメソッドの中でリクエスト処理の前後にログを出力できます。これにより、アクセスログの基本的な仕組みを簡単に作ることができます。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import java.io.IOException;

public class LoggingFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        System.out.println("リクエスト処理開始");

        chain.doFilter(request, response);

        System.out.println("リクエスト処理終了");
    }
}

このフィルタは非常にシンプルですが、リクエスト処理の前後でログを出力しています。chain.doFilterは次のフィルタまたはServletへ処理を渡すための重要な処理です。

4. URLとアクセス情報をログに出力する

実際のWebシステムでは、どのページにアクセスされたかをログに残すことが重要です。HttpServletRequestを使うと、アクセスされたURLなどの情報を取得できます。

この情報をログとして出力することで、アクセス解析やトラブル調査に役立つログを作成できます。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import java.io.IOException;

public class AccessLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        HttpServletRequest req = (HttpServletRequest) request;

        String uri = req.getRequestURI();
        String method = req.getMethod();

        System.out.println("アクセスURL: " + uri);
        System.out.println("HTTPメソッド: " + method);

        chain.doFilter(request, response);
    }
}

このようにServlet Filterを使うと、URLやHTTPメソッドなどのアクセス情報を簡単にログとして出力できます。

5. 処理時間を測定するログフィルタ

Webアプリケーションでは処理速度の監視も重要です。Servlet Filterを利用すると、リクエスト処理にかかった時間を測定できます。

処理時間をログとして記録することで、処理の遅い画面やデータベース処理を発見しやすくなります。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import java.io.IOException;

public class PerformanceLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        long start = System.currentTimeMillis();

        chain.doFilter(request, response);

        long end = System.currentTimeMillis();

        System.out.println("処理時間: " + (end - start) + "ms");
    }
}

このようなパフォーマンスログは、システム改善やチューニングの際に非常に役立ちます。

6. web.xmlでログフィルタを設定する方法

作成したServlet Filterは、web.xmlまたはアノテーションで登録する必要があります。web.xmlを使う場合は次のように設定します。


<filter>
    <filter-name>loggingFilter</filter-name>
    <filter-class>com.example.filter.LoggingFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>loggingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

url-patternを全てのパスに設定することで、すべてのリクエストに対してログ出力フィルタが適用されます。

7. アノテーションでフィルタを登録する方法

Jakarta EEではアノテーションを使ってServlet Filterを登録する方法もあります。この方法を使うとweb.xmlを書かなくてもフィルタを設定できます。


import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import java.io.IOException;

@WebFilter("/*")
public class AnnotationLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        System.out.println("アノテーションフィルタ実行");

        chain.doFilter(request, response);
    }
}

アノテーションを利用すると設定が簡潔になり、Jakarta EEの開発効率が向上します。特に小規模なアプリケーションではアノテーション方式がよく利用されています。

8. ログ出力フィルタとInterceptorの違い

Jakarta EEではログ処理にServlet FilterだけでなくInterceptorが使われる場合もあります。しかし役割には違いがあります。

Servlet FilterはHTTPリクエストの前後で処理を実行する仕組みです。一方でInterceptorはビジネスロジックのメソッド実行前後で処理を追加できます。

そのためアクセスログやリクエスト監視にはServlet Filterが適しており、業務処理の監視にはInterceptorが使われることが多いです。

Jakarta EEのWebアプリケーションでは、ログ管理の目的に応じてServlet FilterとInterceptorを使い分けることが重要です。

まとめ

Jakarta EEのログ出力フィルタを振り返る

ここまで、Jakarta EEにおけるServlet Filterを利用したログ出力フィルタの仕組みについて詳しく解説してきました。Webアプリケーション開発では、ユーザーのアクセス状況や処理の流れを正確に把握することが非常に重要です。そのため、ログ出力はシステム運用やトラブル対応において欠かせない要素となります。

Jakarta EEのServlet Filterを利用すると、Webアプリケーションに届くすべてのHTTPリクエストを共通処理として監視できます。通常、ログ出力を各Servletやコントローラに個別に実装すると、コードが複雑になり保守性が低下してしまいます。しかし、ログ出力フィルタを利用すれば、共通処理として一箇所にまとめてログ管理を行うことができます。

特にWebシステムでは、アクセスログ、エラーログ、処理時間ログなどの情報が非常に重要です。これらのログ情報を適切に記録することで、システムの状態を把握したり、パフォーマンスの問題を発見したりすることができます。また、ログを分析することでユーザーの利用状況やアクセス傾向を理解することにもつながります。

今回の記事では、Jakarta EEのログ出力フィルタとして、基本的なServlet Filterの作成方法から、アクセスURLの取得、HTTPメソッドの記録、処理時間の測定方法までを段階的に学習しました。これらはWebアプリケーション開発の現場でもよく使われる実装方法であり、基礎として理解しておくことが非常に重要です。

Servlet Filterでログ管理を行うメリット

Jakarta EEのServlet Filterを利用したログ管理には多くのメリットがあります。まず大きな利点は、すべてのリクエストを横断的に処理できる点です。FilterはServletの前後で処理を追加できるため、ログ出力、認証処理、セキュリティチェック、アクセス制御などの共通処理を一括で管理できます。

例えばアクセスログを記録する場合、ユーザーがアクセスしたURL、HTTPメソッド、IPアドレス、処理開始時間、処理終了時間などの情報を取得できます。これらの情報はシステム運用において非常に重要なデータになります。

また、ログ出力フィルタを導入することで、プログラムの可読性も向上します。Servletやビジネスロジックのコードにログ出力処理を大量に書いてしまうと、処理の本来の目的が分かりにくくなってしまいます。Filterを利用することで、ログ処理を共通化し、アプリケーションの設計をシンプルに保つことができます。

ログ出力フィルタの基本パターン

Jakarta EEのログ出力フィルタでは、リクエスト処理の開始前と終了後にログを記録するパターンがよく使われます。FilterのdoFilterメソッドでは、chain.doFilterを呼び出す前と後で処理を追加できるため、処理開始ログと処理終了ログを簡単に記録できます。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import java.io.IOException;

public class SimpleLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        System.out.println("ログフィルタ開始");

        chain.doFilter(request, response);

        System.out.println("ログフィルタ終了");
    }
}

このような基本構造を理解しておくことで、さまざまなログ出力フィルタを簡単に実装できるようになります。Jakarta EEのServlet FilterはWebアプリケーション開発において非常に重要な仕組みなので、基本構造をしっかり理解しておくことが大切です。

アクセス情報をログに記録する例

実際のWebアプリケーションでは、アクセスされたURLやHTTPメソッドなどの情報をログとして記録することが一般的です。これらの情報はアクセス解析やセキュリティ監視にも利用できます。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import java.io.IOException;

public class RequestInfoLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        HttpServletRequest req = (HttpServletRequest) request;

        String uri = req.getRequestURI();
        String method = req.getMethod();

        System.out.println("アクセスされたURL: " + uri);
        System.out.println("HTTPメソッド: " + method);

        chain.doFilter(request, response);
    }
}

このようにJakarta EEのServlet Filterを利用することで、Webアプリケーションのすべてのアクセス情報を一括で管理できます。ログ情報はシステムの安定運用やトラブル調査に役立つため、Webシステム開発では必ず実装しておきたい機能です。

処理時間ログを活用したパフォーマンス管理

Webアプリケーションでは、処理時間の監視も非常に重要です。特定の画面だけ処理が遅い場合や、データベース処理がボトルネックになっている場合など、処理時間ログを確認することで問題を発見できます。


import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletException;
import java.io.IOException;

public class ProcessingTimeLogFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        long startTime = System.currentTimeMillis();

        chain.doFilter(request, response);

        long endTime = System.currentTimeMillis();

        System.out.println("処理時間ログ: " + (endTime - startTime) + "ms");
    }
}

このような処理時間ログを記録することで、Webアプリケーションのパフォーマンス改善に役立てることができます。Jakarta EEのServlet Filterはパフォーマンス監視の仕組みとしても非常に有効です。

Webシステムの運用では、アクセスログ、処理時間ログ、エラーログなどを組み合わせて管理することで、システムの状態を正確に把握できます。Jakarta EEのServlet Filterはその基盤となる重要な仕組みです。

先生と生徒の振り返り会話

生徒

Jakarta EEのServlet Filterを使うとログ出力を共通処理として管理できるということがよく分かりました。これなら複数のServletに同じログ処理を書かなくても済みますね。

先生

その通りです。Servlet FilterはWebアプリケーションのリクエスト処理の前後で共通処理を追加できる仕組みなので、ログ出力や認証処理などを一括で管理できます。Jakarta EEの開発ではとても重要な技術です。

生徒

アクセスURLやHTTPメソッド、処理時間なども簡単にログに記録できるので、システムの状態を把握しやすくなりそうです。

先生

その理解で大丈夫です。ログはシステム運用の基本となる情報なので、Jakarta EEのServlet Filterを使ってしっかり管理することが大切です。特にアクセスログと処理時間ログはパフォーマンス改善にも役立ちます。

生徒