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

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

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

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

次のカスタムフィルターを確認すると、例外をキャッチしてエラーページにリダイレクトします。

package com.example.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

    
        errorHandlerFilter
        com.example.form.web.ErrorHandleFilter
    
    
        errorHandlerFilter
        /*
    

3. Spring JavaConfig

Spring MVC + JavaConfig + noweb.xmlファイルでは、初期化子クラスを介してフィルターを登録できます。

MyWebInitializer.java

package com.example.form.config.servlet3;

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

public class MyWebInitializer extends
        AbstractAnnotationConfigDispatcherServletInitializer {

    //...

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