（Spring）Filterとは？

ふじしろ

FIlterとは？

->インターセプターより手前（または後ろ）で行われる処理

Filterは、サーブレットの実行前または実行後に呼び出すことができます。
出典：What Is OncePerRequestFilter? | Baeldung

OncePerRequestFilterとは？

->リクエストの際に一度だけ行われるフィルター処理

Springは、指定されたリクエストに対してOncePerRequestFilterが 1 回だけ実行されることを保証します。
出典：What Is OncePerRequestFilter? | Baeldung

参考

ふじしろ

実装の流れ

filter用のパッケージを作る
OncePerRequestFilterクラスを継承した認証クラスを作る
上記で作成した認証クラスの中で認証処理を記述する。
完成した認証クラスをWebMvcConfigに登録する
- この流れはインターセプターと同様。こちらはDIするだけで済んだ。
- @Beanを付与してコンストラクタを作成した。
  - 参考：インターセプターを使って割り込み処理を実装する

->こちらのやり方だと全てのパスにフィルターがセットされてしまった。
->次の構成で実装することでフィルタリングを実行するパスを指定できた。

ふじしろ

実装の流れ（フィルタリング対象パスを指定する場合）

上記1~3までは同様
完成した認証クラスをWebMvcConfigに登録する
@Beanを付与して、FilterRegistrationBeanインスタンスを戻り値にもつメソッドを生成する
その中でFilterRegistrationBeanインスタンスを生成し、引数に認証クラスのインスタンスを入れる
FilterRegistrationBeanのメソッドであるaddUrlPatternsにより対象のパスを指定する。
戻り値としてインスタンスを返す。

実装イメージ

@Configuration
public class MyConfig implements WebMvcConfigurer {

    @Bean
    public FilterRegistrationBean filterRegister() {
        FilterRegistrationBean bean = new FilterRegistrationBean(new MyAuthenticationFilter());
        bean.addUrlPatterns("/api/*");
        return bean;
    }
}

認証クラスをMyAuthenticationFilterとして、
apiのURLにのみフィルターをかけているイメージ。

参考

ふじしろ

参考ドキュメント等

OncePerRequestFilter (Spring Framework API) - Javadoc
- リクエストに対して一度処理を行うフィルター。
- このクラスを継承して認証処理を記述する。
WebMvcConfigurer (Spring Framework API) - Javadoc
- 作成したフィルターをここに登録する
FilterRegistrationBean (Spring Boot API) - Javadoc
- 上記コンフィグクラス内でフィルター処理を登録する

ふじしろ

Filterの構造のイメージ

public class CommonsRequestLoggingFilter {

    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {

       // filterChain.dofilterより上の処理
       // ->コントローラより前に実行される

        filterChain.doFilter(request, response);

       // filterChain.dofilterより下の処理
       // ->コントローラより後に実行される

    }
}