在Spring Boot中,通常不直接在Controller上添加Filter,而是全局注册一个Filter,让其作用于所有的Controller。以下是使用FilterRegistrationBean
在Spring Boot中注册Filter的步骤:
- 首先,创建自定义的Filter类。例如:
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@Component
public class CustomFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) request;
System.out.println("Before processing the request: " + httpRequest.getRequestURI());
chain.doFilter(request, response); // 传递请求到下一个过滤器或目标控制器
System.out.println("After processing the request: " + httpRequest.getRequestURI());
}
// 其他可选的方法,如 init() 和 destroy()
}
- 接下来,在Spring Boot的配置类中,使用
FilterRegistrationBean
注册你的Filter:
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean<CustomFilter> customFilterRegistration() {
FilterRegistrationBean<CustomFilter> registration = new FilterRegistrationBean<>();
registration.setFilter(new CustomFilter()); // 设置 Filter 实例
registration.setName("CustomFilter"); // 设置 Filter 名称
registration.addUrlPatterns("/*"); // 设置 URL 模式,这里设置为匹配所有请求
registration.setOrder(0); // 设置 Filter 的执行顺序,数字越小,优先级越高
return registration;
}
}
- 最后,确保你的配置类被Spring Boot扫描到,或者你已经在主类中通过
@Import
导入了这个配置类。
这样,每次有请求到达Controller之前,都会先经过你的自定义Filter。注意,addUrlPatterns
中的/*
表示该Filter将应用于所有请求。如果你只想让它作用于特定的URL模式,可以修改这部分配置。