快捷導航

一文教你搞懂SpringBoot自定義攔截器的思路

更新時間：2023年08月03日 08:29:28 作者：DaenCode

在開發(fā)中，都離不開攔截器的使用，比如說在開發(fā)登錄功能時，實現(xiàn)權(quán)限管理功能時等，這篇文章主要帶大家使用SpringBoot梳理自定義攔截器的思路，需要的可以參考一下

前言

在開發(fā)中，都離不開攔截器的使用。比如說在開發(fā)登錄功能時，采用JWT登錄時通過對token進行驗證實現(xiàn)登錄攔截的功能；實現(xiàn)權(quán)限管理功能時，通過對角色權(quán)限的攔截實現(xiàn)權(quán)限功能。下面帶你使用SpringBoot梳理自定義攔截器的思路。

前置知識

@Configuration：用于標識一個全局配置類。注冊到spring容器中，相當于xml配置時的beans標簽。@Bean：用于標識全局配置類中的自定義攔截方法上，進行攔截對象的創(chuàng)建，方便后續(xù)注冊。

具體實現(xiàn)步驟

定義攔截器類

自定義攔截器類：負責定義攔截的處理邏輯，包含前置攔截、后置攔截和最終攔截。以下是對其API的介紹。

API介紹

在方法參數(shù)中，HttpServletRequest代表客戶端的請求，HttpServletResponse代表返回給客戶端的響應(yīng)。Object handler是目標處理器（如控制器方法）的實例，ModelAndView用于傳遞模型數(shù)據(jù)和視圖名稱。

方法名	方法簽名	作用
preHandle	boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception	在目標處理器執(zhí)行之前被調(diào)用?？梢赃M行一些前置處理邏輯，如權(quán)限驗證、日志記錄等。返回值決定請求是否繼續(xù)執(zhí)行后續(xù)流程，true表示繼續(xù)執(zhí)行，false表示中斷請求處理
postHandle	void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception	在目標處理器執(zhí)行之后、視圖渲染之前被調(diào)用?？梢詫憫?yīng)結(jié)果進行一些后置處理，如添加公共數(shù)據(jù)、修改視圖等。此時可以對目標處理器的執(zhí)行結(jié)果進行修改
afterCompletion	void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception	在整個請求處理完畢后被調(diào)用?？梢赃M行一些清理工作，如資源釋放、日志記錄等。無法改變響應(yīng)結(jié)果

思路：

創(chuàng)建攔截器類TestInterceptor并實現(xiàn)HandlerInterceptor。
根據(jù)其對應(yīng)的API結(jié)合業(yè)務(wù)，在對應(yīng)方法上實現(xiàn)相應(yīng)的處理邏輯。

public class TestInterceptor implements HandlerInterceptor {
    //前置處理器。進入到Controller層方法之前執(zhí)行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //TODO 前置攔截的處理邏輯
        //1.判斷用戶是否登錄，登錄返回true
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }
    //后置處理器。視圖渲染之前執(zhí)行的方法，對響應(yīng)結(jié)果進行處理。
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        //TODO 后置攔截的處理邏輯
        //添加某些數(shù)據(jù)等等
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }
    //最終處理器。整個請求完成之后執(zhí)行。
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // TODO 最終攔截處理器
        //1.記錄日志
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

定義攔截器配置類

攔截器配置類：負責注冊相應(yīng)的攔截器。

思路：

創(chuàng)建攔截器配置類。并用@Configuration標識、實現(xiàn)WebMvcConfigurer接口。
創(chuàng)建生成攔截器對象的方法。并用@Bean標識。方便攔截器的注冊。
實現(xiàn)addInterceptors方法，進行攔截器的注冊。

@Configuration
public class TestInterceptorConfig implements WebMvcConfigurer {
    @Bean
    public TestInterceptor testInterceptor(){
        return new TestInterceptor();
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(testInterceptor()).addPathPatterns("/test/**");
        WebMvcConfigurer.super.addInterceptors(registry);
    }
}