SpringBoot學習（過濾器Filter。攔截器Interceptor。全局異常捕獲處理器GlobalExceptionHandler）(詳細使用教程)

目錄

一、過濾器Filter。

1.1定義與規范。

1.2工作原理與范圍。

1.3使用場景。

1.4 SpringBoot實現過濾器。（Filter配置2種方式）

<1>注解配置(@WebFilter、@Order、@ServletComponentScan)。

創建過濾器類。

啟用 Servlet 組件掃描。

<2>配置類注冊過濾器(FilterRegistrationBean對象配置)。

創建過濾器類。(無須使用第1種方式的注解)

配置過濾器。

二、攔截器Interceptor。

2.1定義與框架。

2.2工作原理與范圍。

2.3使用場景。

2.4 SpringBoot實現攔截器。

<1>創建攔截器類（實現 HandlerInterceptor 接口）。

日志記錄。(SLF4J、Logback)

多線程處理。(ThreadLocal)

<2>創建攔截器配置類（實現 WebMvcConfigurer 接口）。

三、全局異常捕獲處理器GlobalExceptionHandler。

3.1?全局異常捕獲處理器定義與實現方法。

3.2 SpringBoot實現全局異常捕獲處理器。

<1>自定義響應結果封裝類。(Result類)

<2>自定義全局異常捕獲處理類。(GlobalExceptionHandler類)

<3>模擬產生異常的XxxController類。

一、過濾器Filter。

1.1定義與規范。

Filter 是 Servlet 技術中的重要組件，遵循 Java Servlet 規范。
由 Servlet 容器（如 Tomcat）管理其生命周期。包括init（初始化）、doFilter（執行過濾操作）和destroy（銷毀）方法。
過濾器生命周期由 Servlet 容器管理。

1.2工作原理與范圍。

過濾器的核心：攔截客戶端請求和服務器響應。（請求的預處理、響應的后處理）
它可以對 Web 服務器管理的所有 Web 資源（如 JSP、Servlet、靜態圖片、靜態 HTML 文件等）進行攔截。
在請求到達 Servlet 之前或響應離開 Servlet 之后，對請求和響應進行預處理和后處理。

1.3使用場景。

常用于實現 URL 級別的權限訪問控制、過濾敏感詞匯、壓縮響應信息、設置字符編碼、記錄請求日志等通用功能。
如：在電商網站中，可過濾用戶輸入中的敏感詞，防止非法內容提交。或在應用入口處，對所有請求進行日志記錄，便于追蹤和排查問題。

1.4 SpringBoot實現過濾器。（Filter配置2種方式）

<1>注解配置(@WebFilter、@Order、@ServletComponentScan)。

創建過濾器類。
創建一個過濾器類(XxxFilter)實現 jakarta.servlet.Filter接口?，并重寫init()、doFilter()、destroy()方法。
指定過濾器順序（補充）。若存在多個過濾器且執行順序重要，可使用@Order注解指定順序。數字越小優先級越高。如@Order(1) 。

package com.hyl.filter;import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;import java.io.IOException;@WebFilter(urlPatterns = "/*", filterName = "logFilter")
public class LogFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("LogFilter init,,,");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("LogFilter doFilter,,,");long timeNow = System.currentTimeMillis();filterChain.doFilter(servletRequest,servletResponse);System.out.println("LogFilter doFilter,,,"+"耗時："+(System.currentTimeMillis()-timeNow));}@Overridepublic void destroy() {System.out.println("LogFilter destroy,,,");}
}

啟用 Servlet 組件掃描。
在 Spring Boot 主類上添加 @ServletComponentScan 注解，掃描過濾器類(XxxFilter)。

package com.hyl;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;@SpringBootApplication
@ServletComponentScan("com.hyl.filter")
public class SpringbootApplication {public static void main(String[] args) {SpringApplication.run(SpringbootApplication.class, args);}}

發起請求。查看過濾器執行結果。

<2>配置類注冊過濾器(FilterRegistrationBean對象配置)。

創建過濾器類。(無須使用第1種方式的注解)

