OpenSessionInViewFilter作用及配置

一、作用 
Spring为我们解决Hibernate的Session的关闭与开启问题。 
Hibernate 允许对关联对象、属性进行延迟加载，但是必须保证延迟加载的操作限于同一个 Hibernate Session 范围之内进行。如果 Service 层返回一个启用了延迟加载功能的领域对象给 Web 层，当 Web 层访问到那些需要延迟加载的数据时，由于加载领域对象的 Hibernate Session 已经关闭，这些导致延迟加载数据的访问异常 

(eg： org.hibernate.LazyInitializationException:(LazyInitializationException.java:42) 
– failed to lazily initialize a collection of role: cn.easyjava.bean.product.ProductType.childtypes, no session or session was closed 
org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: cn.easyjava.bean.product.ProductType.childtypes, no session or session was closed) 

用来把一个Hibernate Session和一次完整的请求过程对应的线程相绑定。目的是为了实现"Open Session in View"的模式。例如： 它允许在事务提交之后延迟加载显示所需要的对象。 

而Spring为我们提供的OpenSessionInViewFilter过滤器为我们很好的解决了这个问题。OpenSessionInViewFilter的主要功能是用来把一个Hibernate Session和一次完整的请求过程对应的线程相绑定。目的是为了实现"Open Session in View"的模式。例如： 它允许在事务提交之后延迟加载显示所需要的对象。 
OpenSessionInViewFilter 过滤器将 Hibernate Session 绑定到请求线程中，它将自动被 Spring 的事务管理器探测到。所以 OpenSessionInViewFilter 适用于 Service 层使用HibernateTransactionManager 或 JtaTransactionManager 进行事务管理的环境，也可以用于非事务只读的数据操作中。 

二、配置 
它有两种配置方式OpenSessionInViewInterceptor和OpenSessionInViewFilter(具体参看SpringSide)，功能相同，只是一个在web.xml配置，另一个在application.xml配置而已。 

Open Session In View在request把session绑定到当前thread期间一直保持hibernate session在open状态，使session在request的整个期间都可以使用，如在View层里PO也可以lazy loading数据，如 ${ company.employees }。当View 层逻辑完成后，才会通过Filter的doFilter方法或Interceptor的postHandle方法自动关闭session。 

OpenSessionInViewInterceptor配置 

<beans>
	<bean name="openSessionInViewInterceptor"
		class="org.springframework.orm.hibernate3.support.OpenSessionInViewInterceptor">
		<property name="sessionFactory">
			<ref bean="sessionFactory" />
		</property>
	</bean>
	<bean id="urlMapping"
		class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
		<property name="interceptors">
			<list>
				<ref bean="openSessionInViewInterceptor" />
			</list>
		</property>
		<property name="mappings"> ...     </property>
	</bean>
	...
</beans>  

 

OpenSessionInViewFilter配置 

<web-app>
	...
	<filter>
		<filter-name>hibernateFilter</filter-name>
		<filter-class>
			org.springframework.orm.hibernate3.support.OpenSessionInViewFilter
		</filter-class>     <!-- singleSession默认为true,若设为false则等于没用OpenSessionInView -->
		<init-param>
			<param-name>singleSession</param-name>
			<param-value>true</param-value>
		</init-param>
	</filter>
	...
	<filter-mapping>
		<filter-name>hibernateFilter</filter-name>
		<url-pattern>*.do</url-pattern>
	</filter-mapping>
	...
</web-app> 

 

三、注意事项 
很多人在使用OpenSessionInView过程中提及一个错误： 

org.springframework.dao.InvalidDataAccessApiUsageException: Write operations are not allowed in read-only mode (FlushMode.NEVER) – turn your Session into FlushMode.AUTO or remove ‘readOnly’ marker from transaction definition 

看看OpenSessionInViewFilter里的几个方法 

protected void doFilterInternal(HttpServletRequest request，HttpServletResponse response,FilterChain filterChain) throws ServletException, IOException {     
		SessionFactory sessionFactory = lookupSessionFactory(); 
		logger.debug("Opening Hibernate Session in OpenSessionInViewFilter");  
		Session session = getSession(sessionFactory);
		TransactionSynchronizationManager.bindResource(sessionFactory, new SessionHolder(session));
		try {     
			filterChain.doFilter(request, response);    
		}   
		finally {  
			ransactionSynchronizationManager.unbindResource(sessionFactory);    
			logger.debug("Closing Hibernate Session in OpenSessionInViewFilter");   
			closeSession(session, sessionFactory);
		}     
	}	
	protected Session getSession(SessionFactory sessionFactory) throws DataAccessResourceFailureException {   
		Session session = SessionFactoryUtils.getSession(sessionFactory, true);
		session.setFlushMode(FlushMode.NEVER);   
		return session;   
	}
	protected void closeSession(Session session, SessionFactory sessionFactory) throws CleanupFailureDataAccessException {
		SessionFactoryUtils.closeSessionIfNecessary(session, sessionFactory);    
	}

 

