Spring Boot中的自定義過濾器與攔截器

在Spring Boot中，自定義過濾器（Filter）和攔截器（Interceptor）都可以用來在請求處理之前或之后執行特定的邏輯。它們之間的主要區別在于它們所依賴的機制和使用場景。

1. 自定義過濾器（Filter）：

過濾器是基于Java Servlet規范的，它允許你在請求到達控制器之前或響應返回給客戶端之前執行特定的操作。在Spring Boot中，你可以通過實現javax.servlet.Filter接口來創建自定義過濾器。

要使用自定義過濾器，你需要執行以下步驟：

• 創建一個類，實現javax.servlet.Filter接口。
• 重寫doFilter()方法，在該方法中編寫你的過濾邏輯。
• 在Spring Boot配置類中，使用@Bean注解將自定義過濾器注冊為一個Bean。
• 配置過濾器的優先級，以便在請求處理過程中按照預期的順序執行。

示例：

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

public class MyCustomFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化過濾器邏輯
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        // 在請求到達控制器之前執行的邏輯

        chain.doFilter(request, response); // 繼續執行請求處理

        // 在響應返回給客戶端之前執行的邏輯
    }

    @Override
    public void destroy() {
        // 銷毀過濾器邏輯
    }
}

在配置類中注冊過濾器：

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<MyCustomFilter> myCustomFilterRegistration() {
        FilterRegistrationBean<MyCustomFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MyCustomFilter());
        registration.addUrlPatterns("/*"); // 指定過濾器應用的URL模式
        registration.setOrder(1); // 設置過濾器的優先級
        return registration;
    }
}

2. 自定義攔截器（Interceptor）：

攔截器是基于Spring MVC的，它允許你在控制器方法執行之前或之后執行特定的操作。在Spring Boot中，你可以通過實現org.springframework.web.servlet.HandlerInterceptor接口來創建自定義攔截器。

要使用自定義攔截器，你需要執行以下步驟：

• 創建一個類，實現org.springframework.web.servlet.HandlerInterceptor接口。
• 重寫preHandle()、postHandle()和afterCompletion()方法，分別用于在控制器方法執行之前、之后以及在方法執行完成后執行邏輯。
• 在Spring Boot配置類中，使用@Bean注解將自定義攔截器注冊為一個Bean。
• 配置攔截器的優先級，以便在請求處理過程中按照預期的順序執行。

示例：

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

public class MyCustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在控制器方法執行之前執行的邏輯
        return true; // 返回true表示繼續執行請求處理，返回false表示中斷請求處理
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在控制器方法執行之后執行的邏輯
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在控制器方法執行完成后執行的邏輯
    }
}

在配置類中注冊攔截器：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Bean
    public HandlerInterceptorRegistrationBean<MyCustomInterceptor> myCustomInterceptorRegistration() {
        HandlerInterceptorRegistrationBean<MyCustomInterceptor> registration = new HandlerInterceptorRegistrationBean<>();
        registration.setInterceptor(new MyCustomInterceptor());
        registration.addUrlPatterns("/*"); // 指定攔截器應用的URL模式
        registration.setOrder(1); // 設置攔截器的優先級
        return registration;
    }
}

總結：

• 自定義過濾器是基于Java Servlet規范的，適用于任何遵循Servlet規范的Web應用。
• 自定義攔截器是基于Spring MVC的，適用于Spring Boot等基于Spring框架的Web應用。
• 在實際項目中，你可以根據需要選擇使用過濾器或攔截器來實現請求處理前后的邏輯。