day13-自定義攔截器

一刀一個小西瓜發表於2023-02-18

自定義攔截器

1.什麼是攔截器

說明：

攔截器與過濾器的區別

SpringMVC 的攔截器（Interceptor）與 Java Servlet 的過濾器（Filter）類似，它主要用於攔截使用者的請求並做相應的處理，通常應用在許可權驗證、記錄請求資訊的日誌、判斷使用者是否登入等功能上。

  1. SpringMVC 也可以使用攔截器對請求進行攔截處理，使用者可以自定義攔截器來實現特定的功能

  2. 自定義的攔截器必須實現 HandlerInterceptor 介面

  3. 自定義攔截器的三個方法：

（1）preHandle()：該方法在業務處理器處理請求之前被呼叫，在該方法中對使用者請求 request 進行處理

（2）postHandle()：該方法在目標方法處理完請求之後執行

（3）afterCompletion()：該方法在完全處理完請求之後被呼叫，可以在該方法中進行一些資源清理的操作

2.自定義攔截器執行流程分析圖

image-20230217223307276

● 自定義攔截器執行流程說明

攔截器中方法的執行順序是 preHandle -> Controller -> postHandle -> afterCompletion，只有preHandle返回true，才會執行後面的方法

  1. 如果 preHandle 方法返回 false, 則不再執行目標方法及之後的攔截方法，可以在該方法指定返回頁面
  2. postHandle 在目標方法被執行後執行，可以在 postHandle 方法中訪問到目標方法返回的 ModelAndView 物件
  3. 若 preHandle 返回 true, 則 afterCompletion 方法在渲染檢視之後被執行
  4. 若 preHandle 返回 false, 則 afterCompletion 方法不會被呼叫
  5. 配置攔截器時可以指定該攔截器對哪些請求生效，哪些請求不生效，如果不指定則預設對所有目標方法生效

3.應用例項

3.1快速入門

完成一個自定義攔截器，學習如何配置攔截器和攔截器的執行流程。

（1）建立攔截器 MyInterceptor01.java

package com.li.web.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author 李
 * @version 1.0
 */
//需要標識為component注入到spring容器中
@Component
public class MyInterceptor01 implements HandlerInterceptor {
    /**
     * 1.preHandle 方法在目標方法執行前被執行
     * 2.如果 preHandle 方法返回了false，則目標方法不再被執行
     * 3.preHandle方法可以獲取到 request，response，handler
     * 4.如果該方法返回了 false，你可以指定跳轉到哪個頁面
     * @param request
     * @param response
     * @param handler 要執行的處理器
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                             Object handler) throws Exception {
        System.out.println("===MyInterceptor01--preHandle()===");
        return true;
    }

    /**
     * 1.在目標方法執行後，會執行 postHandle 方法
     * 2.postHandle 方法可以獲取到目標方法返回的 modelAndView
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response,
                           Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("===MyInterceptor01--postHandle()===");
    }

    /**
     * 1.afterCompletion 方法在檢視渲染後被執行
     * 2.在 afterCompletion 方法中可以進行一些資源清理工作
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("===MyInterceptor01--afterCompletion()===");
    }
}

（2）在 spring 的容器檔案中配置攔截器

<!--配置自定義攔截器-->
<mvc:interceptors>
    <!--
     1.第一種配置方式
     2.直接使用ref引用到對應的 myInterceptor01
     3.這種方式會攔截所有的目標方法
    -->
    <ref bean="myInterceptor01"/>
</mvc:interceptors>

（3）測試 Controller

package com.li.web.interceptor;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author 李
 * @version 1.0
 */
@Controller
public class TestHandler {
    @RequestMapping(value = "/hi")
    public String hi() {
        System.out.println("===TestHandler--hi()===");
        return "success";
    }

    @RequestMapping(value = "/hello")
    public String hello() {
        System.out.println("===TestHandler--hello()===");
        return "success";
    }
}

（4）interceptor.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>測試自定義攔截器</title>
</head>
<body>
<h1>測試自定義攔截器</h1>
<a href="<%=request.getContextPath()%>/hi">測試自定義攔截器-hi</a><br/><br/>
<a href="<%=request.getContextPath()%>/hello">測試自定義攔截器-hello</a>
</body>
</html>

（5）啟動 tomcat，訪問 interceptor.jsp，分別點選兩個超連結

image-20230218191931024

後臺輸出如下：

image-20230218192132327

可以看到方法的執行順序為：preHandler-->目標方法-->postHandle-->afterCompletion，並且攔截器對Controller 所有的方法都進行了攔截。

3.2注意事項和使用細節

  1. 預設配置是對所有的目標方法都進行攔截，也可以指定攔截某個目標方法，如在 spring 容器檔案中配置：

    <!--配置自定義攔截器-->
<mvc:interceptors>
    <!--
    1.第二種配置方式
    2.mvc:mapping path="/hi" 指定要攔截的目標方法的路徑
    3.ref bean="myInterceptor01" 指定對哪個攔截器進行配置
    -->
    <mvc:interceptor>
        <mvc:mapping path="/hi"/>
        <ref bean="myInterceptor01"/>
    </mvc:interceptor>
</mvc:interceptors>

  2. mvc:mapping 支援萬用字元，同時可以指定不對哪些目標方法進行攔截，例如：

