SpringBoot項目Web攔截器使用的多種方式
在Spring Boot應(yīng)用中，Web攔截器（Interceptor）是一種用于在請求處理的不同階段執(zhí)行自定義邏輯的機(jī)制。攔截器廣泛應(yīng)用于各種場景，以增強(qiáng)應(yīng)用的功能性、安全性和可維護(hù)性。
在Spring Boot項目中實現(xiàn)Wen攔截器主要有以下幾種方式
- 實現(xiàn)
HandlerInterceptor接口 - 使用過濾器（
Filter） - 使用
@Aspect注解實現(xiàn)AOP攔截
這里主要介紹 HandlerInterceptor 接口 和 Filter
一、實現(xiàn) HandlerInterceptor 接口
這是最常見和直接的方式。需要創(chuàng)建一個類實現(xiàn) org.springframework.web.servlet.HandlerInterceptor 接口，并重寫其中的方法：
1、創(chuàng)建HandlerInterceptor實現(xiàn)類 MyInterceptor
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
@Slf4j
@Component
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.info("preHandle");
return HandlerInterceptor.super.preHandle(request, response, handler);
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.info("postHandle");
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
log.info("afterCompletion");
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}2、注冊攔截器
實現(xiàn)完攔截器后，需要將其注冊到Spring MVC的配置中?？梢酝ㄟ^繼承 WebMvcConfigurer 接口并重寫 addInterceptors 方法來完成：
import jakarta.annotation.Resource;
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 WebConfig implements WebMvcConfigurer {
@Resource
private MyInterceptor myInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(myInterceptor)
.addPathPatterns("/**")//攔截所有請求
.excludePathPatterns("/login");// 放行登錄請求
}
}這里的myInterceptor 也可以直接
new MyInterceptor()
3、運行測試
MyInterceptor : preHandle MyInterceptor : postHandle MyInterceptor : afterCompletion
二、使用過濾器（Filter）
雖然過濾器不屬于攔截器的范疇，但在Spring Boot中，過濾器也是常用的請求處理組件。可以通過實現(xiàn) javax.servlet.Filter 接口來創(chuàng)建自定義過濾器：
1、創(chuàng)建過濾器實現(xiàn)類
這里我創(chuàng)建了3個測試過濾器，分別是 MyFilter、MyFilter2、MyFilter2，代碼都是相同的，只是打印內(nèi)容不一樣
@Slf4j
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
// 請求前處理
log.info("MyFilter doFilter pre");
filterChain.doFilter(servletRequest, servletResponse);
// 響應(yīng)后處理
log.info("MyFilter doFilter after");
}
}2、使用@Component 注解配置過濾器
通過將過濾器類聲明為Spring組件，Spring Boot會自動檢測并注冊它。
import org.springframework.stereotype.Component;
@Component
public class MyFilter implements Filter {
// 實現(xiàn)方法同上
}注意：默認(rèn)情況下，使用@Component注冊的過濾器會被添加到過濾鏈中，但順序可能不確定。如果需要指定順序，建議使用其他注冊方式。
3、通過配置類注冊過濾器（FilterRegistrationBean）
通過FilterRegistrationBean可以更靈活地注冊過濾器，包括設(shè)置過濾器的順序、URL模式等。
- 可以精確控制過濾器的順序。
- 可以指定過濾器應(yīng)用的URL模式。
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean<MyFilter> myFilter() {
FilterRegistrationBean<MyFilter> bean = new FilterRegistrationBean<>();
bean.setFilter(new MyFilter());
bean.addUrlPatterns("/*"); // 攔截所有請求
bean.setOrder(1); // 設(shè)置過濾器順序，數(shù)值越小優(yōu)先級越高
return bean;
}
@Bean
public FilterRegistrationBean<MyFilter2> myFilter2() {
FilterRegistrationBean<MyFilter2> bean = new FilterRegistrationBean<>();
bean.setFilter(new MyFilter2());
bean.addUrlPatterns("/*");
bean.setOrder(2);
return bean;
}
@Bean
public FilterRegistrationBean<MyFilter3> MyFilter3() {
FilterRegistrationBean<MyFilter3> bean = new FilterRegistrationBean<>();
bean.setFilter(new MyFilter3());
bean.addUrlPatterns("/*");
bean.setOrder(3);
return bean;
}
}運行測試
通過日志可以看見，order值越小優(yōu)先級越高，過濾器的執(zhí)行遵循先進(jìn)后出的原則
c.hj.springboot3.filter.demo2.MyFilter : MyFilter doFilter pre
c.hj.springboot3.filter.demo2.MyFilter2 : MyFilter2 doFilter pre
c.hj.springboot3.filter.demo2.MyFilter3 : MyFilter3 doFilter pre
c.h.s.filter.service.UserServiceImpl : 執(zhí)行業(yè)務(wù)代碼
c.hj.springboot3.filter.demo2.MyFilter3 : MyFilter3 doFilter after
c.hj.springboot3.filter.demo2.MyFilter2 : MyFilter2 doFilter after
c.hj.springboot3.filter.demo2.MyFilter : MyFilter doFilter after
三、使用OncePerRequestFilter
OncePerRequestFilter 是 Spring 框架提供的一個非常有用的過濾器基類，旨在確保某個過濾器在每個 HTTP 請求中只執(zhí)行一次。這在需要確保某些處理邏輯（如身份驗證、日志記錄、請求修改等）在整個請求生命周期中不被重復(fù)執(zhí)行時特別有用。
它的主要功能是確保其 doFilterInternal 方法在每個請求中僅被調(diào)用一次。這是通過檢查請求屬性來實現(xiàn)的，防止在某些情況下（如轉(zhuǎn)發(fā)請求）過濾器被多次執(zhí)行。
1. 主要方法
doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)：這是需要子類實現(xiàn)的方法，在其中編寫自定義的過濾邏輯。該方法保證在每個請求中只被調(diào)用一次。shouldNotFilter(HttpServletRequest request)：可以重寫此方法來指定某些請求不需要被過濾。doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)：這是 Filter 接口的方法，OncePerRequestFilter 已經(jīng)實現(xiàn)了該方法，確保 doFilterInternal 只執(zhí)行一次。
2. 使用 OncePerRequestFilter
2.1 創(chuàng)建自定義過濾器
要使用 OncePerRequestFilter，通常需要創(chuàng)建一個繼承自它的子類，并實現(xiàn) doFilterInternal 方法。
示例代碼：
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
public class CustomOncePerRequestFilter extends OncePerRequestFilter {
@Override
protected void doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
throws ServletException, IOException {
// 請求預(yù)處理邏輯
System.out.println("CustomOncePerRequestFilter: 請求前處理");
// 繼續(xù)過濾器鏈
filterChain.doFilter(request, response);
// 響應(yīng)后處理邏輯
System.out.println("CustomOncePerRequestFilter: 響應(yīng)后處理");
}
}2.2 注冊自定義過濾器
創(chuàng)建完自定義過濾器后，需要將其注冊到 Spring Boot 應(yīng)用中?？梢允褂?FilterRegistrationBean 進(jìn)行注冊。
示例代碼：
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean<CustomOncePerRequestFilter> customFilterRegistration() {
FilterRegistrationBean<CustomOncePerRequestFilter> registration = new FilterRegistrationBean<>();
registration.setFilter(new CustomOncePerRequestFilter());
registration.addUrlPatterns("/*"); // 攔截所有請求
registration.setName("customOncePerRequestFilter");
registration.setOrder(1); // 設(shè)置過濾器順序
return registration;
}
}四、其他類似過濾器
1、CharacterEncodingFilter
簡介：CharacterEncodingFilter 用于設(shè)置請求和響應(yīng)的字符編碼，確保請求參數(shù)和響應(yīng)內(nèi)容的編碼一致，防止亂碼問題。
使用場景：在處理國際化應(yīng)用或需要特定字符編碼的場景下非常有用。
示例配置：
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.CharacterEncodingFilter;
@Configuration
public class EncodingFilterConfig {
@Bean
public FilterRegistrationBean<CharacterEncodingFilter> characterEncodingFilter() {
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("UTF-8");
filter.setForceEncoding(true);
FilterRegistrationBean<CharacterEncodingFilter> registration = new FilterRegistrationBean<>(filter);
registration.addUrlPatterns("/*");
registration.setName("characterEncodingFilter");
registration.setOrder(1);
return registration;
}
}2、HiddenHttpMethodFilter
簡介：HiddenHttpMethodFilter 用于將帶有特殊參數(shù)（如 _method）的 POST 請求轉(zhuǎn)換為對應(yīng)的 HTTP 方法（如 PUT、DELETE）。這在 HTML 表單不支持某些 HTTP 方法時非常有用。
使用場景：在使用 RESTful API 且前端僅支持 POST 請求時，通過隱藏字段指定實際的 HTTP 方法。
啟用方式：
在 Spring Boot 中，默認(rèn)情況下，HiddenHttpMethodFilter 是啟用的。如果需要自定義，可以手動注冊：
@Bean
public HiddenHttpMethodFilter hiddenHttpMethodFilter() {
return new HiddenHttpMethodFilter();
}3、CorsFilter
簡介：CorsFilter 用于處理跨域資源共享（CORS）配置，允許或限制來自不同源的請求。
使用場景：在構(gòu)建需要與前端分離的應(yīng)用，且前端和后端部署在不同域時。
示例配置：
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
@Configuration
public class CorsConfig {
@Bean
public CorsFilter corsFilter() {
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
CorsConfiguration config = new CorsConfiguration();
config.setAllowCredentials(true);
config.addAllowedOrigin("http://example.com");
config.addAllowedHeader("*");
config.addAllowedMethod("*");
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}
}到此這篇關(guān)于SpringBoot項目Web攔截器使用的文章就介紹到這了,更多相關(guān)SpringBoot Web攔截器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
MyBatis中?@Mapper?和?@MapperScan?的區(qū)別與使用解析
本文介紹了SpringBoot中MyBatis的兩個常用注解：@Mapper和@MapperScan,@Mapper用于標(biāo)記單個Mapper接口,而@MapperScan用于批量掃描指定包下的所有Mapper接口,兩者都有各自適用的場景,選擇合適的注解可以提高開發(fā)效率并使代碼更加簡潔,感興趣的朋友一起看看吧2025-01-01
當(dāng)系統(tǒng)所提供的工廠所需生產(chǎn)的具體產(chǎn)品并不是一個簡單的對象，而是多個位于不同產(chǎn)品等級結(jié)構(gòu)中屬于不同類型的具體產(chǎn)品時需要使用抽象工廠模式，抽象工廠模式是所有形式的工廠模式中最為抽象和最具一般性的一種形態(tài)2022-08-08
今天給大家?guī)淼氖顷P(guān)于Java基礎(chǔ)的相關(guān)知識,文章圍繞著Collector接口的組成展開,文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下2021-06-06
在本篇文章中小編給大家分享了關(guān)于SpringBoot項目如何集成依賴Mybatis的相關(guān)知識點內(nèi)容，有興趣的朋友們學(xué)習(xí)下。2019-06-06
基于Spring Security的Oauth2授權(quán)實現(xiàn)方法
這篇文章主要介紹了基于Spring Security的Oauth2授權(quán)實現(xiàn)方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-09-09
Java猜數(shù)字游戲從思路到實現(xiàn)開發(fā)全過程
猜數(shù)字游戲雖然簡單,卻涵蓋了程序設(shè)計的基本要素,數(shù)據(jù)處理、流程控制、用戶交互和異常處理,這篇文章主要介紹了Java猜數(shù)字游戲從思路到實現(xiàn)開發(fā)的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2025-10-10
這篇文章主要介紹了Spring中的@Scope注解詳細(xì)講解及示例,@Scope注解是 Spring IOC 容器中的一個作用域,在 Spring IOC 容器中,他用來配置Bean實例的作用域?qū)ο?需要的朋友可以參考下2023-11-11
這篇文章主要介紹了Java中的split使用方法詳解,Java 中 String 的 split 方法可以將字符串根據(jù)指定的間隔進(jìn)行切割,經(jīng)過切割后得到的返回值是一個字符串?dāng)?shù)組,需要的朋友可以參考下2023-10-10
一文搞懂MyBatis多數(shù)據(jù)源Starter實現(xiàn)
本文將實現(xiàn)一個MyBatis的Springboot的Starter包，引用這個Starter包后，僅需要提供少量配置信息，就能夠完成MyBatis多數(shù)據(jù)源的初始化和使用，需要的小伙伴可以參考一下2023-04-04
IDEA+maven+SpringBoot+JPA+Thymeleaf實現(xiàn)Crud及分頁
這篇文章主要介紹了不需要電腦任何操作基于IDEA + maven + SpringBoot + JPA + Thymeleaf實現(xiàn)CRUD及分頁,需要的朋友可以參考下2018-03-03