ToB企服应用市场:ToB评测及商务社交产业平台

标题: 十三，Spring Boot 中注入 Servlet，Filter，Listener [打印本页]

---

作者: 笑看天下无敌手    时间: 2024-9-15 15:27
标题: 十三，Spring Boot 中注入 Servlet，Filter，Listener
十三，Spring Boot 中注入 Servlet，Filter，Listener

@
目录

• 十三，Spring Boot 中注入 Servlet，Filter，Listener
  
• 1. 根本介绍
  
• 2. 第一种方式：使用注解方式注入：Servlet，Filter，Listener
  
  
  
  • 2.1 使用注解方式注入：Servlet
    
  • 2.2 使用注解方式注入：Filter
    
  • 2.3 使用注解方式注入：Listener
    
  
  
• 3. 第二种方式：使用 RegistrationBean 方式注入 Servlet，Filter，Listener
  
  
  
  • 3.1 使用 RegistrationBean 方式注入 Servlet
    
  • 3.2 使用 RegistrationBean 方式注入 Filter
    
  • 3.3 使用 RegistrationBean 方式注入 Listener
    
  
  
• 4. 留意事项和细节说明
  
• 5. 总结：
  
• 6. 最后：
  

1. 根本介绍

• 考虑到现实开发业务非常复杂和兼容，Spring-Boot 支持将 Servlet，Filter ，Listener注入Spring容器，成为Spring bean
  
• 也就是说明 Spring Boot 开放了和原生 WEB组件(Servlet,Filter,Listener)的兼容。
  

在Spring Boot 当中对应 Servlet，Filter (过滤器)，Listener(监听器)的注入，有两种方式：

• 第一种方式：使用注解方式注入 。
  
• 第二种方式：使用 RegistrationBean方式注入 Servlet，Filter，Listener 的方式注入。
  

2. 第一种方式：使用注解方式注入：Servlet，Filter，Listener

2.1 使用注解方式注入：Servlet

使用（@WebServlet + @ServletComponentScan ） 这两个注解方式注入 Servlet
提示: urlPatterns = {"/servlet01","servlet02"},对Servlet设置了url-pat:请求路径的映射

• 注入的原生的 Servlet_，不会被Spring boot的拦截器拦截
  
• 对于开发的原生的Servlet,需要使用@ServletComponentScan指定要扫描的原生Servlet,才会注入到 Spring容器当中，留意：是在启动场景的位置添加该@ServletComponentScan注解。
  

1. package com.rainbowsea.springboot.servlet;
4. import javax.servlet.ServletException;
5. import javax.servlet.annotation.WebServlet;
6. import javax.servlet.http.HttpServlet;
7. import javax.servlet.http.HttpServletRequest;
8. import javax.servlet.http.HttpServletResponse;
9. import java.io.IOException;
12. // 使用 extends 继承的方式(@WebServlet + @ServletComponentScan 注解)，注入 servlet
13. @WebServlet(urlPatterns = {"/servlet01","/servlet02"}) // 注意是： / 开头
14. public class Servlet_ extends HttpServlet {
16.     @Override
17.     protected void doGet(HttpServletRequest request, HttpServletResponse response
18.     ) throws ServletException,
19.             IOException {
20.         // 在前端显示打印显示一些信息。
21.         response.getWriter().write("hello , Servlet_!");
23.     }
24. }

复制代码

留意需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

1. package com.rainbowsea.springboot;
4. import org.springframework.boot.SpringApplication;
5. import org.springframework.boot.autoconfigure.SpringBootApplication;
6. import org.springframework.boot.web.servlet.ServletComponentScan;
7. import org.springframework.context.ConfigurableApplicationContext;
10. @SpringBootApplication // 项目启动标志
11. @ServletComponentScan(basePackages = {"com.rainbowsea.springboot"})
12. public class Application {
14.     public static void main(String[] args) {
15.         ConfigurableApplicationContext ioc = SpringApplication.run(Application.class, args);
16.         //ioc.stop();  // 停止容器
18.         System.out.println("hello");
19.     }
20. }

复制代码

运行测试：

2.2 使用注解方式注入：Filter

使用（@WebFilter+ @ServletComponentScan ） 这两个注解方式注入 Filter
留意注入的 Filter 过滤器要实现 implements javax.servlet.Filter 下的 Filter

