SpringBoot如何注册filter，servlet，listener

发布于：2025-08-11 ⋅ 阅读:(15) ⋅ 点赞:(0)

题目详细答案

在 Spring Boot 中，注册 Filter、Servlet 和 Listener 有多种方式。你可以通过代码配置、注解配置或在application.properties文件中进行配置。

使用@ServletComponentScan和注解配置

你可以使用@WebFilter、@WebServlet和@WebListener注解来注册 Filter、Servlet 和 Listener。这种方式不需要额外的配置类。

filter

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter(urlPatterns = "/*")
public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化代码
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 过滤器逻辑
        System.out.println("Filter is called");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        // 销毁代码
    }
}

servlet

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet(urlPatterns = "/myServlet")
public class MyServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().write("Hello from MyServlet");
    }
}

listener

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class MyListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("Context Initialized");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("Context Destroyed");
    }
}

在主应用类中添加@ServletComponentScan注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

使用@Bean配置

也可以在配置类中通过@Bean注解来注册 Filter、Servlet 和 Listener。

filter

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

@Configuration
public class MyFilterConfig {

    @Bean
    public FilterRegistrationBean<MyFilter> myFilter() {
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new MyFilter());
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }
}

servlet

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

@Configuration
public class MyServletConfig {

    @Bean
    public ServletRegistrationBean<MyServlet> myServlet() {
        ServletRegistrationBean<MyServlet> registrationBean = new ServletRegistrationBean<>(new MyServlet(), "/myServlet");
        return registrationBean;
    }
}

listener

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

@Configuration
public class MyListenerConfig {

    @Bean
    public ServletListenerRegistrationBean<MyListener> myListener() {
        return new ServletListenerRegistrationBean<>(new MyListener());
    }
}

使用application.properties配置

对于某些简单的配置，可以在application.properties文件中进行配置。

# 配置 Filter
spring.servlet.filter-order=1
spring.servlet.filter-url-patterns=/*

# 配置 Servlet
spring.servlet.servlet-name=myServlet
spring.servlet.servlet-url-patterns=/myServlet

# 配置 Listener
spring.listener.listener-class=com.example.MyListener

Spring Boot 中注册 Filter、Servlet 和 Listener 的完整指南

Spring Boot 提供了多种灵活的方式来注册传统的 Servlet 组件（Filter、Servlet 和 Listener）。下面我将详细介绍各种注册方式及其适用场景。

一、使用 @ServletComponentScan 和注解配置（最简单方式）

1. 注册 Filter

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;

@WebFilter(urlPatterns = {"/*"}, filterName = "myFilter")
public class MyFilter implements Filter {
    
    @Override
    public void init(FilterConfig filterConfig) {
        System.out.println("Filter初始化: " + filterConfig.getFilterName());
    }
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, 
                       FilterChain chain) throws IOException, ServletException {
        System.out.println("Before request processing");
        chain.doFilter(request, response);
        System.out.println("After request processing");
    }
    
    @Override
    public void destroy() {
        System.out.println("Filter销毁");
    }
}

2. 注册 Servlet

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;

@WebServlet(urlPatterns = "/custom", name = "myServlet")
public class MyServlet extends HttpServlet {
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
        resp.setContentType("text/plain");
        resp.getWriter().println("Hello from custom servlet");
    }
}

3. 注册 Listener

import javax.servlet.annotation.WebListener;
import javax.servlet.ServletContextEvent;

@WebListener
public class MyListener implements ServletContextListener {
    
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("应用上下文初始化: " + sce.getServletContext());
    }
    
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("应用上下文销毁");
    }
}

4. 启用组件扫描

@SpringBootApplication
@ServletComponentScan(basePackages = "com.example.servlet") // 指定扫描包
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

优点：

  • 配置简单直观
  • 代码量少
  • 适合简单的组件注册

缺点：

  • 对组件的控制粒度较粗
  • 无法动态调整参数

二、使用 @Bean 配置（推荐方式）

1. 注册 Filter（支持排序）

@Configuration
public class WebConfig {
    
    @Bean
    public FilterRegistrationBean<MyFilter> loggingFilter() {
        FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MyFilter());
        registration.addUrlPatterns("/*");
        registration.setName("myFilter");
        registration.setOrder(1); // 设置执行顺序
        
        // 添加初始化参数
        registration.addInitParameter("param1", "value1");
        
        return registration;
    }
}

2. 注册 Servlet（支持路径映射）

@Bean
public ServletRegistrationBean<MyServlet> customServlet() {
    return new ServletRegistrationBean<>(
        new MyServlet(), 
        "/custom", "/custom2/*" // 支持多个路径
    );
}

3. 注册 Listener

@Bean
public ServletListenerRegistrationBean<MyListener> appListener() {
    return new ServletListenerRegistrationBean<>(new MyListener());
}

优点：

  • 完全控制组件注册过程
  • 可以设置初始化参数
  • 支持动态条件注册
  • 可以指定执行顺序

缺点：

  • 代码量稍多
  • 需要显式配置

三、使用 application.properties 配置（有限支持）

# 配置Servlet (仅适用于嵌入式容器)
server.servlet.context-path=/api
server.servlet.session.timeout=30m

# 特定Filter配置 (如HiddenHttpMethodFilter)
spring.mvc.hiddenmethod.filter.enabled=true

注意：这种方式只能配置Spring Boot预定义的一些组件参数，无法注册自定义组件。

四、高级配置技巧

1. 多个Filter的顺序控制

@Bean
public FilterRegistrationBean<FilterA> filterA() {
    FilterRegistrationBean<FilterA> bean = new FilterRegistrationBean<>(new FilterA());
    bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
    return bean;
}

@Bean 
public FilterRegistrationBean<FilterB> filterB() {
    FilterRegistrationBean<FilterB> bean = new FilterRegistrationBean<>(new FilterB());
    bean.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
    return bean;
}

2. 条件注册

@Bean
@ConditionalOnProperty(name = "features.logging-filter", havingValue = "true")
public FilterRegistrationBean<LoggingFilter> loggingFilter() {
    // ...
}

3. 使用Spring管理的Bean

@Bean
public FilterRegistrationBean<MyFilter> springManagedFilter(MyDependency dependency) {
    return new FilterRegistrationBean<>(new MyFilter(dependency));
}

五、最佳实践建议

  1. 生产环境推荐：使用@Bean方式注册，因为它提供最大的灵活性和控制力
  2. 快速原型开发：可以使用@WebFilter/@WebServlet注解简化配置
  3. Filter注意事项：
    • 避免在Filter中执行耗时操作
    • 确保调用chain.doFilter()
    • 正确处理异常
  1. Servlet注意事项：
    • 在REST API应用中通常不需要自定义Servlet
    • 考虑使用@RestController代替
  1. Listener使用场景：
    • 应用启动/关闭时的资源初始化和清理
    • 会话(Session)生命周期监控
    • 请求(Request)生命周期监控

六、常见问题解决

1. Filter不生效

  • 检查是否被@ServletComponentScan扫描到
  • 确认没有在@Bean注册时覆盖了注解配置
  • 查看是否有更高优先级的Filter中断了调用链

2. 执行顺序问题

  • 使用FilterRegistrationBean.setOrder()明确指定顺序
  • 注意@Order注解对Filter无效

3. 组件重复注册

  • 避免同时使用注解和@Bean两种方式注册同一组件
  • 检查是否有多个配置类注册了相同组件

通过合理选择注册方式，可以灵活地将传统Servlet组件集成到Spring Boot应用中，同时享受Spring的依赖注入和其他特性。

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布