SpringMVC攔截器最詳細學習筆記

文章目錄

• 八、SpringMVC攔截器
• • 8.1 什麼是攔截器
  • 8.2 攔截器的配置
  • • 8.2.1 配置攔截器攔截所有的控制器方法
    • 8.2.2 配置攔截器攔截指定的控制器方法
  • 8.3 多個攔截器的執行順序

八、SpringMVC攔截器

8.1 什麼是攔截器

SpringMVC中的攔截器主要用于攔截控制器方法的執行。要想寫一個自己定義的攔截器，我們需要實作HandlerInterceptor接口（推薦）或者繼承HandlerInterceptorAdapter類。

一個浏覽器的請求發送到伺服器曆經的流程如下：

直接扒源碼看吧：

首先我們打開DispatcherServlet類，往下拉，拉到533行（導入的包版本不同，對應的行數可能不同），可以看到：

再往下拉，我們可以看到：

8.2 攔截器的配置

首先，我們建立一個Moodle，然後配置我們的pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>mvcDemo3</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <packaging>war</packaging>

    <dependencies>
        <!--SpringMVC-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.9</version>
        </dependency>

        <!--ServletAPI-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>

        <!--Spring5和Thymeleaf整合包-->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
    </dependencies>

</project>
           

然後配置我們的web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--配置編碼過濾器，解決中文亂碼問題-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--配置SpringMVC的前端控制器，對浏覽器發送的請求進行統一處理-->
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--配置SpringMVC配置檔案的位置和名稱-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--将前端控制器DispatcherServlet的初始化時間提前到伺服器啟動時-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <!--
            使用/可以攔截 /login、 .html、 .js 、.css方式的請求
            但是不能攔截 .jsp的請求，如果要把.jsp檔案也攔下來，那麼就得用/*
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>
           

再配置我們的springMVC.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--掃描元件-->
    <context:component-scan base-package="com.example"/>

    <!--配置Thymeleaf視圖解析器(針對h5檔案，抄就完了)-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--視圖字首-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--視圖字尾-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

    <!--
        處理靜态資源，如html、js、css、jpg
        若隻設定該标簽，則隻通路靜态資源，其他請求無法通路
        此時必須設定<mvc:annotation-driven/>解決問題
    -->
    <mvc:default-servlet-handler/>

    <!--開啟mvc注解驅動-->
    <mvc:annotation-driven>
        <mvc:message-converters>
            <!--處理響應中文亂碼問題-->
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/html</value>
                        <value>application/json</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
</beans>
           

8.2.1 配置攔截器攔截所有的控制器方法

首先寫一個簡單的index.html和一個控制器執行成功後跳轉的success.html頁面如下：

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
    <h1>首頁</h1>
    <a th:href="@{/testInterceptor}">測試攔截器</a><br>
</body>
</html>
           

success.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>成功</title>
</head>
<body>
    <h1>跳轉成功</h1>
</body>
</html>
           

然後我們寫我們的控制器類

InterceptorController.java

package com.example.controller;

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

@Controller
public class InterceptorController {

    @RequestMapping("/")
    public String toIndex(){
        return "index";
    }

    @RequestMapping("/testInterceptor")
    public ModelAndView testInterceptor(ModelAndView modelAndView){
        System.out.println("Controller方法被執行");
        modelAndView.setViewName("success");
        return modelAndView;
    }
}
           

再寫我們的攔截器方法：

MyInterceptor.java

package com.example.interceptor;

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

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

public class MyInterceptor implements HandlerInterceptor {
    /*控制器方法執行前執行*/
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor ----> preHandle");
        /*
            傳回true表示放行
            傳回false表示攔截，會阻止控制器方法的執行
        */
        return true;
    }

    /*控制器方法執行後執行*/
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor ----> postHandle");
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    /*視圖渲染後執行*/
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor ----> afterCompletion");
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}
           

最後在springMVC.xml中配置我們的攔截器，隻設定bean，則該攔截器會攔截所有的控制器方法。

<!--配置攔截器-->
    <mvc:interceptors>
        <bean id="myInterceptor" class="com.example.interceptor.MyInterceptor"></bean>
    </mvc:interceptors>
           

啟動伺服器：

我們可以看到首頁啟動，且背景輸出：（這裡首頁沒輸出控制器方法被執行是因為我沒有讓他輸出。toIndex這個控制器方法，我就單純傳回了index，并沒有讓他刻意輸出什麼東西）

點選我們的超連結，浏覽器和背景分别顯示：

在springMVC中除了用bean标簽設定我們自定義的攔截器的類，我們還可以用ref标簽設定。用法如下：

首先，在我們的攔截器類上添加注解@Component

然後，在springMVC配置檔案中，修改我們的攔截器配置如下：

<!--配置攔截器-->
    <mvc:interceptors>
    	<!--<bean id="myInterceptor" class="com.example.interceptor.MyInterceptor"></bean>-->
        <ref bean="myInterceptor"></ref>
    </mvc:interceptors>
           

效果跟前面一毛一樣，這裡就不再掩飾了。

8.2.2 配置攔截器攔截指定的控制器方法

隻需要在springMVC配置檔案中用mvc:interceptor标簽配置即可。

