SpringBoot中使用监听器

SpringBoot监听器的心得

目录

SpringBoot监听器的心得

问题描述

如何将本地和服务器一致，都支持监听器

问题描述

解决方案：

大功告成

总结：

---

问题描述

各位小伙伴大家好，在做SpringBoot项目的时候，如果是像之前Springmvc或者是Servlet中添加监听器会出现一些问题，今天我做一个总结，通过实践得出真谛，接下来看看是不是你也遇见了一样的问题。

在开发SpringBoot项目的时候，我们如果使用监听器的注解@WebListener（javax.servlet.annotation.WebListener）

比如我写了一个Application的监听器如下：

@WebListener
public class ApplicationtListener implements ServletContextListener {

	@Override
	public void contextInitialized(ServletContextEvent sce) {
		System.out.println("监听开始");
	}

	@Override
	public void contextDestroyed(ServletContextEvent sce) {
		System.out.println("监听结束");		
	}

}

1、启动SpringBoot，这个监听是不被识别的；

2、需要在SpringBoot项目的启动类上增加一个注解：@ServletComponentScan

/**
 * @author Johnny
 * @ServletComponentScan 这个注解在独立的Tomcat中不可以使用
 * @category 如果需要使用监听器，过滤器这样servlet，需要使用成bean完成
 * 
 */
@ServletComponentScan
@SpringBootApplication
@MapperScan("com.company.dao")
public class Run {
	
	public static void main(String[] args) {
		SpringApplication.run(Run.class, args);
	}
}

说明一下：@ServletComponentScan这个注解是用来扫描项目中的Servlet注解的。

可以在项目开启的时候，监听器得到触发，结果如下：

 

注意，这并不是这篇博客的重点；

铺垫结束，以上使我们在本地运行的都没有问题的~

但是，一旦单独发布在TOMCAT服务器上，你的这个监听就不行了呢，也就是说，服务器不支持。

就是害怕这种但是对不对，本地运行的好好的，一到服务器就不行，从8.0换成8.5都不行，然后你该怎么办？

往往这时候你会有点慌张：因为你项目本地好好的，到底服务器上哪里出现问题了呢？

给大家一个干货指导，你看日志，看Tomcat给你的日志信息，通过日志你看到是监听器创建失败。这个时候呢，我们就聚焦到监听器的这个地方来。下面说：

如何将本地和服务器一致，都支持监听器

问题描述

在SpringBoot项目里，独立Tomcat服务器出现的问题如下

在本地跑的很正常的程序，在服务器上跑不动，最奇怪的是有些接口能用，有些不能用，经过多方观察、

发现用到：servlet、listener和filter的都挂了。

搜了很多资料之后，还是在spring boot 2.01的文档中找到这么一句话：

Tip
@ServletComponentScan has no effect in a standalone container, where the container’s builtin
discovery mechanisms are used instead.
翻译一下就是@ServletComponentScan这个注解在独立tomcat服务器不可用。

解决方案：

使用@Bean注入的方式

@Component
public class ApplicationtListener implements ServletContextListener {

	@Override
	public void contextInitialized(ServletContextEvent sce) {
		System.out.println("监听开始");
	}

	@Override
	public void contextDestroyed(ServletContextEvent sce) {
		System.out.println("监听结束");		
	}

}

这块使用的注解是@Component

同理，如果你是对Session进行监听，你应该这么写：

/**
 * @author Johnny
 * @category 博客类型监听SpringBoot实现
 * 
 */
@Component
public class SessionListener implements HttpSessionListener{

	@Autowired
	IBlogKindService blogKindService;// 创建业务逻辑对象

	
	@Override
	public void sessionCreated(HttpSessionEvent se) {
		System.out.println("监听器工作：监听session，将所有的博客类型放到作用域中");
		// 将 ApplicationContext 转化为 WebApplicationContext
		HttpSession session = se.getSession();
		// 得到博客类型列表集合
		List<BlogKind> blogKindList = blogKindService.findList();
		// servletContext设置值
		session.setAttribute("blogKindList", blogKindList);
	}

	@Override
	public void sessionDestroyed(HttpSessionEvent se) {
		System.out.println("监听器工作：销毁session");	
	}
}

对于组件当中需要注入其他组件，你就使用@Autowired这个注解就好。

以上代码都亲手验证过的，所以小伙伴可以参考我的这个解决方案。

SpringBoot中监听器的其实是有一个别的推荐的：ApplicationListener（org.springframework.context.ApplicationListener）

如果你要使用Application监听，可以这么做：

/**
 * @author Johnny
 * @category 博客类型监听SpringBoot实现
 * 
 */
@Component
public class BlogKinderListener2 implements ApplicationListener<ApplicationStartedEvent> {

	@Autowired
	IBlogKindService blogKindService;// 创建业务逻辑对象

	@Override
	public void onApplicationEvent(ApplicationStartedEvent event) {
		System.out.println("监听器工作：监听application，将所有的博客类型放到作用域中");
		// 将 ApplicationContext 转化为 WebApplicationContext
		WebApplicationContext webApplicationContext = (WebApplicationContext) event.getApplicationContext();
		// 从 webApplicationContext中获取servletContext
		ServletContext servletContext = webApplicationContext.getServletContext(); 
		List<BlogKind> blogKindList = blogKindService.findList(); // 得到博客类型列表集合
		servletContext.setAttribute("blogKindList", blogKindList);// servletContext设置值
	}
}

最后：在启动类里面去掉了@ServletComponentScan这个注解，本地和独立Tomcat访问都是可以的。

大功告成

总结：

在SpringBoot中，其实这个框架更多的希望你直接使用Spring框架中的注解，同时也为你简化开发的代码：

核心问题：监听器，过滤器其实也都是组件，那么使用这些东西直接当做普通bean一样注入到容器里面就可以。

具体操作：

1. 在“监听器，过滤器”上面注解@Component
2. 实现对应的接口（Application接口，Session接口等）
3. @ServletComponentScan这个注解在独立tomcat服务器不可用

完成。

觉得有点用记得给我点赞哦！

这篇文章就到这里啦，如果觉得有收获的话，不妨给一个赞喔；文章中涉及的内容肯定是不全面的，欢迎大家评论区留言补充。