【springboot】17、使用/注入Servlet、Filter、Listener

痛定思痛。 2023-09-24 14:19 15阅读 0赞

### 文章目录 ###

*  基本介绍
 *  注解方式注入
 *  使用RegistrationBean 方式注入
 *  总结

# 基本介绍 #

考虑到实际开发业务非常复杂和需要兼容各种组件，SpringBoot 支持将 Servlet、Filter、Listener 注入  
Spring 容器, 成为 Spring bean。

# 注解方式注入 #

我们要想使用Servlet、Filter、Listener，只需要要javaWeb那样使用对应的注解即可，也就是@WebServlet，@WebListener，@WebFilter。示例代码如下

@WebServlet(urlPatterns = "/myServlet")
    public class MyServlet extends HttpServlet {
        
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        
            System.out.println("MyServlet--被访问");
        }
    }

@WebListener
    public class MyListener implements ServletContextListener {
        
        @Override
        public void contextInitialized(ServletContextEvent sce) {
        
            System.out.println("监听器--contextInitialized");
        }
    }

@WebFilter(urlPatterns = "/*")
    public class MyFilter implements Filter {
        
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        
            System.out.println("过滤器--doFilter");
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

如果使用这种方式，那么我们还需要在配置类上添加一个@ServletComponentScan注解，这个注解用于指定扫描原生Servlet组件的路径  
![在这里插入图片描述][3604a6e2c97240e08df1017450e2f6cd.png]

我在启动类上指定了扫描路径  
![在这里插入图片描述][5095be9c82aa44c4a50561d35e555289.png]

启动项目，监听器生效了

![在这里插入图片描述][39b617f2e1b144df91115d804a4129a4.png]

下面访问一下我们自己定义的servlet

![在这里插入图片描述][e9fbb4f9d8e540b88211bcfc7416b303.png]

![在这里插入图片描述][781dd4b69e1246c5b41fbe36e4117610.png]

可以发现Servlet和Filter都生效了，这个就是第一种方式，这种方式注入的组件并不是由springboot来进行管理的，二是由tomcat进行管理，下面介绍第二种方式，这种方式会将原生Web组件注册成为一个bean，并交由springboot进行管理。

# 使用RegistrationBean 方式注入 #

我们先将@ServletComponentScan这个注解注释掉，然后使用RegistrationBean 方式注入。  
![在这里插入图片描述][482aaba3fec048afbda1d85bdf5ae4b8.png]  
我们顺便也把@WebServlet，@WebListener，@WebFilter这些注解给注释掉  
![在这里插入图片描述][4868ec5bf6cb499f98ef8f3b5325e241.png]  
![在这里插入图片描述][26822c4c39634105bcccb16137ce43a3.png]  
![在这里插入图片描述][884b22dee35c40aab0e8935ac83c8dbd.png]  
**我们使用RegistrationBean的方式如下**

@Configuration
    public class OriginalWebConfig {
        
        @Bean
        public ServletRegistrationBean<MyServlet> myServletServletRegistrationBean() {
        
            MyServlet myServlet = new MyServlet();
            return new ServletRegistrationBean<>(myServlet, "/myServlet");
        }
    
        @Bean
        public FilterRegistrationBean<MyFilter> myFilterFilterRegistrationBean() {
        
            MyFilter myFilter = new MyFilter();
            return new FilterRegistrationBean<>(myFilter);
        }
    
        @Bean
        public ServletListenerRegistrationBean<MyListener> myListenerServletListenerRegistrationBean() {
        
            MyListener myListener = new MyListener();
            return new ServletListenerRegistrationBean<>(myListener);
        }
    }

我们只需要在配置类中返回对于的RegistrationBean即可，其中ServletRegistrationBean可以在构造函数中指定路径。下面来启动项目  
![在这里插入图片描述][4a46a827caba4bfe804ba03579127d9a.png]  
监听器没有问题，下面来访问下/myServlet  
![在这里插入图片描述][52f9b3b48f0247c7a61c68e376234128.png]  
![在这里插入图片描述][388a2ceaf46c4872aef12ec823bc77eb.png]

可以发现也没有问题，下面我们就来看一下在spring容器中是否有上面的几个组件，debug一下  
![在这里插入图片描述][85ad1b6a928b4a989f773cf0f818aa16.png]  
在singletonObjects中，我们发现了我们自己写的Listener，有这个，其他的肯定也有，就不在找了，我们通过RegistrationBean就可以注入原生的Web组件，并且交由springboot进行管理

# 总结 #

没啥好说的，对于上面的两种注入原生Web组件的方式，建议使用RegistrationBean的方式进行注入

[3604a6e2c97240e08df1017450e2f6cd.png]: https://img-blog.csdnimg.cn/3604a6e2c97240e08df1017450e2f6cd.png
[5095be9c82aa44c4a50561d35e555289.png]: https://img-blog.csdnimg.cn/5095be9c82aa44c4a50561d35e555289.png
[39b617f2e1b144df91115d804a4129a4.png]: https://img-blog.csdnimg.cn/39b617f2e1b144df91115d804a4129a4.png
[e9fbb4f9d8e540b88211bcfc7416b303.png]: https://img-blog.csdnimg.cn/e9fbb4f9d8e540b88211bcfc7416b303.png
[781dd4b69e1246c5b41fbe36e4117610.png]: https://img-blog.csdnimg.cn/781dd4b69e1246c5b41fbe36e4117610.png
[482aaba3fec048afbda1d85bdf5ae4b8.png]: https://img-blog.csdnimg.cn/482aaba3fec048afbda1d85bdf5ae4b8.png
[4868ec5bf6cb499f98ef8f3b5325e241.png]: https://img-blog.csdnimg.cn/4868ec5bf6cb499f98ef8f3b5325e241.png
[26822c4c39634105bcccb16137ce43a3.png]: https://img-blog.csdnimg.cn/26822c4c39634105bcccb16137ce43a3.png
[884b22dee35c40aab0e8935ac83c8dbd.png]: https://img-blog.csdnimg.cn/884b22dee35c40aab0e8935ac83c8dbd.png
[4a46a827caba4bfe804ba03579127d9a.png]: https://img-blog.csdnimg.cn/4a46a827caba4bfe804ba03579127d9a.png
[52f9b3b48f0247c7a61c68e376234128.png]: https://img-blog.csdnimg.cn/52f9b3b48f0247c7a61c68e376234128.png
[388a2ceaf46c4872aef12ec823bc77eb.png]: https://img-blog.csdnimg.cn/388a2ceaf46c4872aef12ec823bc77eb.png
[85ad1b6a928b4a989f773cf0f818aa16.png]: https://img-blog.csdnimg.cn/85ad1b6a928b4a989f773cf0f818aa16.png