ContextLoaderListener和ContextLoaderPlugIn

亦凉 2022-06-18 06:48 203阅读 0赞

今天有一个朋友问了我一个问题，他使用的是Hibernate/Spring/Struts架构，配置使用Spring的OpenSessionInView Filter，但是发现不生效，lazy的集合属性在页面访问的时候仍然报session已经关闭的错误。我和他一起检查了所有的配置和相关的代码，但是没有发现任何问题。经过调试发现，应用程序使用的Session和OpenSessionInView Filter打开的Session不是同一个，所以OpenSessionInView模式没有生效，但是为什么他们不使用同一个Session呢？  
  
检查了一遍Spring的相关源代码，发现了问题的根源：  
  
通常在Web应用中初始化Spring的配置，我们会在web.xml里面配置一个Listener，即：

Xml代码

1.  **<listener>**  
2.      **<listener-class>**org.springframework.web.context.ContextLoaderListener**</listener-class>**  
3.  **</listener>**

<listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener>

如果使用Struts，那么需要在Struts的配置文件struts-config.xml里面配置一个Spring的plugin：ContextLoaderPlugIn。  
  
实际上ContextLoaderListener和ContextLoaderPlugIn的功能是重叠的，他们都是进行Spring配置的初始化工作的。因此，如果你不打算使用OpenSessionInView，那么你并不需要在web.xml里面配置ContextLoaderListener。  
  
好了，但是你现在既需要Struts集成Spring，又需要OpenSessionInView模式，问题就来了！  
  
由于ContextLoaderListener和ContextLoaderPlugIn功能重叠，都是初始化Spring，你不应该进行两次初始化，所以你不应该同时使用这两者，只能选择一个，因为你现在需要集成Struts，所以你只能使用ContextLoaderPlugIn。  
  
但是令人困惑的是，ContextLoaderListener和ContextLoaderPlugIn有一个非常矛盾的地方！  
  
ContextLoaderListener初始化spring配置，然后把它放在ServletContext对象里面保存：

Java代码 ![复制代码][icon_copy.gif]

1.  servletContext.setAttribute(   
2.                      WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE, **this**.context);;

servletContext.setAttribute( WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);;

请注意，保存的对象的key是WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE！  
  
但是ContextLoaderPlugIn初始化spring配置，然后把它放在ServletContext对象里面保存：

Java代码 ![复制代码][icon_copy.gif]

1.  String attrName = getServletContextAttributeName();;   
2.  getServletContext();.setAttribute(attrName, wac);;

String attrName = getServletContextAttributeName();; getServletContext();.setAttribute(attrName, wac);;

这个attrName和WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE名字是不一样的！  
  
如果仅仅是名字不一样，问题还不大，你仍然可以放心使用ContextLoaderPlugIn，但是当你使用OpenSessionInView的时候，OpenSessionInViewFilter是使用哪个key取得spring配置的呢？

Java代码 ![复制代码][icon_copy.gif]

1.  WebApplicationContext wac =   
2.                  WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext(););;

WebApplicationContext wac = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext(););;

显然，OpenSessionInViewFilter是按照WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE这个key去拿spring配置的！  
  
我们整理一下思路：  
  
ContextLoaderPlugIn保存spring配置的名字叫做attrName；  
，ContextLoaderListener保存spring配置的名字叫做WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE；  
而OpenSessionInView是按照WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE这个名字去取得spring配置的！  
而你的应用程序却是按照attrName去取得spring的配置的！  
  
所以，OpenSessionInView模式失效！  
  
解决办法：  
修改ContextLoaderPlugIn代码，在getServletContext().setAttribute(attrName, wac);这个地方加上一行代码：  
getServletContext().setAttribute(WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE, wac);  
  
或者修改OpenSessionInViewFilter，让它按照attrName去取得spring配置。

[icon_copy.gif]: http://www.javaeye.com/images/icon_copy.gif