SpringBoot攔截器的配置使用介紹

更新時(shí)間：2022年10月21日 10:33:19 作者：劉婉晴

攔截器可以用來(lái)實(shí)現(xiàn)未滿足某些條件，不容許訪問(wèn)某些資源。SpringBoot 支持?jǐn)r截器，本文主要介紹攔截器的使用與原理

1. 配置攔截器

具體步驟：

編寫一自定義攔截器類實(shí)現(xiàn)接口 HandlerInterceptor

HandlerInterceptor 接口: 可在三處進(jìn)行攔截——目標(biāo)方法執(zhí)行之前、目標(biāo)方法執(zhí)行完成、頁(yè)面渲染以后攔截

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }
    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

將攔截器注冊(cè)到容器中，實(shí)現(xiàn) WebMvcConfigurer 中的 addInteraptor，然后將自定義攔截器注冊(cè)到攔截器中

指定攔截器規(guī)則 —— 攔截所有 '/**' ，靜態(tài)資源也會(huì)被攔截

解決靜態(tài)資源同時(shí)被攔截問(wèn)題：

在addPathPatterns中精確指定精確需要攔截資源
在 excludePathPatterns 中指定排除靜態(tài)資源

可在 application.properties 文件中指定靜態(tài)資源統(tǒng)一前綴，方便排除靜態(tài)資源

spring.mvc.static-path-pattern=/static/**

2. 一個(gè)小 Demo

實(shí)現(xiàn)未登錄用戶不能訪問(wèn)除登錄頁(yè)外其他頁(yè)面的小Demo

1. 自定義攔截器類—LoginInterceptor

自定義登錄攔截器，實(shí)現(xiàn)檢測(cè)到用戶未登錄，則攔截用戶對(duì)其他資源的訪問(wèn)，并返回到登錄頁(yè)面

package com.wanqing.admin.interceptor;
import lombok.extern.slf4j.Slf4j;
import org.apache.catalina.Session;
import org.springframework.lang.Nullable;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
/*
登錄檢查
 */
@Slf4j // lombok 提供的功能
public class LoginInterceptor implements HandlerInterceptor {
    // 目標(biāo)方法執(zhí)行之前
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
       log.info("攔截的路徑是{}", request.getRequestURI());
        // 登錄檢查邏輯
        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("loginUser");
        if(loginUser != null){
            return true; // 放行
        }
        // 攔截住，重定向到登錄頁(yè)面
        request.setAttribute("msg", "未登錄不允許訪問(wèn)");
        request.getRequestDispatcher("/").forward(request, response); // 轉(zhuǎn)發(fā)到當(dāng)前請(qǐng)求
        return false;
    }
    // 目標(biāo)方法執(zhí)行之后
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }
    // 頁(yè)面渲染完成之后
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

2. 將攔截器注冊(cè)到容器中

通過(guò)下列方法，將攔截器注冊(cè)到容器中，并配置好要攔截的路徑和要放行的路徑。本次 demo 中若未登錄則所有路徑都攔截，只放行登錄頁(yè)面

package com.wanqing.admin.config;
import com.wanqing.admin.interceptor.LoginInterceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class AdminWebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 在攔截器的注冊(cè)中心里，添加 Login 攔截器
        registry.addInterceptor(new LoginInterceptor())
                    .addPathPatterns("/**") //所有請(qǐng)求都被攔截，靜態(tài)資源也被攔截
                    .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**"); // 放行的請(qǐng)求
    }
}

3. 原理分析

1. 根據(jù)當(dāng)前請(qǐng)求，找到HandlerExecutionChainand，即得到可以處理請(qǐng)求的 Handler，以及 Handler 的所有攔截器

處理器執(zhí)行鏈：

2. 先順序執(zhí)行所有攔截器的preHandle方法

如果返回為true執(zhí)行下一個(gè)攔截器的preHandle;
若為 false，直接倒敘執(zhí)行所有已經(jīng)執(zhí)行了的攔截器的 afterCompletion 方法

Step into：

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

攔截器方法執(zhí)行源碼分析：

HandlerExecutionChain.class

—— 順序執(zhí)行所有攔截器的preHandle方法

 for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
     HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
     if (!interceptor.preHandle(request, response, this.handler)) {
         this.triggerAfterCompletion(request, response, (Exception)null);
         return false;
     }
 }

—— 倒敘執(zhí)行所有已經(jīng)執(zhí)行了的攔截器的 afterCompletion 方法

    void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
        for(int i = this.interceptorIndex; i >= 0; --i) {
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            try {
                interceptor.afterCompletion(request, response, this.handler, ex);
            } catch (Throwable var7) {
                logger.error("HandlerInterceptor.afterCompletion threw exception", var7);
            }
        }
    }

3. 如果任何一個(gè)攔截器返回 false，直接跳出不執(zhí)行目標(biāo)方法

4. 所有攔截器都返回 true，執(zhí)行目標(biāo)方法

5. 目標(biāo)方法執(zhí)行后，倒敘執(zhí)行所有攔截器的 postHandle 方法

6. 前面的步驟有任何異常都會(huì)直接觸發(fā) afterCompletion 方法

7. 頁(yè)面成果渲染完成之后，也會(huì)倒敘觸發(fā) afterCompletion 方法

圖解：