Springboot配置Servlet、Filter、Listener

Servlet、Filter、Listener代码

package me.zhao.servlet;

import java.io.IOException;

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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@WebServlet(urlPatterns = "/testServlet")
public class TestServlet extends HttpServlet  {

	private static final long serialVersionUID = 1L;
	
	private static Logger logger = LoggerFactory.getLogger(TestServlet.class);

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
		logger.info("TestServlet");
		resp.getWriter().print("TestServlet");
	}
}

package me.zhao.filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@WebFilter(urlPatterns = "/*", filterName = "testFilter")
public class TestFilter implements Filter {

	private static Logger logger = LoggerFactory.getLogger(TestFilter.class);
	
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
		throws IOException, ServletException {
		
		logger.info("FilterTest");
		chain.doFilter(request, response);
	}
}

package me.zhao.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@WebListener
public class TestListener implements ServletContextListener {

	private static Logger logger = LoggerFactory.getLogger(TestListener.class);
	
	@Override
	public void contextInitialized(ServletContextEvent sce) {
		logger.info("TestListener contextInitialized");
	}
}

注解方式

• 需要在主函数上添加@ServletComponentScan注解
• Servlet、Filter、Listener分别添加@WebServlet、@WebFilter、@WebListener

package me.zhao;

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

@SpringBootApplication
@ServletComponentScan
public class SpringbootFilterListenerApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootFilterListenerApplication.class, args);
	}
}

Bean注册方式

Springboot提供了三个注册Bean：ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean

package me.zhao.config;

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

import me.zhao.filter.TestFilter;
import me.zhao.listener.TestListener;
import me.zhao.servlet.TestServlet;

@Configuration
public class Config {

	@Bean
	public ServletRegistrationBean<TestServlet> servletRegister() {
		ServletRegistrationBean<TestServlet> servletRegistrationBean = new ServletRegistrationBean<TestServlet>();
		servletRegistrationBean.setServlet(new TestServlet());
		servletRegistrationBean.addUrlMappings("/testServlet");
		return servletRegistrationBean;
	}
	
	@Bean
	public FilterRegistrationBean<TestFilter> filterRegister() {
		FilterRegistrationBean<TestFilter> filterRegistrationBean = new FilterRegistrationBean<TestFilter>();
		filterRegistrationBean.setFilter(new TestFilter());
		filterRegistrationBean.addUrlPatterns("/*");
		return filterRegistrationBean;
	}
	
	@Bean
	public ServletListenerRegistrationBean<TestListener> listenerRegister() {
		ServletListenerRegistrationBean<TestListener> servletListenerRegistrationBean = new ServletListenerRegistrationBean<TestListener>();
		servletListenerRegistrationBean.setListener(new TestListener());
		return servletListenerRegistrationBean;
	}
}

参考文章

• SpringBoot初始教程之Servlet、Filter、Listener配置(七)

完整代码

https://gitee.com/zhaobingshuang/springboot-study/tree/master/springboot-filter-listener-servlet