SpringMV學習之攔截器的簡單使用

一、攔截器介紹

我們知道SpringMVC的攔截器（Interceptor）非常重要，尤其在Web應用中使用非常廣泛，其功能類似于過濾器，用于攔截用戶請求并作相應的處理，我們使用比較多的場景是系統登陸驗證、權限驗證等，

一般實作攔截器有兩種方式：

1. 通過實作HandlerInterceptor介面，或繼承HandlerInterceptor介面的實作類（如HandlerInterceptorAdapter）來定義
2. 通過實作WebRequestInterceptor介面，或繼承WebRequestInterceptor介面的實作類來定義

攔截器與過濾器的區別：攔截器是AOP思想的具體應用

過濾器

• servlet規范中的一部分，任何java web工程都可以使用

• 在url-pattern中配置了/*之后，可以對所有要訪問的資源進行攔截

攔截器

• 攔截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能使用

• 攔截器只會攔截訪問的控制器方法， 如果訪問的是jsp/html/css/image/js是不會進行攔截的

二、攔截器簡單實作

我們這里使用第一種方式：即實作HandlerInterceptor介面來創建連接器

1.創建一個基礎的web工程專案

我這里使用Maven創建，并添加web的框架支持

配置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">

    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:applicationContext.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>


    <filter>
        <filter-name>encoding</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>
    </filter>
    <filter-mapping>
        <filter-name>encoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>

添加Spring的組態檔 applicationContext.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.tioxy.controller"/>
    <!--靜態資源過濾-->
    <mvc:default-servlet-handler/>
    <mvc:annotation-driven/>

    <!--Json處理亂碼資料-->
    <mvc:annotation-driven>
        <mvc:message-converters register-defaults="true">
            <bean >
                <constructor-arg value="https://www.cnblogs.com/tioxy/p/UTF-8"/>
            </bean>
            <bean >
                <property name="objectMapper">
                    <bean >
                        <property name="failOnEmptyBeans" value="https://www.cnblogs.com/tioxy/p/false"/>
                    </bean>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

    <!--視圖決議器-->
    <bean >
        <property name="prefix" value="https://www.cnblogs.com/WEB-INF/jsp/"/>
        <property name="suffix" value="https://www.cnblogs.com/tioxy/p/.jsp"/>
    </bean>
</beans>

2.撰寫一個攔截器的實作類

創建類 com.tioxy.config.MyInterceptor

package com.tioxy.config;

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
    // return true;執行下一個攔截器，放行
    // return false;不執行下一個攔截器
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("攔截前");
        return true;
    }

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

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

說明:
其中 preHandle()方法作用，return true會執行下一個攔截器，可以理解為繼續向下進行，如果回傳false，就會停止，被攔截，類似于過濾器的chain.doFilter()方法，

3.applicationContext.xml配置攔截器

<!--攔截器配置-->
<mvc:interceptors>
    <mvc:interceptor>
        <!--包括這個請求下的所有請求-->
        <mvc:mapping path="/**"/>
        <bean />
    </mvc:interceptor>
</mvc:interceptors>

4.撰寫一個測驗控制器

package com.tioxy.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @GetMapping("/t1")
    public String test(){
        return "ok";
    }
}

5.運行測驗

配置完Tomcat啟動運行，瀏覽器輸入地址：http://localhost:8080/07_interceptor_war_exploded/t1

參考地址：
狂神說Java之攔截器：https://www.bilibili.com/video/BV1aE41167Tu?p=27

標籤：Java

上一篇：Java--Filter（過濾器）

下一篇：如今大火的演算法框架TensorFlow，都有哪些值得一看的好書呢？