2. 程式人生 > 程式設計 >Spring Boot實踐——三種攔截器的建立

Spring Boot實踐——三種攔截器的建立

阿新 • • 發佈：2019-12-31

Spring中的攔截器

　　在web開發中，攔截器是經常用到的功能。它可以幫我們驗證是否登陸、許可權認證、資料校驗、預先設定資料以及統計方法的執行效率等等。今天就來詳細的談一下spring中的攔截器。spring中攔截器主要分種，一個是HandlerInterceptor，一個是MethodInterceptor。

一、HandlerInterceptor攔截器

　　HandlerInterceptor是springMVC專案中的攔截器，它攔截的目標是請求的地址，比MethodInterceptor先執行。實現一個HandlerInterceptor攔截器可以直接實現HandlerInterceptor介面，也可以繼承HandlerInterceptorAdapter類。這兩種方法殊途同歸，其實HandlerInterceptorAdapter也就是宣告瞭HandlerInterceptor介面中所有方法的預設實現，而我們在繼承他之後只需要重寫必要的方法。下面就是HandlerInterceptorAdapter的程式碼，可以看到一個方法只是預設返回true，另外兩個是空方法：

/** * 自定義攔截器-基於springmvc
 * @ClassName: CustomInterceptor 
 * @Description: springMVC專案中的攔截器，它攔截的目標是請求的地址，比MethodInterceptor先執行。
 *                 該攔截器只能過濾action請求，SPring允許多個攔截器同時存在，通過攔截器鏈管理。
 *                 當preHandle return true時，執行下一個攔截器，直到所有攔截器執行完，再執行被攔截的請求。
 *                 當preHandle return false時,不再執行後續的攔截器鏈及被攔截的請求。
 * @author OnlyMate
 * @Date 2018年8月28日 下午2:30:22  
 * */
public class CustomInterceptor implements HandlerInterceptor  {

    @Override public boolean preHandle(HttpServletRequest request,HttpServletResponse response,Object handler) throws Exception { // TODO Auto-generated method stub
        return HandlerInterceptor.super.preHandle(request,response,handler);
    }

    @Override public void postHandle(HttpServletRequest request,Object handler,ModelAndView modelAndView) throws Exception { // TODO Auto-generated method stub
        HandlerInterceptor.super.postHandle(request,handler,modelAndView);
    }

    @Override public void afterCompletion(HttpServletRequest request,Exception ex) throws Exception { // TODO Auto-generated method stub
        HandlerInterceptor.super.afterCompletion(request,ex);
    }

}複製程式碼

這三個方法都是幹什麼的，有什麼作用，什麼時候呼叫，不同的攔截器之間是怎樣的呼叫順序呢？這還得參考一下DispatcherServlet的doDispatch方法

protected void doDispatch(HttpServletRequest request,HttpServletResponse response) throws Exception {
        HttpServletRequest processedRequest = request;
        HandlerExecutionChain mappedHandler = null;
        boolean multipartRequestParsed = false;

        WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

        try {
            ModelAndView mv = null;
            Exception dispatchException = null;

            try {
                processedRequest = checkMultipart(request);
                multipartRequestParsed = (processedRequest != request);

                // Determine handler for the current request.
                mappedHandler = getHandler(processedRequest);
                if (mappedHandler == null) {
                    noHandlerFound(processedRequest,response);
                    return;
                }

                // Determine handler adapter for the current request.
                HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

                // Process last-modified header,if supported by the handler.
                String method = request.getMethod();
                boolean isGet = "GET".equals(method);
                if (isGet || "HEAD".equals(method)) {
                    long lastModified = ha.getLastModified(request,mappedHandler.getHandler());
                    if (logger.isDebugEnabled()) {
                        logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
                    }
                    if (new ServletWebRequest(request,response).checkNotModified(lastModified) && isGet) {
                        return;
                    }
                }

                if (!mappedHandler.applyPreHandle(processedRequest,response)) {
                    return;
                }

                // Actually invoke the handler.
                mv = ha.handle(processedRequest,mappedHandler.getHandler());

                if (asyncManager.isConcurrentHandlingStarted()) {
                    return;
                }

                applyDefaultViewName(processedRequest,mv);
                mappedHandler.applyPostHandle(processedRequest,mv);
            }
            catch (Exception ex) {
                dispatchException = ex;
            }
            catch (Throwable err) {
                // As of 4.3,we're processing Errors thrown from handler methods as well,// making them available for @ExceptionHandler methods and other scenarios.
                dispatchException = new NestedServletException("Handler dispatch failed",err);
            }
            processDispatchResult(processedRequest,mappedHandler,mv,dispatchException);
        }
        catch (Exception ex) {
            triggerAfterCompletion(processedRequest,ex);
        }
        catch (Throwable err) {
            triggerAfterCompletion(processedRequest,new NestedServletException("Handler processing failed",err));
        }
        finally {
            if (asyncManager.isConcurrentHandlingStarted()) {
                // Instead of postHandle and afterCompletion
                if (mappedHandler != null) {
                    mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest,response);
                }
            }
            else {
                // Clean up any resources used by a multipart request.
                if (multipartRequestParsed) {
                    cleanupMultipart(processedRequest);
                }
            }
        }
    }複製程式碼

