Spring MVC攔截器(Interceptor)的定義和配置過程

更新時間：2025年03月25日 09:29:44 作者：庫隱

這篇文章主要介紹了Spring MVC攔截器(Interceptor)的定義和配置過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

1、SpringMVC中組件：攔截器（Interceptor）

攔截器（Interceptor）

對我們來說是非常實用的，也是經常使用的，可以在所有的HandlerMapping的前后進行攔截，當我們需要將特定功能應用于符合某種規(guī)則的請求的時候，這個時候就可以使用攔截器。

我們自定義的攔截器必須繼承org.springframework.web.servlet.HandlerInterceptor，在HandlerInterceptor由三個默認方法

package org.springframework.web.servlet;

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

import org.springframework.lang.Nullable;
import org.springframework.web.method.HandlerMethod;

public interface HandlerInterceptor {
	/**
	* 在執(zhí)行實際儲器程序之前，根據(jù)返回的boolen判斷是否放行
	*/
	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {

		return true;
	}
	/**
	* 執(zhí)行處理程序之后
	*/
	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 {
	}

}

自定義的攔截器

package com.example.web.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 {
        String requestURI = request.getRequestURI();
        System.out.println("請求的路徑：" +requestURI);
        long startTime = System.currentTimeMillis();
        request.setAttribute("request::start",startTime);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        long startTime = (long)request.getAttribute("request::start");
        long processEndTime = System.currentTimeMillis();
        System.out.println("處理程序執(zhí)行完成耗時："+ (processEndTime-startTime) + "毫秒");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        long startTime = (long)request.getAttribute("request::start");
        long endTime = System.currentTimeMillis();
        System.out.println("從請求到完成響應耗時："+ (endTime-startTime) + "毫秒");
    }
}

2、攔截器（Interceptor）的配置

在自定攔截器完成后，就是在Spring MVC 中配置我們的攔截器（Interceptor）了，可以通過Java配置類的方式進行配置，也可以通過xml文件的方式進行配置。

先從Java配置類的方式來看

@EnableWebMvc ：表示啟用Spring MVC的功能
@Configuration：表示該類是Spring 中的配置類
攔截的配置需要重寫WebMvcConfigurer 的addInterceptors(InterceptorRegistry registry) 方法，通過registry進行添加（默認攔截所有）
可以通過addPathPatterns來表示攔截哪些請求
可以通過excludePathPatterns不攔截哪些請求

對于URI匹配模式：

？：匹配一個字符
* ：匹配路徑段中的零個或者多個字符
**：匹配零個或者多個路徑段

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    	registry.addInterceptor(new MyInterceptor())
        registry.addInterceptor(new LocaleChangeInterceptor());
        registry.addInterceptor(new ThemeChangeInterceptor()).addPathPatterns("/**").excludePathPatterns("/admin/**");
        registry.addInterceptor(new SecurityInterceptor()).addPathPatterns("/secure/*");
    }
}

在xml中進行配置

<mvc:interceptors>
	<bean class="com.example.web.interceptor.MyInterceptor"/>
    <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"/>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/admin/**"/>
        <bean class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/secure/*"/>
        <bean class="org.example.SecurityInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

總結

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

SpringBoot中Redis連接超時的解決全過程
在SpringBoot應用中,Redis連接超時異常通常出現(xiàn)在高并發(fā)場景下,因Redis連接數(shù)過多導致,通過檢查連接池配置、使用監(jiān)控工具和分析線程堆棧,可以定位問題,解決方案包括增加連接池大小和優(yōu)化業(yè)務邏輯,通過壓力測試和灰度發(fā)布驗證調整效果,確保系統(tǒng)穩(wěn)定性
2025-11-11
Springboot注入成員變量HttpServletRequest的原理分析
這篇文章主要介紹了Springboot注入成員變量HttpServletRequest的原理分析,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
2024-05-05
idea修改maven模塊名稱還顯示老名稱問題解決
本文主要介紹了idea修改maven模塊名稱還顯示老名稱問題解決,文中通過圖文介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
2023-11-11
springboot 打包部署共享依賴包（分布式開發(fā)集中式部署微服務）
這篇文章主要介紹了springboot 打包部署共享依賴包（分布式開發(fā)集中式部署微服務）的相關資料，非常不錯，具有參考借鑒價值，需要的的朋友參考下吧
2017-06-06
java 線程公平鎖與非公平鎖詳解及實例代碼
這篇文章主要介紹了java 線程公平鎖與非公平鎖詳解及實例代碼的相關資料,需要的朋友可以參考下
2017-02-02
Java利用opencv實現(xiàn)用字符展示視頻或圖片的方法
這篇文章主要介紹了Java利用opencv實現(xiàn)用字符展示視頻或圖片的方法,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2020-12-12
SpringBoot實現(xiàn)整合微信支付方法詳解
這篇文章主要介紹了SpringBoot實現(xiàn)整合微信支付的過程詳解，文中的示例代碼對我們的工作或學習有一定的幫助，感興趣的小伙伴可以跟隨小編學習一下
2021-12-12
gateway基本配置教程
路由(Route)由一個ID，一個目標URI(最終路由到的url地址)，一組斷言(匹配條件判斷)和一組過濾器定義，這篇文章主要介紹了gateway基本配置,需要的朋友可以參考下
2023-05-05
JPA多數(shù)據(jù)源分布式事務處理方案
這篇文章主要為大家介紹了JPA多數(shù)據(jù)源分布式事務處理的兩種事務方案，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
2022-02-02
Java中的三種標準注解和四種元注解說明
這篇文章主要介紹了Java中的三種標準注解和四種元注解說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2022-02-02