Springboot打包放到Tomcat中报错 One or more listener fail to start

小半 • 2023年2月7日下午5:39 • 技术随笔 • 阅读 210

1.问题：

Springboot项目直接启动不报错，打war包放到外部容器Tomcat、东方通上，在@Weblistener注解的监听器类中报错
One or more listener fail to start
具体报错是在类构造器中，调用@Service注解的类的实例时，发生空指针异常

2.原代码：

private final XxxService xxxService;
public XxxListener(XxxService xxxService){
    this.xxxService = xxxService;
}
@Override
public void contextInitialized(ServletContextEvent arg0) {
	xxxService.xxxMethod(arg0); 
}

3.错误原因：

项目启动时类加载顺序问题，XxxListener构造器获取XxxService实现类的实例失败。

程序启动时会加载web.xml文件，加载顺序是context-param->listener->filter->servlet，
Spring在servlet阶段才会扫描@Controller和@Service等注解的类，
contextInitialized为servletContextListener的实现方法，在servlet之前就执行了，找不到service实例，因为此时Spring还没开始扫描和装载service。

4.解决

1.去掉构造器中赋引用的逻辑，避免启动时就先走构造器获取对象实例
2.注入方式改为如下代码，避免final使得在类加载时就初始化bean

private XxxService xxxService;

3.contextInitialized中，显式地获得 ApplicationContext 来得到由 Spring 进行管理的某些 Bean

xxxService = WebApplicationContextUtils.getWebApplicationContext(arg0.getServletContext()).getBean(XxxService.class);

5.新代码：

private XxxService xxxService;
@Override
public void contextInitialized(ServletContextEvent arg0) {
    xxxService = WebApplicationContextUtils.getWebApplicationContext(arg0.getServletContext()).getBean(XxxService.class);
    xxxService.xxxMethod(arg0); 
}