目录
一、使用 Servlet API
在 SpringBoot 中要使用 Servlet、Filter、Listener 的话,可通 过 @WebServlet/@WebFilter/@WebListener + @ServletComponentScan 注解组合实现;假如我们的 Servlet、Filter、Listener 都放在 com.study.springboot.servlet 这个包下,那么在使用这些原生组件之前,在项目的启动类或项目的配置类上添加如下注解
@Configuration
@ServletComponentScan(basePackages = "com.study.springboot.servlet")
public class AppConfig implements WebMvcConfigurer {... ...}
1. 使用 Servlet
新建 MyServlet.class 添加如下测试代码即可
@WebServlet(urlPatterns = {"/myServlet"})
public class MyServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
res.getWriter().write("myServlet ...");
}
... ...
}
2. 使用 Filter
新建 MyFilter.class 添加如下测试代码即可
@WebFilter(urlPatterns = {"/*"})
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("Filter 被初始化");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException,
ServletException {
System.out.println("Filter 拦截了请求 " + ((HttpServletRequest) request).getRequestURI());
chain.doFilter(request, response);
}
@Override
public void destroy() {
System.out.println("Filter 被销毁了");
}
}
3. 使用 Listener
新建 MyServletContextListener.class 监听项目状态,添加如下测试代码即可
@WebListener
public class MyServletContextListener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent sce) {
System.out.println("MyServletContextListener监听到项目初始化完成 ...");
}
@Override
public void contextDestroyed(ServletContextEvent sce) {
System.out.println("MyServletContextListener监听到项目销毁完成 ...");
}
}
二、使用 RegistrationBean
在 SpringBoot 中要使用 Servlet、Filter、Listener 也可以通过使用 ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean 实现;只需要在配置类中添加如下配置即可
@Configuration
public class AppConfig implements WebMvcConfigurer {
/**
* 注册 Servlet
*/
@Bean
public ServletRegistrationBean servletRegistrationBean() {
MyServlet myServlet = new MyServlet();
return new ServletRegistrationBean(myServlet, "/myServlet1");
}
/**
* 注册 Filter
*/
@Bean
public FilterRegistrationBean filterRegistrationBean() {
MyFilter myFilter = new MyFilter();
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(myFilter);
// 要拦截的路径
filterRegistrationBean.setUrlPatterns(Arrays.asList("/hello"));
return filterRegistrationBean;
}
/**
* 注册 Listener
*/
@Bean
public ServletListenerRegistrationBean servletListenerRegistrationBean() {
MyServletContextListener myServletContextListener = new MyServletContextListener();
return new ServletListenerRegistrationBean(myServletContextListener);
}
}