　　程式碼有點長，但是它封裝了springMVC處理請求的整個過程。首先根據請求找到對應的HandlerExecutionChain，它包含了處理請求的handler和所有的HandlerInterceptor攔截器；然後在呼叫hander之前分別呼叫每個HandlerInterceptor攔截器的preHandle方法，若有一個攔截器返回false，則會呼叫triggerAfterCompletion方法，並且立即返回不再往下執行；若所有的攔截器全部返回true並且沒有出現異常，則呼叫handler返回ModelAndView物件；再然後分別呼叫每個攔截器的postHandle方法；最後，即使是之前的步驟丟擲了異常，也會執行triggerAfterCompletion方法。關於攔截器的處理到此為止，接下來看看triggerAfterCompletion做了什麼

private void triggerAfterCompletion(HttpServletRequest request,@Nullable HandlerExecutionChain mappedHandler,Exception ex) throws Exception {

        if (mappedHandler != null) {
            mappedHandler.triggerAfterCompletion(request,ex);
        }
        throw ex;
    }複製程式碼

　　根據以上的程式碼，分析一下不同攔截器及其方法的執行順序。假設有5個攔截器編號分別為12345，若一切正常則方法的執行順序是12345的preHandle，54321的postHandle，54321的afterCompletion。若編號3的攔截器的preHandle方法返回false或者丟擲了異常，接下來會執行的是21的afterCompletion方法。這裡要注意的地方是，我們在寫一個攔截器的時候要謹慎的處理preHandle中的異常，因為這裡一旦有異常丟擲就不會再受到這個攔截器的控制。12345的preHandle的方法執行過之後，若handler出現了異常或者某個攔截器的postHandle方法出現了異常，則接下來都會執行54321的afterCompletion方法，因為只要12345的preHandle方法執行完，當前攔截器的攔截器就會記錄成編號5的攔截器，而afterCompletion總是從當前的攔截器逆向的向前執行。　　另外，實現HandlerInterceptor攔截器還有一個方法，就是實現WebRequestInterceptor介面。其實它和剛才的兩種方法也是殊途同歸，最終還是被spring適配成HandlerInterceptor。有一點不同，它的preHandle方法最終只會返回true。

這裡可以根據自己的需求在對應方法中寫自己業務處理邏輯

/**
 * 自定義攔截器-基於springmvc
 * @ClassName: CustomInterceptor 
 * @Description: springMVC專案中的攔截器，它攔截的目標是請求的地址，比MethodInterceptor先執行。
 *                 該攔截器只能過濾action請求，SPring允許多個攔截器同時存在，通過攔截器鏈管理。
 *                 當preHandle return true時，執行下一個攔截器，直到所有攔截器執行完，再執行被攔截的請求。
 *                 當preHandle return false時,不再執行後續的攔截器鏈及被攔截的請求。
 * @author OnlyMate
 * @Date 2018年8月28日 下午2:30:22  
 *
 */
