1. 概要

このクイックチュートリアルでは、Spring Bootを使用して、カスタムフィルターを定義し、それらの呼び出し順序を指定する方法について説明します。

2. フィルタと呼び出し順序の定義

2つのフィルターを作成することから始めましょう:

  1. TransactionFilter –トランザクションを開始およびコミットします
  2. RequestResponseLoggingFilter –リクエストとレスポンスをログに記録します

フィルタを作成するには、Filterインターフェイスを実装する必要があります。

@Component
@Order(1)
public class TransactionFilter implements Filter {

    @Override
    public void doFilter(
      ServletRequest request, 
      ServletResponse response, 
      FilterChain chain) throws IOException, ServletException {
 
        HttpServletRequest req = (HttpServletRequest) request;
        LOG.info(
          "Starting a transaction for req : {}", 
          req.getRequestURI());
 
        chain.doFilter(request, response);
        LOG.info(
          "Committing a transaction for req : {}", 
          req.getRequestURI());
    }

    // other methods 
}

@Component
@Order(2)
public class RequestResponseLoggingFilter implements Filter {

    @Override
    public void doFilter(
      ServletRequest request, 
      ServletResponse response, 
      FilterChain chain) throws IOException, ServletException {
 
        HttpServletRequest req = (HttpServletRequest) request;
        HttpServletResponse res = (HttpServletResponse) response;
        LOG.info(
          "Logging Request  {} : {}", req.getMethod(), 
          req.getRequestURI());
        chain.doFilter(request, response);
        LOG.info(
          "Logging Response :{}", 
          res.getContentType());
    }

    // other methods
}

Springがフィルターを認識するためには、@Componentアノテーションが付いたBeanとしてフィルターを定義する必要があります。

さらに、フィルターを正しい順序で起動するには、@Orderアノテーションを使用する必要があります。

2.1. URLパターンでフィルタリング

上記の例では、フィルターはデフォルトでアプリケーションのすべてのURLに登録されています。 ただし、特定のURLパターンにのみフィルターを適用したい場合があります。

この場合、フィルタークラス定義から @Component アノテーションを削除し、 FilterRegistrationBean:を使用してフィルターを登録する必要があります。

@Bean
public FilterRegistrationBean<RequestResponseLoggingFilter> loggingFilter(){
    FilterRegistrationBean<RequestResponseLoggingFilter> registrationBean 
      = new FilterRegistrationBean<>();
        
    registrationBean.setFilter(new RequestResponseLoggingFilter());
    registrationBean.addUrlPatterns("/users/*");
    registrationBean.setOrder(2);
        
    return registrationBean;    
}

この場合、 setOrder()メソッドを使用して順序を明示的に設定する必要があることに注意してください。

これで、フィルターは / users /*パターンに一致するパスにのみ適用されます。

フィルタのURLパターンを設定するには、 addUrlPatterns()または setUrlPatterns()メソッドを使用できます。

3. 簡単な例

次に、単純なエンドポイントを作成して、それにHTTPリクエストを送信しましょう。

@RestController
@RequestMapping("/users")
public class UserController {
    
    @GetMapping()
    public List<User> getAllUsers() {
        // ...
    }
}

このAPIをヒットしたときのアプリケーションログは次のとおりです。

23:54:38 INFO  com.spring.demo.TransactionFilter - Starting Transaction for req :/users
23:54:38 INFO  c.s.d.RequestResponseLoggingFilter - Logging Request  GET : /users
...
23:54:38 INFO  c.s.d.RequestResponseLoggingFilter - Logging Response :application/json;charset=UTF-8
23:54:38 INFO  com.spring.demo.TransactionFilter - Committing Transaction for req :/users

これにより、フィルターが目的の順序で呼び出されていることが確認されます。

4. 結論

この短い記事では、SpringBootWebアプリでカスタムフィルターを定義する方法を要約しました。

いつものように、コードスニペットはGitHubにあります。