在Spring Boot应用中，Filter过滤器是用于处理HTTP请求和响应的重要组件，它允许开发者在请求到达控制器之前或之后执行自定义逻辑。本篇文章将深入探讨如何在Spring Boot中配置和使用Filter过滤器。
我们需要创建一个实现`javax.servlet.Filter`接口的类。这个类会包含`init`, `doFilter`和`destroy`这三个方法。例如，我们创建了一个名为`SessionFilter`的过滤器，用于检查用户的登录状态：
```java
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class SessionFilter implements Filter {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(SessionFilter.class);
// 封装，不需要过滤的URL列表
protected static List<Pattern> patterns = new ArrayList<>();
@Override
public void init(FilterConfig filterConfig) throws ServletException {
// 初始化方法，通常在这里进行配置加载
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) servletRequest;
HttpServletResponse httpResponse = (HttpServletResponse) servletResponse;
// 打印日志
logger.info("aaaaaaaaaa");
// 获取请求URL
String url = httpRequest.getRequestURI().substring(httpRequest.getContextPath().length());
// 如果URL需要被过滤
if (url.startsWith("/") && url.length() > 1) {
url = url.substring(1);
}
if (isInclude(url)) {
// 如果URL在不需要过滤的列表中，直接传递给下一个过滤器或处理器
chain.doFilter(httpRequest, httpResponse);
return;
} else {
// 检查session是否存在
HttpSession session = httpRequest.getSession();
if (session.getAttribute("") != null) {
// session存在，继续请求处理
chain.doFilter(httpRequest, httpResponse);
return;
} else {
// session不存在，处理未登录状态（这里可以跳转到登录页面）
// ...
chain.doFilter(httpRequest, httpResponse);
return;
}
}
}
@Override
public void destroy() {
// 销毁方法，通常用于清理资源
}
// 方法检查URL是否需要过滤
private boolean isInclude(String url) {
// 实现此处的逻辑，比如匹配URL模式
// ...
return false;
}
}
```
接下来，我们需要在Spring Boot的配置中注册这个过滤器。这可以通过两种方式实现：
1. **使用`WebApplicationInitializer`接口**：
创建一个实现`WebApplicationInitializer`接口的类，并在`onStartup`方法中注册过滤器：
```java
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.ContextLoaderListener;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.filter.DelegatingFilterProxy;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;
public class MyWebAppInitializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
context.register(AppConfig.class); // AppConfig是你的Spring配置类
servletContext.addListener(new ContextLoaderListener(context));
ServletRegistration.Dynamic registration = servletContext.addFilter("sessionFilter", DelegatingFilterProxy.class);
registration.setInitParameter("targetFilterLifecycle", "true");
registration.addMapping("/*");
}
}
```
2. **使用`@WebFilter`注解**：
直接在过滤器类上使用`@WebFilter`注解来注册过滤器：
```java
@WebFilter(filterName = "sessionFilter", urlPatterns = "/*")
public class SessionFilter implements Filter {
// ...
}
```
3. **使用Spring Boot的`WebFilter`接口**：
如果你正在使用Spring Boot 2.x或更高版本，可以使用`WebFilter`接口来注册过滤器，这是一个更现代、更面向声明的方式：
```java
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebFilter;
import reactor.core.publisher.Mono;
@Component
public class SessionWebFilter implements WebFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
// 这里使用Reactor编写过滤器逻辑
// ...
return chain.filter(exchange);
}
}
```
在上述代码中，`doFilter`方法是过滤器的核心，它控制着请求的流程。`isInclude`方法可以根据需求判断哪些URL需要被过滤。在实际项目中，你可以根据需要修改这部分逻辑，例如通过正则表达式匹配URL。
别忘了在你的Spring配置类中，将过滤器类标记为`@Component`，以便Spring自动扫描并实例化。如果使用的是XML配置，你需要在XML文件中声明并配置过滤器。
Spring Boot配置Filter过滤器提供了多种方式，可以根据项目的具体需求和你对Spring框架的熟悉程度选择最适合的方法。通过过滤器，我们可以对HTTP请求进行拦截、修改或转发，实现诸如权限验证、日志记录、数据转换等功能，从而增强应用程序的功能和安全性。
