SpringBoot項(xiàng)目Web攔截器使用的多種方式
在Spring Boot應(yīng)用中，Web攔截器（Interceptor）是一種用于在請求處理的不同階段執(zhí)行自定義邏輯的機(jī)制。攔截器廣泛應(yīng)用于各種場景，以增強(qiáng)應(yīng)用的功能性、安全性和可維護(hù)性。
在Spring Boot項(xiàng)目中實(shí)現(xiàn)Wen攔截器主要有以下幾種方式
- 實(shí)現(xiàn)
HandlerInterceptor接口 - 使用過濾器（
Filter） - 使用
@Aspect注解實(shí)現(xiàn)AOP攔截
這里主要介紹 HandlerInterceptor 接口 和 Filter
一、實(shí)現(xiàn) HandlerInterceptor 接口
這是最常見和直接的方式。需要?jiǎng)?chuàng)建一個(gè)類實(shí)現(xiàn) org.springframework.web.servlet.HandlerInterceptor 接口，并重寫其中的方法：
1、創(chuàng)建HandlerInterceptor實(shí)現(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、注冊攔截器
實(shí)現(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、運(yùn)行測試
MyInterceptor : preHandle MyInterceptor : postHandle MyInterceptor : afterCompletion
二、使用過濾器（Filter）
雖然過濾器不屬于攔截器的范疇，但在Spring Boot中，過濾器也是常用的請求處理組件?？梢酝ㄟ^實(shí)現(xiàn) javax.servlet.Filter 接口來創(chuàng)建自定義過濾器：
1、創(chuàng)建過濾器實(shí)現(xiàn)類
這里我創(chuàng)建了3個(gè)測試過濾器，分別是 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會(huì)自動(dòng)檢測并注冊它。
import org.springframework.stereotype.Component;
@Component
public class MyFilter implements Filter {
// 實(shí)現(xiàn)方法同上
}注意：默認(rèn)情況下，使用@Component注冊的過濾器會(huì)被添加到過濾鏈中，但順序可能不確定。如果需要指定順序，建議使用其他注冊方式。
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)先級(jí)越高
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;
}
}運(yùn)行測試
通過日志可以看見，order值越小優(yōu)先級(jí)越高，過濾器的執(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 框架提供的一個(gè)非常有用的過濾器基類，旨在確保某個(gè)過濾器在每個(gè) HTTP 請求中只執(zhí)行一次。這在需要確保某些處理邏輯（如身份驗(yàn)證、日志記錄、請求修改等）在整個(gè)請求生命周期中不被重復(fù)執(zhí)行時(shí)特別有用。
它的主要功能是確保其 doFilterInternal 方法在每個(gè)請求中僅被調(diào)用一次。這是通過檢查請求屬性來實(shí)現(xiàn)的，防止在某些情況下（如轉(zhuǎn)發(fā)請求）過濾器被多次執(zhí)行。
1. 主要方法
doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)：這是需要子類實(shí)現(xiàn)的方法，在其中編寫自定義的過濾邏輯。該方法保證在每個(gè)請求中只被調(diào)用一次。shouldNotFilter(HttpServletRequest request)：可以重寫此方法來指定某些請求不需要被過濾。doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)：這是 Filter 接口的方法，OncePerRequestFilter 已經(jīng)實(shí)現(xiàn)了該方法，確保 doFilterInternal 只執(zhí)行一次。
2. 使用 OncePerRequestFilter
2.1 創(chuàng)建自定義過濾器
要使用 OncePerRequestFilter，通常需要?jiǎng)?chuàng)建一個(gè)繼承自它的子類，并實(shí)現(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)換為對(duì)應(yīng)的 HTTP 方法（如 PUT、DELETE）。這在 HTML 表單不支持某些 HTTP 方法時(shí)非常有用。
使用場景：在使用 RESTful API 且前端僅支持 POST 請求時(shí)，通過隱藏字段指定實(shí)際的 HTTP 方法。
啟用方式：
在 Spring Boot 中，默認(rèn)情況下，HiddenHttpMethodFilter 是啟用的。如果需要自定義，可以手動(dòng)注冊：
@Bean
public HiddenHttpMethodFilter hiddenHttpMethodFilter() {
return new HiddenHttpMethodFilter();
}3、CorsFilter
簡介：CorsFilter 用于處理跨域資源共享（CORS）配置，允許或限制來自不同源的請求。
使用場景：在構(gòu)建需要與前端分離的應(yīng)用，且前端和后端部署在不同域時(shí)。
示例配置：
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項(xiàng)目Web攔截器使用的文章就介紹到這了,更多相關(guān)SpringBoot Web攔截器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了java比較器comparator使用示例,需要的朋友可以參考下2014-03-03
堆排序是利用堆這種數(shù)據(jù)結(jié)構(gòu)而設(shè)計(jì)的一種排序算法，堆排序是一種選擇排序，它的最壞，最好，平均時(shí)間復(fù)雜度均為O(nlogn)，它也是不穩(wěn)定排序。首先簡單了解下堆結(jié)構(gòu)2022-01-01
這篇文章主要介紹了java 中file.encoding的設(shè)置詳解的相關(guān)資料,需要的朋友可以參考下2017-04-04
SpringBoot實(shí)現(xiàn)監(jiān)控Actuator,關(guān)閉redis監(jiān)測
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)監(jiān)控Actuator,關(guān)閉redis監(jiān)測，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11
SpringBoot使用Prometheus采集自定義指標(biāo)數(shù)據(jù)的方法詳解
隨著微服務(wù)在生產(chǎn)環(huán)境大規(guī)模部署和應(yīng)用,隨之而來也帶來了新的問題,其中比較關(guān)鍵的就是關(guān)于微服務(wù)的運(yùn)維和監(jiān)控,本文將結(jié)合微服務(wù)運(yùn)維監(jiān)控中的指標(biāo)監(jiān)控進(jìn)行詳細(xì)的說明,需要的朋友可以參考下2024-07-07
java報(bào)錯(cuò):找不到或無法加載主類的解決方法簡單粗暴
本文主要介紹了java報(bào)錯(cuò):找不到或無法加載主類的解決方法簡單粗暴，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-01-01
這篇文章主要介紹了Java中的什么場景使用遞歸,如何使用遞歸的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09
java面向?qū)ο笤O(shè)計(jì)原則之合成復(fù)用原則示例詳解
這篇文章主要介紹了java面向?qū)ο笤O(shè)計(jì)原則之合成復(fù)用原則的示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2021-10-10
Java實(shí)現(xiàn)線程插隊(duì)的示例代碼
在編寫多線程的業(yè)務(wù)時(shí)，會(huì)遇到讓一個(gè)線程優(yōu)先于其他線程運(yùn)行的情況，除了可以設(shè)置線程的優(yōu)先級(jí)高于其他線程，還有更直接的方式：線程插隊(duì)。本文將用Java實(shí)現(xiàn)線程插隊(duì)，需要的可以參考一下2022-08-08
Spring?boot配置綁定和配置屬性校驗(yàn)的方式詳解
這篇文章主要介紹了Spring?boot配置綁定和配置屬性校驗(yàn),SpringBoot 提供了2 種方式進(jìn)行配置綁定，即使用 @ConfigurationProperties 注解和使用 @Value 注解，需要的朋友可以參考下2022-05-05