package com.hyl.filter;import jakarta.servlet.*;
import java.io.IOException;public class LogFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("LogFilter init,,,");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("LogFilter doFilter,,,");long timeNow = System.currentTimeMillis();filterChain.doFilter(servletRequest,servletResponse);System.out.println("LogFilter doFilter,,,"+"耗時："+(System.currentTimeMillis()-timeNow));}@Overridepublic void destroy() {System.out.println("LogFilter destroy,,,");}
}

配置過濾器。
創建配置類，通過 FilterRegistrationBean 注冊過濾器。其中可設置過濾的 URL 路徑、過濾器名稱、執行順序等。

package com.hyl.config;import com.hyl.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** 過濾器配置類：用于注冊和配置自定義過濾器*/
@Configuration
public class FilterConfig {@Bean  // 聲明將此方法的返回值作為Spring容器中的Bean管理public FilterRegistrationBean<LogFilter> logFilterRegistration(){FilterRegistrationBean<LogFilter> registration  = new FilterRegistrationBean<>();  // 創建過濾器注冊Bean實例（用于配置過濾器的屬性registration.setFilter(new LogFilter());  // 設置要注冊的過濾器實例registration.setBeanName("logFilter");  // 設置過濾器在Spring容器中的Bean名稱registration.setOrder(1);  // 設置過濾器的執行順序return registration;}
}

發起請求。查看過濾器執行結果。

二、攔截器Interceptor。

2.1定義與框架。

是 Spring MVC 框架中的核心組件，基于 Java 動態代理和 AOP（面向切面編程）實現，由 Spring 容器管理。
攔截器生命周期由 Spring 容器管理。

2.2工作原理與范圍。

工作在 Spring 的 DispatcherServlet 和具體的 Controller 之間。
當請求到達時，DispatcherServlet 根據配置的攔截器鏈對請求進行預處理，再轉發到相應 Controller；響應返回時，也會經過攔截器鏈。
可在請求到達 Controller 之前、Controller 方法執行之后以及請求完成后進行攔截處理。

2.3使用場景。

主要用于實現跨切面邏輯，如日志記錄、性能統計、安全控制（如權限驗證，判斷用戶是否有權限訪問特定資源）、事務處理、返回值處理等。
如在某后臺管理系統中，使用攔截器檢查用戶是否登錄且具備操作權限（JWT令牌）。或在每次業務方法調用前后記錄時間，統計方法執行性能。
過濾器適用于所有 Java Web 項目；攔截器僅適用于基于 Spring MVC 的項目。

2.4 SpringBoot實現攔截器。

<1>創建攔截器類（實現 HandlerInterceptor 接口）。

日志記錄。(SLF4J、Logback)
使用 SLF4J（Simple Logging Facade for Java）作為日志門面，結合 Logback 作為具體的日志實現。通過 LoggerFactory.getLogger(LogInterceptor.class) 獲取日志記錄器。

多線程處理。(ThreadLocal)
使用 ThreadLocal 來存儲與當前線程相關的請求時間記錄 ?。它為每個線程提供單獨的變量副本，避免多線程環境下數據錯亂，保證每個線程操作的是自己的請求時間記錄。最后在 afterCompletion() 方法中調用 remove() 方法及時清除數據，防止內存泄漏。

package com.hyl.interceptor;import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;import java.util.HashMap;
import java.util.Map;/*** 自定義攔截器：記錄請求耗時和路徑*/
public class LogInterceptor implements HandlerInterceptor {private static final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);// 日志記錄Logbackprivate final ThreadLocal<Map<String, Object>> requestTime = new ThreadLocal<>(); // 線程安全的請求時間記錄/*** 請求處理前執行（Controller 方法調用前）*/@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {// 記錄請求開始時間long startTime = System.currentTimeMillis();Map<String, Object> timeMap = new HashMap<>();timeMap.put("startTime", startTime);timeMap.put("requestURI", request.getRequestURI()); // 記錄請求路徑requestTime.set(timeMap); // 存入 ThreadLocal 避免多線程沖突return true; // 返回 true 表示繼續處理請求，返回 false 則攔截請求}/*** 請求處理后執行（Controller方法調用后，視圖渲染前）*/@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) {}/*** 請求完成后執行（視圖渲染完成后）*/@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {// 從 ThreadLocal 中獲取請求時間記錄Map<String, Object> timeMap = requestTime.get();if (timeMap != null) {long endTime = System.currentTimeMillis();long duration = endTime - (Long) timeMap.get("startTime");  //總耗時String requestURI = timeMap.get("requestURI").toString();// 輸出日志：請求路徑、耗時logger.info("【攔截器日志】請求路徑：{}，耗時：{}ms", requestURI, duration);requestTime.remove(); // 清除ThreadLocal數據，避免內存泄漏}}
}

