SpringBoot 与 Servlet 整合的两种方式，一种是 Servlet 3.0 原生的注解方式，一种是采用 Spring 注册的方式

1. Spring 注册方式

1.1 组件声明

声明过滤器、监听器和 Servlet

  1. /**
  2.  * @description : 自定义过滤器
  3.  */
  4. public class CustomFilter implements Filter {
  6.     @Override
  7.     public void init(FilterConfig filterConfig) throws ServletException {
  9.     }
  11.     @Override
  12.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  13.         request.setAttribute("filterParam","我是 filter 传递的参数");
  14.         chain.doFilter(request,response);
  15.         response.getWriter().append(" CustomFilter ");
  16.     }
  18.     @Override
  19.     public void destroy() {
  21.     }
  22. }
  1. /**
  2.  * @description : 自定义监听器
  3.  */
  4. public class CustomListen implements ServletContextListener {
  6.     //Web 应用程序初始化过程正在启动的通知
  7.     @Override
  8.     public void contextInitialized(ServletContextEvent sce) {
  9.         System.out.println("容器初始化启动");
  10.     }
  14.     /* 通知 servlet 上下文即将关闭
  15.      * 这个地方如果我们使用的是 spring boot 内置的容器 是监听不到销毁过程，所以我们使用了外置 tomcat 容器
  16.      */
  17.     @Override
  18.     public void contextDestroyed(ServletContextEvent sce) {
  19.         System.out.println("容器即将销毁");
  20.     }
  21. }
  1. /**
  2.  * @description : 自定义 servlet
  3.  */
  4. public class CustomServlet extends HttpServlet {
  6.     @Override
  7.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  8.         System.out.println("doGet 执行：" + req.getAttribute("filterParam"));
  9.         resp.getWriter().append("CustomServlet");
  10.     }
  12.     @Override
  13.     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  14.         doGet(req, resp);
  15.     }
  16. }

1.2 组件注册

  1. @Configuration
  2. public class ServletConfig {
  4.     @Bean
  5.     public ServletRegistrationBean registrationBean() {
  6.         return new ServletRegistrationBean<HttpServlet>(new CustomServlet(), "/servlet");
  7.     }
  9.     @Bean
  10.     public FilterRegistrationBean filterRegistrationBean() {
  11.         FilterRegistrationBean bean = new FilterRegistrationBean<Filter>();
  12.         bean.setFilter(new CustomFilter());
  13.         bean.addUrlPatterns("/servlet");
  14.         return bean;
  15.     }
  17.     @Bean
  18.     public ServletListenerRegistrationBean listenerRegistrationBean() {
  19.         return new ServletListenerRegistrationBean<ServletContextListener>(new CustomListen());
  20.     }
  22. }

2. 原生注解方式

2.1 组件声明

新建过滤器、监听器和 servlet,分别使用 @WebFilter、@WebListener、@WebServlet 注解进行声明：

  1. /**
  2.  * @description : 自定义过滤器
  3.  */
  5. @WebFilter(urlPatterns = "/servletAnn")
  6. public class CustomFilterAnnotation implements Filter {
  8.     @Override
  9.     public void init(FilterConfig filterConfig) throws ServletException {
  11.     }
  13.     @Override
  14.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  15.         chain.doFilter(request,response);
  16.         response.getWriter().append(" CustomFilter Annotation");
  17.     }
  19.     @Override
  20.     public void destroy() {
  22.     }
  23. }
  1. /**
  2.  * @description :自定义监听器
  3.  */
  4. @WebListener
  5. public class CustomListenAnnotation implements ServletContextListener {
  7.     //Web 应用程序初始化过程正在启动的通知
  8.     @Override
  9.     public void contextInitialized(ServletContextEvent sce) {
  10.         System.out.println("容器初始化启动 Annotation");
  11.     }
  15.     /* 通知 servlet 上下文即将关闭
  16.      * 这个地方如果我们使用的是 spring boot 内置的容器 是监听不到销毁过程，所以我们使用了外置 tomcat 容器
  17.      */
  18.     @Override
  19.     public void contextDestroyed(ServletContextEvent sce) {
  20.         System.out.println("容器即将销毁 Annotation");
  21.     }
  22. }
  1. /**
  2.  * @description : 自定义 servlet
  3.  */
  4. @WebServlet(urlPatterns = "/servletAnn")
  5. public class CustomServletAnnotation extends HttpServlet {
  7.     @Override
  8.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  9.         resp.getWriter().append("CustomServlet Annotation");
  10.     }
  12.     @Override
  13.     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  14.         doGet(req, resp);
  15.     }
  16. }

2.2 组件生效

想要让使用 Servlet 3.0 原生注解方式声明的组件生效，有以下两种方式：

  1. 如果是内置容器，需要在启动类上添加 @ServletComponentScan ，指定扫描的包目录；
  2. 如果是外置容器，不需要进行任何配置，依靠容器内建的 Discovery 机制自动发现，需要说明的是这里的容器必须支持 Servlet 3.0（ Tomcat 从 7.0 版本开始支持 Servlet3.0）。