18.Spring Boot 注册Servlet、Filter、Listener

原创已于 2022-03-15 11:00:01 修改 · 1w 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#Spring Boot #Spring Boot 注册servle #Spring Boot filter

于 2017-02-01 21:36:43 首次发布

Spring Boot 专栏收录该内容

18 篇文章

订阅专栏

本文介绍如何在SpringBoot中使用Java配置方式注册Servlet、Filter和Listener。提供了使用ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean及@WebServlet、@WebFilter、@WebListener等注解的具体示例。

Spring Boot 注册Servlet、Filter、Listener

在Servlet 3.0之前我们都是使用web.xml进行配置，需要增加Servlet、Filter或者Listener都是在web.xml增加相应的配置即可。这里我们使用的是使用Java配置来注册Servlet、Filter、Listener。

1.注册Servlet

（1）使用ServletRegistrationBean注册

使用ServletRegistrationBean注册只需要在@Configuration类中加入即可，例如以下代码：

@Bean
	public ServletRegistrationBean myServlet() {
		ServletRegistrationBean myServlet = new ServletRegistrationBean();
		myServlet.addUrlMappings("/servlet");
		myServlet.setServlet(new MyServlet());
		return myServlet;
	}

（2）使用@WebServlet

使用@WebServlet注册，需要在Servlet类上使用该注解即可，但是需要在@Configuration类中使用Spring Boot提供的注解@ServletComponentScan扫描注册相应的Servlet。

2.注册Filter

（1）使用FilterRegistrationBean注册

使用FilterRegistrationBean注册Filter，只需要在@Configuration类中加入即可，例如以下代码：

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

（2）使用@WebFilter

使用@WebFilter注册，需要在Filter类上使用该注解即可，但是需要在@Configuration类中使用Spring Boot提供的注解@ServletComponentScan扫描注册相应的Filter。

3.注册Listener

（1）使用ServletListenerRegistrationBean注册

使用ServletListenerRegistrationBean注册Listener只需要在@Configuration类中加入即可，例如以下代码：

@Bean
	public ServletListenerRegistrationBean<MyListener> myServletListener() {
		ServletListenerRegistrationBean<MyListener> myListener = new ServletListenerRegistrationBean<MyListener>();
		myListener.setListener(new MyListener());
		return myListener;
	}

（2）使用@WebListener

使用@WebListener注册，需要在Filter类上使用该注解即可，但是需要在@Configuration类中使用Spring Boot提供的注解@ServletComponentScan扫描注册相应的Listener。