java springboot过滤器

huanhuan_m12024-06-30 15:16

在Spring Boot应用中添加自定义过滤器，可以通过实现Filter接口或继承OncePerRequestFilter类来创建过滤器，并使用FilterRegistrationBean将其注册到Spring容器中。

以下是一个简单的示例：

1. 创建过滤器类

首先，创建一个实现Filter接口的类，或者为了简化单次请求处理逻辑，继承OncePerRequestFilter类。

下面是一个简单的日志记录过滤器示例：

java 复制代码

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

import org.springframework.stereotype.Component;

@Component
public class RequestLoggingFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        
        System.out.println("Request Log: " + request.getMethod() + " " + request.getRequestURI());
        
        // 继续执行下一个过滤器或请求处理器
        filterChain.doFilter(request, response);
        
        System.out.println("Response Log: " + response.getStatus());
    }
}

2. 注册过滤器

通常，Spring Boot会自动检测并注册标记为@Component的过滤器，但也可以通过配置类更精确地控制过滤器的注册，比如指定过滤器的URL模式。

使用FilterRegistrationBean来完成这个任务：

java 复制代码

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<RequestLoggingFilter> loggingFilterRegistration(RequestLoggingFilter filter) {
        FilterRegistrationBean<RequestLoggingFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(filter);
        // 设置过滤器的URL模式，这里示例为所有请求
        registration.addUrlPatterns("/*");
        // 设置过滤器的顺序，值越小优先级越高
        registration.setOrder(1); 
        return registration;
    }
}