Spring MVCでサーブレットフィルタを登録する方法

投稿日: 2019-11-05 2019-11-05
タグ: filter, Spring MVC

簡単に言えば、サーブレットフィルタを使用すると、Webアプリケーションで要求と応答をインターセプトできます。この記事では、Spring XMLとJavaConfigにサーブレットフィルタを登録する方法を説明します。

1.サーブレットフィルタ

次のカスタムフィルタを確認すると、例外が検出され、エラーページにリダイレクトされます。

package com.mkyong.form.web;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class ErrorHandleFilter implements Filter {

    @Override
    public void destroy() {
       //...
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
       //    }

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

        try {
            chain.doFilter(request, response);
        } catch (Exception ex) {
            request.setAttribute("errorMessage", ex);
            request.getRequestDispatcher("/WEB-INF/views/jsp/error.jsp")
                               .forward(request, response);
        }

    }

}

2. Spring XML

Spring MVC XML設定では、 `web.xml`を介してフィルタを登録できます

web.xml

    <filter>
        <filter-name>errorHandlerFilter</filter-name>
        <filter-class>com.mkyong.form.web.ErrorHandleFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>errorHandlerFilter</filter-name>
        <url-pattern>/** </url-pattern>
    </filter-mapping>

3. Spring JavaConfig

Spring MVC JavaConfigでは、 `web.xml`ファイルはありません。初期化子クラスを介してフィルタを登録することができます。

MyWebInitializer.java

package com.mkyong.form.config.servlet3;

import javax.servlet.Filter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import com.mkyong.form.config.SpringRootConfig;
import com.mkyong.form.config.SpringWebConfig;
import com.mkyong.form.web.ErrorHandleFilter;

public class MyWebInitializer extends
        AbstractAnnotationConfigDispatcherServletInitializer {

   //...

    @Override
    protected Filter[]getServletFilters() {
        return new Filter[]{new ErrorHandleFilter()};
    }
}