SpringBoot(11) SpringBoot自定義攔截器

自定義攔截器共兩步：第一：注冊。第二：定義攔截器。

一、注冊 @Configuration

繼承WebMvcConfigurationAdapter(SpringBoot2.X之前舊版本)

舊版本代碼

@Configuration
public class CustomOldWebMvcConfigurer extends WebMvcConfigurerAdapter {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new LoginIntercepter()).addPathPatterns("/api/");
        
        super.addInterceptors(registry);
    }

}

 

SpringBoot2.X 新版本配置攔截器 implements WebMvcConfigurer

新版本代碼

@Configuration
public class CustomWebMvcConfigurer implements WebMvcConfigurer  {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new LoginIntercepter()).addPathPatterns("/api2/*/**").excludePathPatterns("/api2/xxx/**");;
        registry.addInterceptor(new TwoIntercepter()).addPathPatterns("/api2/*/**");
        WebMvcConfigurer.super.addInterceptors(registry);
    }

}

二、定義攔截器 HandlerInterceptor

1、LoginIntercepter

public class LoginIntercepter implements HandlerInterceptor{

    /**
     * 進入controller方法之前
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {
        System.out.println("LoginIntercepter------->preHandle");

//        String token = request.getParameter("access_token");
//        
//        response.getWriter().print("fail");
//        return true;
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    /**
     * 調用完controller之后，視圖渲染之前
     */
    @Override
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        
        System.out.println("LoginIntercepter------->postHandle");
        
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    /**
     * 整個完成之后，通常用於資源清理
     */
    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("LoginIntercepter------->afterCompletion");
        
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
    
}

2、TwoIntercepter

public class TwoIntercepter implements HandlerInterceptor{

    /**
     * 進入對應的controller方法之前
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {

        System.out.println("TwoIntercepter------>preHandle");
        
        //return true;
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    /**
     * controller處理之后，返回對應的視圖之前
     */
    @Override
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("TwoIntercepter------>postHandle");
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    /**
     * 整個請求結束后調用，視圖渲染后，主要用於資源的清理
     */
    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("TwoIntercepter------>afterCompletion");
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }

    
}

注：

1. 三個重載方法說明

preHandle：調用Controller某個方法之前

postHandle：Controller之后調用，視圖渲染之前，如果控制器Controller出現了異常，則不會執行此方法

afterCompletion：不管有沒有異常，這個afterCompletion都會被調用，用於資源清理

2.順序

按照注冊順序進行攔截，先注冊，先被攔截

三、攔截器不生效常見問題：

1）是否有加@Configuration
2）攔截路徑是否有問題 ** 和 *
3）攔截器最后路徑一定要 “/**”， 如果是目錄的話則是 /*/

四、過濾器與攔截器的區別

Filter是基於函數回調 doFilter()，而Interceptor則是基於AOP思想

Filter在只在Servlet前后起作用，而Interceptor夠深入到方法前后、異常拋出前后等

依賴於Servlet容器即web應用中，而Interceptor不依賴於Servlet容器所以可以運行在多種環境。

在接口調用的生命周期里，Interceptor可以被多次調用，而Filter只能在容器初始化時調用一次。

Filter和Interceptor的執行順序：過濾前->攔截前->action執行->攔截后->過濾后