public class CustomInterceptor implements HandlerInterceptor  {
    private Logger logger = LoggerFactory.getLogger(CustomInterceptor.class);
    
    /**
     * 在請求處理之前執行，主要用於許可權驗證、引數過濾等
     */
    @Override
    public boolean preHandle(HttpServletRequest request,Object handler)
            throws Exception {
        logger.info("CustomInterceptor ==> preHandle method: do request before");
        return true;
    }

    /**
     * 當前請求進行處理之後執行，主要用於日誌記錄、許可權檢查、效能監控、通用行為等
     */
    @Override
    public void postHandle(HttpServletRequest request,ModelAndView modelAndView) throws Exception {
        logger.info("CustomInterceptor ==> postHandle method: do request after");
    }

    /**
     * 當前對應的interceptor的perHandle方法的返回值為true時,postHandle執行完成並渲染頁面後執行，主要用於資源清理工作
     */
    @Override
    public void afterCompletion(HttpServletRequest request,Exception ex)
            throws Exception {
        logger.info("CustomInterceptor ==> afterCompletion method: do request finshed");
    }
}複製程式碼

配置如下：

/**
 * Web MVC 配置介面卡
 * @ClassName: WebAppConfigurer 
 * @Description: 
 * @author OnlyMate
 * @Date 2018年8月28日 下午2:39:31  
 * 
 * WebAppConfigurer extends WebMvcConfigurerAdapter 在Spring Boot2.0版本已過時了，用官網說的新的類替換
 *
 */
@Configuration
public class WebAppConfigurer implements WebMvcConfigurer {
    /**
     * 注入自定義攔截器
     * @Title: addInterceptors 
     * @Description: 先add的攔截器會越靠外，即越靠近瀏覽器
     * @Date 2018年8月28日 下午2:47:28 
     * @author OnlyMate
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        WebMvcConfigurer.super.addInterceptors(registry);
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/**");//攔截所有請求
    }

}複製程式碼

二、MethodInterceptor攔截器

　　MethodInterceptor是AOP專案中的攔截器，它攔截的目標是方法，即使不是controller中的方法。實現MethodInterceptor攔截器大致也分為兩種，一種是實現MethodInterceptor介面，另一種利用AspectJ的註解或配置。

1、實現MethodInterceptor介面

/**
 * 自定義攔截器-方法攔截器，基於spring aop
 * @ClassName: CustomMethodInterceptor 
 * @Description: AOP專案中的攔截器，它攔截的目標是方法
 *                 配置在applicationContext.xml中
 * @author OnlyMate
 * @Date 2018年8月29日 下午3:35:24  
 *
 */
public class CustomMethodInterceptor implements MethodInterceptor {
    private Logger logger = LoggerFactory.getLogger(CustomMethodInterceptor.class);
    
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        logger.info("CustomMethodInterceptor ==> invoke method: process method name is {}",invocation.getMethod().getName());
        
        //TODO 處理操作
        
        return invocation.proceed();
    }

}複製程式碼

配置說明

<bean id="customMethodInterceptor" class="com.onlymate.springboot.interceptor.CustomMethodInterceptor" />
    
    <aop:config proxy-target-class="false">
        <!-- 方法攔截器，基於spring aop 實現配置 -->
        <!-- 掃描使用了註解的方法進行攔截 -->
        <aop:advisor pointcut="@annotation(com.onlymate.springboot.annotation.CustomAnnotation)" advice-ref="customMethodInterceptor" />
        <!-- 指定包路徑下的方法 -->
        <aop:advisor pointcut="execution(* com.onlymate.springboot.controller.*.*(..))" advice-ref="customMethodInterceptor" />
    </aop:config>複製程式碼

CustomAnnotation自定義註解

/**
 * 自定義註解物件
 * @ClassName: TableSplit 
 * @Description: TODO
 * @author OnlyMate
 * @Date 2018年5月22日 上午11:43:57  
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomAnnotation {
    /** 需攔截方法名描述 */
    String name() default "";
    
    /** 加密 */
    String[] encrypt() default {};

    /** 解密 */
    String[] decrypt() default {};

}複製程式碼

2、利用AspectJ的註解或配置

　a、基於AspectJ註解

