SpringBoot系列（十一）攔截器的使用與配置定庵，你知道多少？

往期推薦

1. 攔截器介紹

?攔截器是在servlet執(zhí)行之前執(zhí)行的程序（這里就是controller代碼執(zhí)行之前）宗挥，它主要是用于攔截用戶請求并作相應的處理，比如說可以判斷用戶是否登錄种蝶，做相關的日志記錄契耿，也可以做權限管理。

?SpringBoot中的攔截器實現(xiàn)和spring mvc 中是一樣的螃征，它的大致流程是搪桂，先自己定義一個攔截器類，并將這個類實現(xiàn)一個HandlerInterceptor類盯滚，或者是繼承HandlerInterceptorAdapter踢械，都可以實現(xiàn)攔截器的定義。然后將自己定義的攔截器注入到適配器中淌山，也有兩種方式裸燎，一種是實現(xiàn)WebMvcConfigurer接口，一種是繼承WebMvcConfigurerAdapter泼疑。下面我們來看看如何完成德绿。

2.自定義攔截器

直接上代碼，再進行一些代碼講解退渗。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("進入攔截器了");
        //中間寫邏輯代碼移稳，比如判斷是否登錄成功，失敗則返回false
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        //
        System.out.println("controller 執(zhí)行完了");
    }


    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        System.out.println("我獲取到了一個返回的結果："+response);
        System.out.println("請求結束了");
    }
}

?代碼說明：

自定義的攔截器可以實現(xiàn)HandlerInterceptor接口会油，也可以繼承HandlerInterceptorAdapter類个粱。
重寫三個方法，當然也可以只實現(xiàn)一個最重要的preHandle方法翻翩。
preHandle方法：此方法會在進入controller之前執(zhí)行都许，返回Boolean值決定是否執(zhí)行后續(xù)操作。
postHandle方法：此方法將在controller執(zhí)行之后執(zhí)行嫂冻，但是視圖還沒有解析胶征，可向ModelAndView中添加數(shù)據(jù)(前后端不分離的)。
afterCompletion方法：該方法會在整個請求結束（請求結束桨仿，但是并未返回結果給客戶端）之后執(zhí)行睛低，可獲取響應數(shù)據(jù)及異常信息。

3.攔截器注入適配器

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**")//攔截所有的路徑
                .excludePathPatterns("/LoginController/login");
    }
}

?代碼說明：

通過實現(xiàn)WebMvcConfigurer接口可以自定義一個適配器，也可以通過繼承WebMvcConfigurerAdapter來定義適配器钱雷，建議使用第一種骂铁，第二種已經(jīng)是過時的方法了。
重寫addInterceptors方法罩抗，addInterceptor方法是將攔截器注入到適配器中拉庵。
addPathPatterns方法是設置一個需要攔截的路徑，可以是多個字符串或者是直接傳入一個數(shù)組澄暮。
excludePathPatterns是配置不需要攔截的路徑名段。
需要加上configuration注解說明這是一個配置類，在項目啟動的時候自動執(zhí)行泣懊。

4.controller測試

?先創(chuàng)建一個登陸的測試，這個接口是不會攔截的麻惶。

@RestController
@RequestMapping("LoginController")
public class Login {
    @RequestMapping("/login")
    public String login(){
        System.out.println("controller開始執(zhí)行");
        return "login success";
    }
}

?創(chuàng)建一個攔截的controller

@RestController
@RequestMapping("/hello")
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("經(jīng)過攔截的controller代碼執(zhí)行完畢");
        return "hello";
    }
}

5. 測試

測試未攔截的接口,瀏覽器輸入：localhost:8097/LoginController/login馍刮，查看控制臺輸出情況。

login.png

控制臺只輸出了未攔截接口內(nèi)的代碼窃蹋，說明這個接口是未攔截的卡啰。瀏覽器的顯示就不管了。其實一般是攔截登錄接口警没，這里就將它放開了匈辱，以供測試。

測試攔截的接口杀迹，瀏覽器輸入：localhost:8097/hello/hello,查看控制臺輸出情況亡脸。

response.png

可以看到，首先是進入了攔截器树酪，通過攔截器之后浅碾，進入了controller中的方法，執(zhí)行完controller的代碼之后就進入了自定義攔截器中的postHandle方法续语，最后進入afterCompletion方法垂谢，并獲取到了一個response對象。

6. 擴展內(nèi)容：攔截器鏈

?我們可以定義多個攔截器組成一個攔截器鏈疮茄。我們可以在適配器中注入多個攔截器滥朱。多加一行代碼就行了。

?按照攔截器注入的順序力试，攔截器的執(zhí)行順序應該是一下順序：攔截器1徙邻，攔截器2，攔截器2處理懂版，攔截器1處理鹃栽，攔截器2結束，攔截器1結束。對應三個過程的方法就是preHandle,postHandle,afterCompletion民鼓。

7. 總結

?本文從攔截器的自定義到自定義適配器薇芝，然后將攔截器注入適配器，再到編寫測試代碼丰嘉。準備工作完成之后就進行一個測試攔截器是否成功夯到，最后擴展出攔截器鏈的一些內(nèi)容。如果你覺得本文對你有用饮亏，三連走起耍贾！

導出圖片Mon Apr 27 2020 19_02_22 GMT+0800 (中國標準時間).png

SpringBoot系列（十一）攔截器的使用與配置撬讽，你知道多少？

SpringBoot系列（十一）攔截器的使用與配置迂卢，你知道多少恢着？