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

淡淡的烟草味﹌ 2023-10-08 22:56 41阅读 0赞

现象：

![8fafd959987a4bbca9e612b79be1a50d.png][]

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

![80ba3b7875374c2bbfb514229bc7d735.png][]

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

![36eabaa04d1e4c8ea2312bff72f19659.png][]

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

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

[https://stackoverflow.com/questions/18499081/webapplicationinitializer-container-addservlet-returns-null][https_stackoverflow.com_questions_18499081_webapplicationinitializer-container-addservlet-returns-null]  
[https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html][https_docs.oracle.com_javaee_7_api_javax_servlet_ServletContext.html]

![f12ef99d23de4067979defde81062d01.png][]

![fe5861f85b174b0996ce0ae96595baf5.png][]

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方法的打点日志语句被执行了两次

![c3b3ba1e24754f67842375f5b80753f9.png][]

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

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

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

context.addLifecycleListener(new ContextConfig());

![f409145e02b54f759da5471fb970ec47.png][]

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

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

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

**[深度解析Tomcat启动过程中StandardContext绑定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**

![5828bdb1a77340ed9c6c152035f22b40.png][]

![be6b40bca05a422db3aa314d54bd2bdd.png][]

![4600f11e4bcf47a78a66b60b2d988242.png][]

![9a5372e3c39c4f9dab6332a69994ecde.png][]

![eb95db3359fd489480e762bfdd5df5d0.png][]

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

![9fd1805dbf28430b89a35b00bf83c438.png][]

![383d5e5a603146638a723d2876cd3498.png][]

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

![a36adc51c3034b699a941f96c8e11416.png][]

![a4d1a1f4b6954cbe80276a4a3820c7de.png][]

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

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

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

![7a69312edde74372a8bf3939dd470930.png][]

![59242b3468114216808e170794e35f71.png][]![fad0d27a5d5c4e8ca35b8fc063595269.png][]

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

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

![4792172938094946833327105ef1d69a.png][]

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

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

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

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

[8fafd959987a4bbca9e612b79be1a50d.png]: https://img-blog.csdnimg.cn/8fafd959987a4bbca9e612b79be1a50d.png
[80ba3b7875374c2bbfb514229bc7d735.png]: https://img-blog.csdnimg.cn/80ba3b7875374c2bbfb514229bc7d735.png
[36eabaa04d1e4c8ea2312bff72f19659.png]: https://img-blog.csdnimg.cn/36eabaa04d1e4c8ea2312bff72f19659.png
[https_stackoverflow.com_questions_18499081_webapplicationinitializer-container-addservlet-returns-null]: https://stackoverflow.com/questions/18499081/webapplicationinitializer-container-addservlet-returns-null
[https_docs.oracle.com_javaee_7_api_javax_servlet_ServletContext.html]: https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html
[f12ef99d23de4067979defde81062d01.png]: https://img-blog.csdnimg.cn/f12ef99d23de4067979defde81062d01.png
[fe5861f85b174b0996ce0ae96595baf5.png]: https://img-blog.csdnimg.cn/fe5861f85b174b0996ce0ae96595baf5.png
[c3b3ba1e24754f67842375f5b80753f9.png]: https://img-blog.csdnimg.cn/c3b3ba1e24754f67842375f5b80753f9.png
[f409145e02b54f759da5471fb970ec47.png]: https://img-blog.csdnimg.cn/f409145e02b54f759da5471fb970ec47.png
[Tomcat_StandardContext_ContextConfig]: https://blog.csdn.net/jiaohuizhuang6019/article/details/129736253
[5828bdb1a77340ed9c6c152035f22b40.png]: https://img-blog.csdnimg.cn/5828bdb1a77340ed9c6c152035f22b40.png
[be6b40bca05a422db3aa314d54bd2bdd.png]: https://img-blog.csdnimg.cn/be6b40bca05a422db3aa314d54bd2bdd.png
[4600f11e4bcf47a78a66b60b2d988242.png]: https://img-blog.csdnimg.cn/4600f11e4bcf47a78a66b60b2d988242.png
[9a5372e3c39c4f9dab6332a69994ecde.png]: https://img-blog.csdnimg.cn/9a5372e3c39c4f9dab6332a69994ecde.png
[eb95db3359fd489480e762bfdd5df5d0.png]: https://img-blog.csdnimg.cn/eb95db3359fd489480e762bfdd5df5d0.png
[9fd1805dbf28430b89a35b00bf83c438.png]: https://img-blog.csdnimg.cn/9fd1805dbf28430b89a35b00bf83c438.png
[383d5e5a603146638a723d2876cd3498.png]: https://img-blog.csdnimg.cn/383d5e5a603146638a723d2876cd3498.png
[a36adc51c3034b699a941f96c8e11416.png]: https://img-blog.csdnimg.cn/a36adc51c3034b699a941f96c8e11416.png
[a4d1a1f4b6954cbe80276a4a3820c7de.png]: https://img-blog.csdnimg.cn/a4d1a1f4b6954cbe80276a4a3820c7de.png
[7a69312edde74372a8bf3939dd470930.png]: https://img-blog.csdnimg.cn/7a69312edde74372a8bf3939dd470930.png
[59242b3468114216808e170794e35f71.png]: https://img-blog.csdnimg.cn/59242b3468114216808e170794e35f71.png
[fad0d27a5d5c4e8ca35b8fc063595269.png]: https://img-blog.csdnimg.cn/fad0d27a5d5c4e8ca35b8fc063595269.png
[4792172938094946833327105ef1d69a.png]: https://img-blog.csdnimg.cn/4792172938094946833327105ef1d69a.png