/**
 * 自定義攔截器-方法攔截器，基於註解的AspectJ方式
 * @ClassName: CustomAutoAspectJInterceptor 
 * @Description: 配置在applicationContext.xml中
 * @author OnlyMate
 * @Date 2018年8月29日 下午4:03:49  
 *
 */
@Component
@Aspect
public class CustomAutoAspectJInterceptor {
    private Logger logger = LoggerFactory.getLogger(CustomAutoAspectJInterceptor.class);
    
    @Around("execution (* com.onlymate.springboot.controller.*.*(..))")
    public Object around(ProceedingJoinPoint point) throws Throwable{
        logger.info("CustomAutoAspectJInterceptor ==> invoke method: process method class is {}",point.getTarget().getClass());
        
        //TODO 處理操作
        
        return point.proceed();
    }
}複製程式碼

b、基於AspectJ配置

/**
 * 自定義攔截器-方法攔截器，基於AspectJ方式
 * @ClassName: CustomAspectJInterceptor 
 * @Description: 配置在applicationContext.xml中
 * @author OnlyMate
 * @Date 2018年8月29日 下午4:03:49  
 *
 */
public class CustomAspectJInterceptor {
    private Logger logger = LoggerFactory.getLogger(CustomAspectJInterceptor.class);
    
    public Object around(ProceedingJoinPoint point) throws Throwable{
        logger.info("CustomAspectJInterceptor ==> invoke method: process method class is {}",point.getTarget().getClass());
        
        //TODO 處理操作
        
        return point.proceed();
    }
}複製程式碼

c、配置說明

<bean id="customAspectJInterceptor" class="com.onlymate.springboot.interceptor.CustomAspectJInterceptor"/>
    <aop:config proxy-target-class="false">
        <!-- 方法攔截器，基於AspectJ實現方式一 -->
        <aop:aspect ref="customAspectJInterceptor">
            <aop:around method="around" pointcut="execution(* com.onlymate.springboot.controller.*.*(..))"/>
        </aop:aspect>
        
    </aop:config>

    <!-- 方法攔截器，基於AspectJ實現方式二 -->
    <!-- 自動掃描使用了aspectj註解的類 -->
    <aop:aspectj-autoproxy/>複製程式碼

三、效果圖

201908161453001

四、談一談區別

　　上面的兩種攔截器都能起到攔截的效果，但是他們攔截的目標不一樣，實現的機制不同，所以有的時候適用不同的場景。HandlerInterceptoer攔截的是請求地址，所以針對請求地址做一些驗證、預處理等操作比較合適。當你需要統計請求的響應時間時MethodInterceptor將不太容易做到，因為它可能跨越很多方法或者只涉及到已經定義好的方法中一部分程式碼。MethodInterceptor利用的是AOP的實現機制，在本文中只說明瞭使用方式，關於原理和機制方面介紹的比較少，因為要說清楚這些需要講出AOP的相當一部分內容。在對一些普通的方法上的攔截HandlerInterceptoer就無能為力了，這時候只能利用AOP的MethodInterceptor。利用MethodInterceptor就可以很容易的實現一個日誌攔截處理。另外，還有一個跟攔截器類似的東西----Filter。Filter是Servlet規範規定的，不屬於spring框架，也是用於請求的攔截。但是它適合更粗粒度的攔截，在請求前後做一些編解碼處理、日誌記錄等。而攔截器則可以提供更細粒度的，更加靈活的，針對某些請求、某些方法的組合的解決方案。

相關推薦

Spring Boot實踐——三種攔截器的建立

Spring中的攔截器 　　在web開發中，攔截器是經常用到的功能。它可以幫我們驗證是否登陸、許可權認證、資料校驗、預先設定資料以及統計方法的執行效率等等。今天就來詳細的談一下spring中的攔截器。spring中攔截器主

Spring Boot專案中定製攔截器的方法詳解

這篇文章主要介紹了Spring Boot專案中定製攔截器的方法詳解,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

spring中的過濾器與攔截器