可以看到OpenSessionInViewFilter在getSession的时候,会把获取回来的session的flush mode 设为FlushMode.NEVER。然后把该sessionFactory绑定到 TransactionSynchronizationManager，使request的整个过程都使用同一个session，在请求过后再接除该 sessionFactory的绑定，最后closeSessionIfNecessary根据该 session是否已和transaction绑定来决定是否关闭session。在这个过程中，若HibernateTemplate 发现自当前session有不是readOnly的transaction，就会获取到FlushMode.AUTO Session，使方法拥有写权限。 

public static void closeSessionIfNecessary(Session session, SessionFactory  sessionFactory) throws CleanupFailureDataAccessException {
		if (session == null || TransactionSynchronizationManager.hasResource(sessionFactory)) {
			return;      
		}      
		logger.debug("Closing Hibernate session");
		try {
			session.close();      
		} catch (JDBCException ex) {
			// SQLException underneath     
			throw new CleanupFailureDataAccessException("Could not close Hibernate session", ex.getSQLException());   
			}     
		catch (HibernateException ex) {     
			throw new CleanupFailureDataAccessException("Could not close Hibernate session",  ex);     
			}     
		}      
		}
	}

 

也即是，如果有不是readOnly的transaction就可以由Flush.NEVER转为Flush.AUTO,拥有 insert,update,delete操作权限，如果没有transaction，并且没有另外人为地设flush model的话，则doFilter的整个过程都是Flush.NEVER。所以受transaction保护的方法有写权限，没受保护的则没有。 

采用spring的事务声明,使方法受transaction控制 

<bean id="baseTransaction"
	class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean"
	abstract="true">
	<property name="transactionManager" ref="transactionManager" />
	<property name="proxyTargetClass" value="true" />
	<property name="transactionAttributes">
		<props>
			<prop key="get*">PROPAGATION_REQUIRED,readOnly</prop>
			<prop key="find*">PROPAGATION_REQUIRED,readOnly</prop>
			<prop key="load*">PROPAGATION_REQUIRED,readOnly</prop>
			<prop key="save*">PROPAGATION_REQUIRED</prop>
			<prop key="add*">PROPAGATION_REQUIRED</prop>
			<prop key="update*">PROPAGATION_REQUIRED</prop>
			<prop key="remove*">PROPAGATION_REQUIRED</prop>
		</props>
	</property>
</bean>
<bean id="userService" parent="baseTransaction">
	<property name="target">
		<bean class="com.phopesoft.security.service.impl.UserServiceImpl" />
	</property>
</bean>     

 

对于上例，则以save,add,update,remove开头的方法拥有可写的事务，如果当前有某个方法，如命名为importExcel()，则因没有transaction而没有写权限，这时若方法内有insert,update,delete操作的话，则需要手动设置flush model为Flush.AUTO,如 

session.setFlushMode(FlushMode.AUTO);   
session.save(user);    
session.flush();  

 

尽 管Open Session In View看起来还不错，其实副作用不少。看回上面OpenSessionInViewFilter的doFilterInternal方法代码，这个方法实际上是被父类的doFilter调用的，因此，我们可以大约了解的OpenSessionInViewFilter调用流程:

request(请求)->open session并开始transaction->controller->View(Jsp)->结束transaction并 close session. 

一切看起来很正确，尤其是在本地开发测试的时候没出现问题，但试想下如果流程中的某一步被阻塞的话，那在这期间connection就一直被占用而不释放。最有可能被阻塞的就是在写Jsp这步，一方面可能是页面内容大，response.write的时间长，另一方面可能是网速慢，服务器与用户间传输时间久。当大量这样的情况出现时，就有连接池连接不足，造成页面假死现象。 

Open Session In View是个双刃剑，放在公网上内容多流量大的网站请慎用 

 

转自：http://hi.baidu.com/suofang/blog/item/1e76922ff435c2221f308906.html