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应用。
• 在实际项目中，你可以根据需要选择使用过滤器或拦截器来实现请求处理前后的逻辑。