過濾器 Filter 什麼是過濾器？ 與 Servlet 相似，過濾器是一些 web 應用程式元件，可以繫結到一個 web 應用程式中。但是與其他 web 應用元件不同的是，過濾器是“鏈”在容器的處理過程中的。這就意味著它們可以在請求

Spring Boot的兩種配置檔案--properties VS yaml

10月份剛剛換了新工作，這也預示著全面轉向Java技術棧，帶著對Spring， Spring Boot， Mybatis， Maven等一切懵懂入職了新公司，領導第二天就發給我一個git倉庫的連結，告訴我這個我們的專案模板，本著先讓程式碼跑起

Spring Boot （三）： ORM 框架 JPA 與連線池 Hikari

前面兩篇文章我們介紹瞭如何快速建立一個 Spring Boot 工程《Spring Boot（一）：快速開始》和在 Spring Boot 中如何使用模版引擎 Thymeleaf 渲染一個Web頁面《Spring Boot （二）：模版引擎 Thymeleaf 渲染 Web 頁

Spring Boot實踐——SpringMVC檢視解析

一、註解說明   在spring-boot+spring mvc 的專案中，有些時候我們需要自己配置一些專案的設定，就會涉及到這三個，那麼，他們之間有什麼關係呢？

Spring Boot 請求頭token攔截 Swagger 支援請求頭

適用介面需授權token才能呼叫的場景 @Configuration public class WebMvcConfigurer extends WebMvcConfigurationSupport {

spring boot redis 五種型別使用例項

package com.itheima.redis; import com.itheima.pojo.User; import org.junit.Test; import org.junit.runner.RunWith;

spring boot隨筆三

Web開發 1、使用SpringBoot： 1）建立SpringBoot應用，選中需要的模組2）SpringBoot已經預設將這些場景配置好了，只需要在配置檔案中指定少量配置就可以執行起來3）自己編寫業務程式碼

spring cors的三種方式

@CrossOrigin 註解 如果想要對某一介面配置 CORS，可以在方法上新增 @CrossOrigin 註解 ：

YAML的語法格式（Spring Boot初識 三）

技術標籤：ssmspring bootspringyaml 目錄 一.使用Spring Initializer 快速建立Spring boot專案。

利用Spring Boot輕鬆實現動態定時器開發！

前言 傳統定時器是硬編碼。但是有的時候業務上需要不斷地調整 問題描述 我們開發了一個定鬧鐘的功能。這個功能肯定是定時器開發。但是這就存在一個問題這個定時是動態的。那麼我們如何實現呢？Spring Boot核心學習

三種執行緒建立的例項

package com.yeyue.thread; import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException;

springmvc學習指南 之---第25篇 Spring Bean有三種配置方式

writed by不要張豔濤, 從tomcat轉到了springmvc 現在開始有點不知道該看什麼書了,看完了springmvc 學習指南之後

Spring筆記（三）：IOC建立物件方式

時間：2021/10/24 下面是IOC建立物件的常用方式： 1.預設使用無參構造建立物件。

Spring Boot實踐——AOP實現

借鑑：http://www.cnblogs.com/xrq730/p/4919025.html 　　 https://blog.csdn.net/zhaokejin521/article/details/50144753

Spring Boot實踐——Mybatis分頁外掛PageHelper的使用

出自：https://blog.csdn.net/csdn_huzeliang/article/details/79350425 在springboot中使用PageHelper外掛有兩種較為相似的方式，接下來我就將這兩種方式進行總結。

java 建立執行緒的三種方式、建立執行緒池的四種方式

概要： java建立執行緒的三種方式： **繼承Thread類建立執行緒類** **實現Runnable介面**

Spring Boot 自定義Maven Archetype快速建立工程專案

一、Maven Archetype是啥 Archetype 是 Maven 的工程模板，使用 Archetype 可以快速建立一個統一結構的工程，提高效率。Maven 有一些自帶的 Archetype，但是很多時候不能滿足我們的需求，因此需要自定義Archetype 以

仿牛客網社群開發——第2章 Spring Boot實踐，開發社群登入模組

傳送郵件 郵箱設定 - 啟動客戶端SMTP服務 以新浪郵箱為例： 將設定中的POP3/SMTP服務中的服務狀態設定為開啟。