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/** ");

    return registrationBean;
}

今すぐフィルタが

/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.まとめ

この記事では、Spring Boot Webアプリケーションでカスタムフィルタを定義する方法をまとめました。

いつものように、コードスニペットはhttps://github.com/eugenp/tutorials/tree/master/spring-boot[over on GitHub]にあります。