1. / 注意是:  javax.servlet.Filter 下的 Filter
2. // 注入过滤器:(使用： @WebFilter(urlPatterns = {"/css/*","/images/*"}) + @ServletComponentScan(basePackages = {"com.rainbowsea.springboot"}))
3. /*
4. @WebFilter(urlPatterns = {"/css/*", "/images/*"})
5. @WebFilter 表示 Filter_是一个过滤器，并注入容器
6. urlPatterns = {"/css/*", "/images/*"} 当请求 /css/ 目录资源或者images
7. 解读: 直接放行后，在经过拦截器，拦截器是否拦截要根据拦截器的拦截规则
9. 特别说明在：之前下面这样配置的拦截器也是会拦截内容的。
10. @Bean
11.     public WebMvcConfigurer webMvcConfigurer() {
12.         return new WebMvcConfigurer() {
13.             @Override
14.             public void addInterceptors(InterceptorRegistry registry) {
15.                 System.out.println("addInterceptors~~~");
16.                 // 注册拦截器
17.                 registry.addInterceptor(new LoginInterceptor())
18.                         .addPathPatterns("/**")
19.                         .excludePathPatterns("/","/login","/images/**");
20.             }
21.         };
22.     }

复制代码

留意：过滤器设置的urlPatterns 也会经过 Spring-Boot拦截器，所以为了
看到效果，请在拦截器设置放行 /css/**,
在 servlet 表示全部匹配是 "/*"；而在 Spring boot 中表示全部匹配的是: "/**"

1. package com.rainbowsea.springboot.servlet;
4. import lombok.extern.slf4j.Slf4j;
6. import javax.servlet.Filter;
7. import javax.servlet.FilterChain;
8. import javax.servlet.FilterConfig;
9. import javax.servlet.ServletException;
10. import javax.servlet.ServletRequest;
11. import javax.servlet.ServletResponse;
12. import javax.servlet.annotation.WebFilter;
13. import javax.servlet.http.HttpServletRequest;
14. import java.io.IOException;
18. @Slf4j
19. @WebFilter(urlPatterns = {"/static/css/*", "/images/*"})  // 注意：是/开头
20. public class Filter_ implements Filter {
21.     @Override
22.     public void init(FilterConfig filterConfig) throws ServletException {
23.         log.info("--Filter_ init0--");
24.     }
26.     @Override
27.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
28.         log.info("Filter - doFitler");
29.         // 为了方便观察过滤器处理的资源，我们输出一个url
30.         HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
31.         log.info("过滤器处理的 url={}",httpServletRequest.getRequestURI());
33.         // 我们直接放行,实际开发中，根据自己的业务来决定如何处理
34.         filterChain.doFilter(servletRequest, servletResponse);
35.     }
37.     @Override
38.     public void destroy() {
39.         log.info("Filter -destory");
40.     }
41. }

复制代码

同样留意：需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

运行测试：

2.3 使用注解方式注入：Listener

使用（@WebListener+ @ServletComponentScan ） 这两个注解方式注入 Servlet

1. package com.rainbowsea.springboot.servlet;
3. import lombok.extern.slf4j.Slf4j;
5. import javax.servlet.ServletContextEvent;
6. import javax.servlet.ServletContextListener;
7. import javax.servlet.annotation.WebListener;
9. // 注入监听器(@WebListener + @ServletComponentScan(basePackages = {"com.rainbowsea.springboot"}))
10. @Slf4j
11. @WebListener
12. public class Listener_ implements ServletContextListener {
13.     @Override
14.     public void contextInitialized(ServletContextEvent sce) {
15.         // 这里可以加入项目初始化的相关业务代码
16.         log.info("Listener_ contextInitialized 项目初始化OK~");
17.     }
19.     @Override
20.     public void contextDestroyed(ServletContextEvent sce) {
21.         // 这里可以加入相应代码...
22.         log.info("Listener_ contextInitialized 项目销毁OK~");
23.     }
24. }

复制代码

同样留意：需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

运行测试：

3. 第二种方式：使用 RegistrationBean 方式注入 Servlet，Filter，Listener

3.1 使用 RegistrationBean 方式注入 Servlet

1. package com.rainbowsea.springboot.config;
4. import com.rainbowsea.springboot.servlet.Filter_;
5. import com.rainbowsea.springboot.servlet.Listener_;
6. import com.rainbowsea.springboot.servlet.Servlet_;
7. import org.springframework.boot.web.servlet.FilterRegistrationBean;
8. import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
9. import org.springframework.boot.web.servlet.ServletRegistrationBean;
10. import org.springframework.context.annotation.Bean;
11. import org.springframework.context.annotation.Configuration;
13. import java.util.Arrays;
15. // 使用  配置类的方式注入，servlet，和 Listener监听器，filter过滤器
17. /*
18. * @Configuration(proxyBeanMethods = true)
19. * @Configuration 表示是一个配置类
20. * proxyBeanMethods = true 默认是单例返回 bean(保证每个 @bean 方法被调用多少次，都是同一个)
22. */
23. @Configuration(proxyBeanMethods = true)
24. public class RegisterConfig_ {
27.     // 以使用RegistrationBean 方式
28.     // 注入 Servlet
29.     // 注意：要加上 Bean 对象
30.     //@Bean(name = "Servlet_") // bean 没有指明name的话，默认是以方法名作为 name/id
31.     @Bean
32.     public ServletRegistrationBean servlet2() {
33.         // 创建原生的 Servlet 对象（就是我们自己创建的 Servlet）
34.         Servlet_ servlet_ = new Servlet_();
36.         // 把 Servlet_ 对象 关联到 ServletRegistrationBean 对象
37.         // "/servlet03" 就是注入Servlet的url-pattern
38.         return new ServletRegistrationBean(servlet_, "/servlet03");
39.     }
41. }