    <!--配置自定義攔截器-->
<mvc:interceptors>
    <!--
    1.第三種配置方式
    2.mvc:mapping path="/h*" 表示攔截 /h 開頭的路徑的目標方法
    3.mvc:exclude-mapping path="/hello" 表示不攔截指定路徑的目標方法
    4.ref bean="myInterceptor01" 指定對哪個攔截器進行配置
    -->
    <mvc:interceptor>
        <!--h開頭的目標方法都被攔截-->
        <mvc:mapping path="/h*"/>
        <mvc:exclude-mapping path="/hello"/>
        <ref bean="myInterceptor01"/>
    </mvc:interceptor>
</mvc:interceptors>

  3. 攔截器需要配置才生效，不配置是不生效的

  4. 如果 preHandle() 方法返回了 false，就不會執行目標方法(前提是目標方法指定了攔截)，你可以在該方法中根據業務指定要跳轉的頁面

3.3Debug執行流程

（1）在自定義攔截器 MyInterceptor01 的 preHandle 方法中打上斷點，點選 debug

image-20230218195806518

（2）瀏覽器訪問頁面 interceptor.jsp，點選第一個連結，訪問目標方法 hi()

image-20230218195945629

（3）後臺游標跳轉到斷點處，此時 preHandle 方法已經拿到了目標方法，說明 preHandle 方法在目標方法前執行

image-20230218200230339

（4）在目標方法 hi 中新增斷點，點選 resume，游標跳轉到斷點處

image-20230218200546120

（5）在攔截器的 postHandle 方法中新增斷點，點選 resume，游標如期跳轉到該斷點處。在該方法中可以拿到目標方法對應的 ModelAndView 物件，其中 view 就是指定的要返回的頁面，model 就是目標方法的資料。

image-20230218201350322

（6）ModelAndView 物件在 DispatcherServlet 的 resolveViewName 方法進行解析，返回檢視，檢視在 render 方法中進行檢視渲染

image-20230218202412075

（7）在攔截器的 afterCompletion 方法中打上斷點，點選 resume，游標跳轉到該斷點處

image-20230218202502673

（8）這一個攔截流程就結束了，再次點選 resume，就會向客戶端返回資料

4.多個攔截器

4.1多個攔截器執行流程示意圖

image-20230218211514543

4.2例項演示1-執行流程

4.2.1程式碼實現

（1）在3.1中快速入門中已經建立了一個攔截器，現在建立第二個攔截器 MyInterceptor02.java

package com.li.web.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author 李
 * @version 1.0
 */
@Component
public class MyInterceptor02 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("===MyInterceptor02--preHandle()===");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("===MyInterceptor02--postHandle()===");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("===MyInterceptor02--afterCompletion()===");
    }
}

（2）在 spring 的容器檔案中配置攔截器

<!--配置自定義攔截器-->
<mvc:interceptors>
    <mvc:interceptor>
        <!--h開頭的目標方法都被攔截-->
        <mvc:mapping path="/h*"/>
        <mvc:exclude-mapping path="/hello"/>
        <ref bean="myInterceptor01"/>
    </mvc:interceptor>
    <!--
    第二個攔截器
    多個攔截器在執行時，按照配置的順序執行
    -->
    <mvc:interceptor>
        <mvc:mapping path="/h*"/>
        <ref bean="myInterceptor02"/>
    </mvc:interceptor>
</mvc:interceptors>

（3）interceptor.jsp 不變

（4）完成測試，瀏覽器訪問 jsp 頁面，點選訪問目標方法 hi

image-20230218212616744

（5）後端輸出如下：與分析的流程一致。

image-20230218212755051

（6）如果把第二個攔截器的 preHandle 方法返回值改為 false，重新訪問目標方法測試，後臺輸出如下：

image-20230218213847844

4.2.2注意事項和使用細節

  1. 如果第一個攔截器的 preHandle() 返回 false，後面都不再執行，包括目標方法

  2. 如果第二個攔截器的 preHandle() 返回 false，就直接執行第一個攔截器的 afterCompletion() 方法，如果攔截器更多，規則類似。

  3. 以上兩條規則，都是在目標方法符合被攔截條件的前提下。

4.3例項演示2-跳轉至指定頁面

需求：如果使用者提交的資料有禁用詞（比如：病毒），則在第一個攔截器就返回，不執行目標方法，跳轉至執行頁面

4.3.1程式碼實現

（1）修改 MyInterceptor01.java 的 preHandle 方法

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                         Object handler) throws Exception {
    System.out.println("===MyInterceptor01--preHandle()===");
    //獲取使用者提交的關鍵字
    String keyword = request.getParameter("keyword");
    if ("病毒".equals(keyword)) {
        //請求轉發到指定頁面
        request.getRequestDispatcher("/WEB-INF/pages/warning.jsp")
                .forward(request, response);
        return false;
    }
    System.out.println("keyword=" + keyword);
    return true;
}

（2）warning.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>警告</title>
</head>
<body>
<h1>你的資訊中含有違規詞</h1>
</body>
</html>

（3）在 postman 中進行測試

測試1：無違禁詞

image-20230218215248814

後臺輸出：

image-20230218215317704

測試2：含違禁詞

image-20230218215502131

後臺輸出：

image-20230218215423232

5.練習

  1. 將之前的 SpringMVC 檔案上傳、自定義攔截器相關程式碼和案例過一遍
  2. 簡述 SpringMVC 自定義攔截器工作流程，並畫出示意圖
  3. debug 自定義攔截器原始碼，加深理，梳理流程

相關文章