SpringMVC インターセプターの設定方法

2年 ago
海斗, 葵
1 minute

Spring MVCインターセプターを設定するには、次の手順に従います。

  1. ハンドラインターセプターインターフェースを実装するクラスを作成します。このインターフェースには、3 つのメソッドが含まれています。リクエストを処理する前に呼び出される preHandle、リクエストを処理した後に呼び出される postHandle、ビューのレンダリング後に呼び出される afterCompletion です。必要に応じてこれらのメソッドをオーバーライドできます。
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 在请求处理之前进行调用（Controller方法调用之前）
        return true; // 返回true才会继续向下执行，返回false取消当前请求
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // 请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        // 在整个请求结束之后被调用，也就是在DispatcherServlet渲染了对应的视图之后执行（主要是用于进行资源清理工作）
    }

}
  1. インターセプター

XML 設定にて

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>  <!-- 拦截所有请求 -->
        <bean class="com.example.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

ネイティブにJavaで構成します。

@Configuration
@EnableWebMvc
public class AppConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); // 拦截所有请求
    }
}

Java 設定を使用されている場合は、@EnableWebMvc アノテーションを構成クラスに追加する必要があることに注意してください。

これにより、Controllerにリクエストが届く前にはSpring MVCがインターセプターのpreHandleメソッドを呼び出し、Controllerメソッドの呼び出し後はpostHandleメソッドを呼び出し、ビューの描画後はafterCompletionメソッドを呼び出します。

bannerAds