复制代码

1. package com.rainbowsea.springboot.servlet;
4. import javax.servlet.ServletException;
5. import javax.servlet.annotation.WebServlet;
6. import javax.servlet.http.HttpServlet;
7. import javax.servlet.http.HttpServletRequest;
8. import javax.servlet.http.HttpServletResponse;
9. import java.io.IOException;
13. public class Servlet_ extends HttpServlet {
15.     @Override
16.     protected void doGet(HttpServletRequest request, HttpServletResponse response
17.     ) throws ServletException,
18.             IOException {
19.         // 在前端显示打印显示一些信息。
20.         response.getWriter().write("hello , Servlet_!");
22.     }
23. }

复制代码

留意需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

1. package com.rainbowsea.springboot;
4. import org.springframework.boot.SpringApplication;
5. import org.springframework.boot.autoconfigure.SpringBootApplication;
6. import org.springframework.boot.web.servlet.ServletComponentScan;
7. import org.springframework.context.ConfigurableApplicationContext;
10. @SpringBootApplication // 项目启动标志
11. @ServletComponentScan(basePackages = {"com.rainbowsea.springboot"})
12. public class Application {
14.     public static void main(String[] args) {
15.         ConfigurableApplicationContext ioc = SpringApplication.run(Application.class, args);
16.         //ioc.stop();  // 停止容器
18.         System.out.println("hello");
19.     }
20. }

复制代码

运行测试：

3.2 使用 RegistrationBean 方式注入 Filter

1. package com.rainbowsea.springboot.config;
4. import com.rainbowsea.springboot.servlet.Filter_;
5. import com.rainbowsea.springboot.servlet.Listener_;
6. import com.rainbowsea.springboot.servlet.Servlet_;
7. import org.springframework.boot.web.servlet.FilterRegistrationBean;
8. import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
9. import org.springframework.boot.web.servlet.ServletRegistrationBean;
10. import org.springframework.context.annotation.Bean;
11. import org.springframework.context.annotation.Configuration;
13. import java.util.Arrays;
15. // 使用  配置类的方式注入，servlet，和 Listener监听器，filter过滤器
17. /*
18. * @Configuration(proxyBeanMethods = true)
19. * @Configuration 表示是一个配置类
20. * proxyBeanMethods = true 默认是单例返回 bean(保证每个 @bean 方法被调用多少次，都是同一个)
22. */
23. @Configuration(proxyBeanMethods = true)
24. public class RegisterConfig_ {
27.     // 注入 Filter
28.     // 注意：要加上 Bean 对象
29.     @Bean(name = "Filter_")
30.     public FilterRegistrationBean filter2() {
31.         // 创建原生的 Filter_ 对象（就是我们自己创建的 Filter_）
32.         Filter_ filter_ = new Filter_();
33.         FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(filter_);
34.         // 设置 filter 的 url-pattern
35.         // Arrays.asList("/css/*","images/*") 将字符串，转换为 集合
36.         // 注意：不要漏 "/" 开头了。
37.         filterRegistrationBean.setUrlPatterns(Arrays.asList("/css/*", "/images/*"));
39.         return filterRegistrationBean;
40.     }
43. }

复制代码

1. package com.rainbowsea.springboot.servlet;
4. import lombok.extern.slf4j.Slf4j;
6. import javax.servlet.Filter;
7. import javax.servlet.FilterChain;
8. import javax.servlet.FilterConfig;
9. import javax.servlet.ServletException;
10. import javax.servlet.ServletRequest;
11. import javax.servlet.ServletResponse;
12. import javax.servlet.annotation.WebFilter;
13. import javax.servlet.http.HttpServletRequest;
14. import java.io.IOException;
17. @Slf4j
18. public class Filter_ implements Filter {
19.     @Override
20.     public void init(FilterConfig filterConfig) throws ServletException {
21.         log.info("--Filter_ init0--");
22.     }
24.     @Override
25.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
26.         log.info("Filter - doFitler");
27.         // 为了方便观察过滤器处理的资源，我们输出一个url
28.         HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
29.         log.info("过滤器处理的 url={}",httpServletRequest.getRequestURI());
31.         // 我们直接放行,实际开发中，根据自己的业务来决定如何处理
32.         filterChain.doFilter(servletRequest, servletResponse);
33.     }
35.     @Override
36.     public void destroy() {
37.         log.info("Filter -destory");
38.     }
39. }

