解决tomcat addServlet方法返回空指针的问题

现象：

断点调试发现返回值registration是有值的：

 但是通过步进跟踪，发现该代码段又重复执行了一次，此时registration返回null：

 此时我还意识到addServlet方法被执行了两次，只是觉得很奇怪：为什么registration第一次有值，第二次怎么会返回空值了呢？

然后在下面的两个链接找到了addServlet返回空值的线索：

https://stackoverflow.com/questions/18499081/webapplicationinitializer-container-addservlet-returns-null
https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html

Returns:

a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for the given servletName

 官方api果然说的很清楚： 如果addServlet时发现有同名servlet，此时就会返回null空值！

也就是说addServlet方法被执行了两次。

可是为什么addServlet方法会执行两次呢

进一步看启动日志，发现WebApplicationInitializer的onStartup方法的打点日志语句被执行了两次

 也就是说onStartup方法被执行了两次，这就是问题的根源了

为什么onStartup方法会被重复执行呢。

最后追踪到tomcat初始化时,发现一处可疑代码：

context.addLifecycleListener(new ContextConfig());

 也就是说我给tomcat上下文额外又增加了一个监听器ContextConfig

ContextConfig触发WebApplicationInitializer onStartup方法的原理如下：

Tomcat启动过程中会给tomcat上下文绑定ContextConfig监听器，具体可以参考我之前的文章：

深度解析Tomcat启动过程中StandardContext绑定ContextConfig监听器的过程

然后 org.apache.catalina.startup.ContextConfig.configureStart() 方法中会触发webConfig（）方法

会在这个方法里调用processServletContainerInitializers()方法

这个方法会通过loader.load方法（实际是WebappServiceLoader类加载器的load方法，这里实际就是Tomcat 的Spi机制, 也是Servlet 3.0规范的要求）查找META-INF/services/路径下ServletContainerInitializer接口的实现类: SpringServletContainerInitializer

 

 

 

 然后把加载到的SpringServletContainerInitializer存到initializerClassMap中:

最后StandardContext会在它的startInternal()方法中会遍历之前存储的那个initializerClassMap（这里就是initializers），并执行SpringServletContainerInitializer的onStarup()方法

 

而SpringServletContainerInitializer执行的时候又会扫描所有WebApplicationInitializer

的实现类或子类 ，然后在SpringServletContainerInitializer的onStartup方法中执行

WebApplicationInitializer的实现类或子类的onStartup方法

 

  

以上就是webApplicationInitializer的onStartup方法被触发的原理。

再回到我们的tomcat初始化代码：

 由于Tomcat启动时本身就会自动给所有Servlet配置一个ContextConfig上下文监听器，而这里额外又增加了一个ContextConfig，所以webApplicationInitializer的onStartup方法必然会被触发两次。

因为ContextConfig是响应事件触发动作的来源，由于监听器重复了，触发的动作也会重复执行。

解决办法：删除context.addLifecycleListener（new ContextConfig(）代码

注意： 不要给tomcat随意增加LifecycleListener监听器，否则容易产生空指针错误！