<2>創建攔截器配置類（實現 WebMvcConfigurer 接口）。

package com.hyl.config;import com.hyl.interceptor.LogInterceptor;
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 InterceptorConfig implements WebMvcConfigurer {/*** 注冊攔截器到 Spring MVC 中，并配置攔截路徑*/@Overridepublic void addInterceptors(InterceptorRegistry registry) {LogInterceptor logInterceptor = new LogInterceptor(); // 創建攔截器實例registry.addInterceptor(logInterceptor) // 添加攔截器.addPathPatterns("/**") // 攔截所有路徑.excludePathPatterns("/static/**", "/favicon.ico"); // 排除靜態資源和圖標請求。防止干擾// 若有多個攔截器，可繼續調用addInterceptor()注冊// 可通過 .order(n) 設置攔截執行順序（n越小越先執行）}
}

發起請求。查看攔截器執行結果。

日志輸出級別：INFO。

三、全局異常捕獲處理器GlobalExceptionHandler。

3.1?全局異常捕獲處理器定義與實現方法。

在 Spring 項目中，為統一處理異常，可創建全局異常處理類。
1、通過在類上使用 @ControllerAdvice 注解，使其成為全局異常處理組件。
2、在類中的方法上使用 @ExceptionHandler 注解并指定攔截的異常類型（如Exception.class 表示攔截所有異常）來處理對應異常。
3、若返回字符串或 JSON 數據，需在方法上加 @ResponseBody 注解。

3.2 SpringBoot實現全局異常捕獲處理器。

<1>自定義響應結果封裝類。(Result類)

package com.hyl.pojo;import lombok.Data;//封裝響應結果類
@Data
public class Result {private String code;private String msg;private Object data;public Result() {}public Result(String code, String msg) {this.code = code;this.msg = msg;}public Result(String code, String msg, Object data) {this.code = code;this.msg = msg;this.data = data;}//響應success（無數據返回）public static Result success(){return new Result("200","操作成功");}//響應success（無數據返回）public static Result success(String msg){return new Result("200",msg);}//響應success（有數據返回）public static Result success(Object data) {return new Result("200","操作成功",data);}//響應success（有數據返回）public static Result success(String msg,Object data) {return new Result("200",msg,data);}//響應error（無數據返回）public static Result error(){return new Result("500","操作失敗");}//響應error（自定義異常信息提示）public static Result error(String code, String msg){Result result = new Result();result.setCode(code);result.setMsg(msg);return result;}}

<2>自定義全局異常捕獲處理類。(GlobalExceptionHandler類)

package com.hyl.exception;import com.hyl.pojo.Result;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;// 標識該類為全局異常處理類，會對所有@Controller注解的控制器中拋出的異常進行統一捕獲處理
@ControllerAdvice
public class GlobalExceptionHandler {// 獲取日志記錄器，用于記錄異常相關信息private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);  // 日志記錄器@ExceptionHandler(Exception.class) // 聲明該方法用于處理所有類型為Exception及其子類的異常@ResponseBody  //返回值會直接作為HTTP響應體返回給客戶端public Result exceptionHandle(Exception e){System.out.println(e.getMessage());//存入日志log.info("全局異常處理器："+e.getMessage());return Result.error("500","系統繁忙！");}
}

<3>模擬產生異常的XxxController類。

package com.hyl.controller;import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/test")
public class TestController {@GetMapping("/exception")public String exception() {// 模擬空指針異常String str = null;return str.length() + "";}
}