复制代码

同样留意：需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

运行测试：

3.3 使用 RegistrationBean 方式注入 Listener

1. package com.rainbowsea.springboot.config;
4. import com.rainbowsea.springboot.servlet.Filter_;
5. import com.rainbowsea.springboot.servlet.Listener_;
6. import com.rainbowsea.springboot.servlet.Servlet_;
7. import org.springframework.boot.web.servlet.FilterRegistrationBean;
8. import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
9. import org.springframework.boot.web.servlet.ServletRegistrationBean;
10. import org.springframework.context.annotation.Bean;
11. import org.springframework.context.annotation.Configuration;
13. import java.util.Arrays;
15. // 使用  配置类的方式注入，servlet，和 Listener监听器，filter过滤器
17. /*
18. * @Configuration(proxyBeanMethods = true)
19. * @Configuration 表示是一个配置类
20. * proxyBeanMethods = true 默认是单例返回 bean(保证每个 @bean 方法被调用多少次，都是同一个)
22. */
23. @Configuration(proxyBeanMethods = true)
24. public class RegisterConfig_ {
26.    
27.     // 注入: Listener
28.     //@Bean(name = "Listener_")
29.     @Bean
30.     public ServletListenerRegistrationBean Listener2() {
31. // 创建原生的 Listener_ 对象（就是我们自己创建的 Listener_）
32.         Listener_ listener_ = new Listener_();
34.         return new ServletListenerRegistrationBean(listener_);
36.     }
37. }

复制代码

1. package com.rainbowsea.springboot.servlet;
3. import lombok.extern.slf4j.Slf4j;
5. import javax.servlet.ServletContextEvent;
6. import javax.servlet.ServletContextListener;
7. import javax.servlet.annotation.WebListener;
9. // 注入监听器(@WebListener + @ServletComponentScan(basePackages = {"com.rainbowsea.springboot"}))
10. @Slf4j
11. @WebListener
12. public class Listener_ implements ServletContextListener {
13.     @Override
14.     public void contextInitialized(ServletContextEvent sce) {
15.         // 这里可以加入项目初始化的相关业务代码
16.         log.info("Listener_ contextInitialized 项目初始化OK~");
17.     }
19.     @Override
20.     public void contextDestroyed(ServletContextEvent sce) {
21.         // 这里可以加入相应代码...
22.         log.info("Listener_ contextInitialized 项目销毁OK~");
23.     }
24. }

复制代码

同样留意：需要在对应项目标场景启动器的位置，使用@ServletComponentScan 注解，在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。

运行测试：

4. 留意事项和细节说明

请求 (自己所编写的)Servlet 时，为什么不会到达拦截器 。

请求 Servlet 时，不会到达 DispatherServlet,因此也不会到达拦截器
缘故起因分析:
注入的Servlet会存在Spring容器
DispatherServlet也存在Spring 容器
多个Servlet容器能处理到同一层拦截，精确优先原则/最长前缀匹配原则
所以当请求 /servlet01 时，就会直接匹配到注入的servlet
简朴的说：就是当你 servlet之间跳转通信的时候，是先找同一层的servlet，如果你同一层的
servlet有你所需要的映射的请求路径，那么优先跳转到servlet上，而不走 拦截器了，因为拦截器是在介于 servlet 和 Controller 控制器之间的。
大家可以回忆一下：我们讲过的 Tomcat 在对 Servlet url 匹配的原则，多个servlet都能处理到同一层路径，精确优先原则/最长前缀匹配原则
在Spring Boot 中，去调用@Controller 目标方法，是按照 DispatherServlet 分发匹配的机制，请同学们回顾一下，我们自己实现Spring MVC 的底层机制的程序。

5. 总结：

• 第一种方式：使用注解方式注入Servlet，Filter，Listener：
  
  
  
  • 使用（@WebServlet + @ServletComponentScan ） 这两个注解方式注入 Servlet
    
  • 使用（@WebFilter+ @ServletComponentScan ） 这两个注解方式注入 Filter
    
  • 使用（@WebListener+ @ServletComponentScan ） 这两个注解方式注入 Servlet
    
  
  
• 第二种方式：使用 RegistrationBean 方式注入 Servlet，Filter，Listener 。
  
• 留意：无论是第一种方式照旧第二种方式，都必须在对应项目标场景启动器的位置上，使用上： @ServletComponentScan注解。在该注解的 basePackages 属性指明要让 Spring Boot扫描到的包的路径。让 Spring Boot可以找到你想让它注入的 ioc 容器当中的类。
  
  
  
  

6. 最后：

“在这个最后的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上汲取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4