然後内嵌使用

标簽	作用
mvc:mapping	攔截該屬性中配置的控制器方法
mvc:exclude-mapping	不攔截該屬性中配置的控制器方法
ref	配置我們的攔截器所對應的bean

具體配置方式如下：

<!--配置攔截器-->
    <mvc:interceptors>
<!--        <ref bean="myInterceptor"></ref>-->
<!--        <bean id="myInterceptor" class="com.example.interceptor.MyInterceptor"></bean>-->
        <mvc:interceptor>
            <!--攔截所有隻有一層目錄的控制器方法-->
            <mvc:mapping path="/*"/>
            <!--不攔截/ 也就是首頁index-->
            <mvc:exclude-mapping path="/"/>
            <!--配置我們的攔截器-->
            <ref bean="myInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
           

配置完成後，我們重新開機伺服器。

啟動我們的首頁，不再攔截。

然後我們點選超連結進去，成功攔截：

這裡特别需要注意的是，下面這個标簽設定的是攔截所有隻有一層目錄的控制器方法

<mvc:mapping path="/*"/>

也就是說現在如果這個控制器方法的路徑是

工程路徑/testInterceptor

的話，那麼會被攔截。但是如果是 工程路徑/hello/testInterceptor 的話，那麼就不會被攔截。舉個例子吧，有說服力一點。

先修改我們的控制器方法如下：（/**的含義是任意多層目錄，隻要最後是/testInterceptor就行。）

@RequestMapping("/**/testInterceptor")
    public ModelAndView testInterceptor(ModelAndView modelAndView){
        System.out.println("Controller方法被執行");
        modelAndView.setViewName("success");
        return modelAndView;
    }
           

然後我們重新開機伺服器：

通路http://localhost:8080/interceptor/testInterceptor，

背景顯示如下：

再次通路http://localhost:8080/interceptor/hello/testInterceptor

背景顯示如下：

如果我們要用這種mvc:interceptors标簽配置攔截器的方式攔截所有的控制器方法怎麼辦呢？很簡單，隻要把 mvc:mapping 标簽的 path屬性 中的/*改成/**就好了，如下：

<mvc:interceptor>
            <!--攔截所有的控制器方法-->
            <mvc:mapping path="/**"/>
            <!--不攔截/ 也就是首頁index-->
            <mvc:exclude-mapping path="/"/>
            <!--配置我們的攔截器-->
            <ref bean="myInterceptor"/>
        </mvc:interceptor>
           

8.3 多個攔截器的執行順序

假如我們現在再建一個SecondInterceptor類，讓他也實作HandlerInterceptor接口，然後把springMVC配置檔案的内容改為：

<mvc:interceptors>
        <ref bean="myInterceptor"/>
        <ref bean="secondInterceptor"/>
    </mvc:interceptors>
           

他的執行順序的話，我們就直接扒源碼看吧：

情況一、首先，針對我們所有攔截器都放行的情況，也就是pre都傳回true。

之前說過我們的攔截器的底層執行方法被放在DispatcherServlet類中。那我們就去裡面看看：

preHandle的如下：（這個跟for語句看着熟悉吧，就是一個簡單的遞增周遊的過程）

其實就是哪個攔截器先配置的，就先執行哪個。上面的例子就是先執行myInterceptor的pre方法，然後再執行secondInterceptor的pre方法。

然後執行控制器方法，這個就不用講了吧。

然後post是遞減的一個周遊，也就是先執行second攔截器、再執行myInterceptor攔截器。

再看我們的after如下：同樣是一個遞減的周遊，是以也是先執行second攔截器，再執行myInterceptor攔截器。

總結一下：攔截器的執行順序

1、pre是先配置，先執行（從第一個開始）

2、post和after是後配置，先執行（從最後一個開始）

情況二、如果中間有某個攔截器的pre傳回false

假如現在我們的second攔截器的pre方法傳回的是false，那麼我們會執行什麼呢，直接說結果吧。

首先，我們的pre肯定都會執行，然後我們的控制器方法肯定不會執行，因為他遇到pre是false的情況，他就return出來了。但是攔截器的其他的post和after方法呢？先說結果吧，答案是所有pre傳回true的攔截器，他的after是會執行的。來，我們看源碼：

首先，我們知道這個攔截器的pre方法的執行順序是遞增的，是以這個this.interceptorIndex也一直在遞增，一直遞增到某個攔截器傳回的是false，這個值就停下來了。然後我們會直接跳轉到triggerAfterCompletion方法中。我們直接進去看。

剛才的this.interceptorIndex在這裡就派上用場了，我們知道after 他是遞減的一個周遊過程，遞減後，他會等于最後一個true的攔截器的索引值，然後從那個攔截器開始一個一個的執行他對應的afterCompletion。

總結：如果多個攔截器中有某個攔截器的preHandler傳回false，那麼

1、在他後邊執行的攔截器的preHandle都不執行。

2、控制器方法和所有攔截器的post方法不執行

3、傳回false的攔截器之前的攔截器的after方法都會執行

下面貼個結果，加深一下了解，我寫了My、Second和Third三個攔截器，并都在配置檔案中完成了注冊，其中Second的pre方法傳回false。最終的執行結果如下：