Springbootにおけるフィルタの原理と登録方法は何ですか

1. フィルター

まず、Web サーバーのフィルターの場所を確認します。フィルタは前後につながったチェーンであり、前の処理が完了すると次のフィルタに渡されて処理が行われます。

1.1 フィルター インターフェイスの定義

public interface Filter {
    //初始化方法，整个生命周期中只执行一次。
    //在init方法成功(失败如抛异常等)执行完前，不能提供过滤服务。
    //参数FilterConfig用于获取初始化参数
    public void init(FilterConfig filterConfig) throws ServletException;
 
    //执行过滤任务的方法，参数FilterChain表示过滤器链，doFilter方法中只有执行chain.doFilter()后才能调用下一个过滤器的doFilter方法
    //才能将请求交经下一个Filter或Servlet执行
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;
 
    //销毁方法，当移出服务时由web容器调用。整个生命周期中destroy方法只会执行一次
    //destroy方法可用于释放持有的资源，如内存、文件句柄等
    public void destroy();
}

フィルターの入力パラメーターはリクエストとレスポンスです。フィルターは通常、何らかの前処理作業を行うために使用されます。点検・確認等の作業を行います。

1.2 カスタム フィルター

public class LoginFilter implements Filter {
    @Override
    public void destroy() {
        System.out.println("filter destroy method");
    }
    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain filterChain)
            throws IOException, ServletException {
        System.out.println("filter doFilter method ");
        // 继续传递下去
        filterChain.doFilter(arg0,arg1);
    }
    @Override
    public void init(FilterConfig arg0) throws ServletException {
        System.out.println("filter init method");
    }
}

2. springboot にフィルターを登録するいくつかの方法

2.1 手動登録

@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean indexFilterRegistration() {
        FilterRegistrationBean registration = new FilterRegistrationBean(new LoginFilter());
        registration.addUrlPatterns("/");
        return registration;
    }
}

2.2 アノテーションの登録

2.2.1 アノテーション @WebFilter

@WebFilter(urlPatterns = "/",filterName = "filter1")
@Order(1)
public class LoginFilter implements Filter {
    @Override
    public void destroy() {
        System.out.println("filter destroy method");
    }
 
    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain filterChain)
            throws IOException, ServletException {
        System.out.println("filter doFilter method   1   ");
        filterChain.doFilter(arg0,arg1);
    }
 
    @Override
    public void init(FilterConfig arg0) throws ServletException {
        System.out.println("filter init method");
    }
}

2.2.2 アノテーション @ServletComponentScan

@SpringBootApplication
@ServletComponentScan
public class FilterTestApplication {
    public static void main(String[] args) {
        SpringApplication.run(FilterTestApplication.class, args);
    }
}

をスタートアップ クラスに追加します。 注:

@ServletComponentScan は、@WebFilter を使用してすべてのクラスをスキャンし、サーブレットとして登録します。

#スタートアップクラスがこのアノテーションを追加しない場合は、フィルタに Component アノテーションを追加することでフィルタとして登録することもできます

#order アノテーションでフィルタの順序を調整できます

2.3 servletContext による登録

@Autowired ServletContext servletContext; servletContext.addFilter()

3. 原則

3.1 ServletContext

Web コンテナは、起動時に Web アプリケーションごとに ServletContext オブジェクトを作成し、この ServletContextオブジェクトは現在の Web アプリケーションを表します。

A ServletContext オブジェクトは Web アプリケーションを表します。Web アプリケーション内のすべてのサーブレットとその他のリソースは、ServletContext オブジェクトを共有します。

必要に応じて、ServletContext オブジェクトを通じてサーブレット間で通信できます。

ServletContext は、情報のグローバル ストレージ スペースであり、サーバーの起動時に存在し、サーバーのシャットダウン時にのみ解放されます。ユーザーは複数のリクエストを持つことができます。セッション (ユーザーごとに 1 つ)、および servletContext (すべてのユーザーが 1 つを共有) です。

#ApplicationContext は ServletContext の実装クラスで、対応する登録メソッドがあることがわかります。

プログラム内で ServletContext を取得します

3.1.1 自動インジェクションを使用する

@Autowired private ServletContext servletContext;

3.1.2 リクエストを使用して servletContext を取得する

ServletContext servletContext = request.getServletContext();

3.1.3 ServletContextListener を実装する

@Component
public class TestListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println(sce);
    }
}

3.2 ServletRegistrationBean

Filter の定義を見ると、Webfilter アノテーションの内容と同じであることがわかります。

public class ServletRegistrationBean<T extends Servlet> extends DynamicRegistrationBean<ServletRegistration.Dynamic> {
    private static final String[] DEFAULT_MAPPINGS = new String[]{"/*"};
    private T servlet;
    private Set<String> urlMappings;
    private boolean alwaysMapUrl;
    private int loadOnStartup;
    private MultipartConfigElement multipartConfig;
    ......
    }

開発中、そのサブクラス FilterRegistrationBean は次のとおりです。一般的に使用され、手動登録は上記の 2.1 を使用して行われます。

以上がSpringbootにおけるフィルタの原理と登録方法は何ですかの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。