OpenSessionInViewFilter原理以及为什么要用OpenSessionInViewFilter

文章转载地址：http://hi.baidu.com/accpandsvse/blog/item/7e167783f271e8ab0cf4d297.html

OpenSessionInViewFilter原理以及为什么要用OpenSessionInViewFilter


struts2 里面OpenSessionInViewFilter
一定要写在最上面 下面有讲解
---------------------------------------------------------------
1、说说为什么使用lazy
当使用Hibernate中的one-to-many、many-to one、many-to-many关系映射的时候，一个对象中会包含一个或多个Set来关联其他的对象。例如：user-groups，当程序取user 对象时，如果一个用户有多个自定义组，那么程序将把组的信息也读取出来，在log中可以看到两个sql的输出。但是在页面的显示上，也许并不需要显示这个用户相关组的信息，这样系统的消耗就白白浪费了，于是hibernate提供了lazy（延迟加载）的方法来避免这一情况的发生，我们只需要在 user.hbm.xml中设置lazy=true，就能实现延迟加载。
代码

<set name="groupses" table="usergroups" catalog="many" cascade="save-update" lazy="true"> 
            <key>  
                <column name="userid" length="32" not-null="true" />  
            </key>  
            <many-to-many entity-name="com.example.model.Groups">  
                <column name="groupid" length="32" not-null="true" />  
            </many-to-many>  
        </set> 

2、说说为什么使用OpenSessionInView
当hibernate+spring配合使用的时候，如果设置了lazy=true,那么在读取数据的时候，当读取了父数据后，hibernate会自动关闭session，这样，当要使用子数据的时候，系统会抛出lazyinit的错误，这时就需要使用spring提供的 OpenSessionInViewFilter,
OpenSessionInViewFilter主要是保持Session状态知道request将全部页面发送到客户端，这样就可以解决延迟加载带来的问题
3、说说Webwork中使用OpenSessionInView的注意事项
web.xml中的配置要注意先后顺序，OpenSessionInViewFilter要在struts2的filter前面，（这个是为什么呢？）否则系统会报错。
代码

<filter>  
        <filter-name>opensession</filter-name>  
        <filter-class>  
              org.springframework.orm.hibernate3.support.OpenSessionInViewFilter  
        </filter-class>  
        <init-param>  
            <param-name>singleSession</param-name>  
            <param-value>true</param-value>  
        </init-param>  
        <init-param>  
            <param-name>sessionFactoryBeanName</param-name>  
            <param-value>mySessionFactory</param-value>    
        </init-param>  
    </filter>  
        
    <filter>  
        <filter-name>webwork</filter-name>  
        <filter-class>com.opensymphony.webwork.dispatcher.FilterDispatcher</filter-class> 
    </filter>  
         <filter-mapping>  
      <filter-name>opensession</filter-name>  
      <url-pattern>/*</url-pattern>    
    </filter-mapping>  
    <filter-mapping>  
        <filter-name>webwork</filter-name>  
        <url-pattern>/*</url-pattern>  
    </filter-mapping> 

对于OpenSessionInView的配置中，singleSession应该设置为true（在哪儿设置呢？），表示一个request只能打开一个 session，如果设置为false的话，session可以被打开多个，这时在update、delete的时候会出现打开多个session的异常。
用了OpenSessionInView的缺点：
但是当设置为true的时候，系统的性能会因为用户的网络状况受到影响，当request在生成页面完成后，session才会被释放，所以如果用户的网络状况比较差，那么连接池中的链接会迟迟不被回收，造成内存增加，系统性能受损。但是如果不用这种方法的话，lazy模式有体现不出它的优点，用？不用？两难啊


//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
在没有使用Spring提供的Open Session In View情况下，因需要在service(or Dao)层里把session关闭，所以lazy loading 为true的话，要在应用层内把关系集合都初始化，如 company.getEmployees()，否则Hibernate抛session already closed Exception;    Open Session In View提供了一种简便的方法，较好地解决了lazy loading问题.
    它有两种配置方式OpenSessionInViewInterceptor和OpenSessionInViewFilter(具体参看SpringSide)，功能相同，只是一个在web.xml配置，另一个在application.xml配置而已。
    OpenSessionInView在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 {
　TransactionSynchronizationManager.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是个双刃剑，放在公网上内容多流量大的网站请慎用。


////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
由于OpenSessionInViewFilter把session绑在当前线程上，导致session的生命周期比事务要长，这期间所有事务性操作都在复用这同一个session，由此产生了一些“怪问题”：
1.出现如下错误：
     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 在把session绑在当前线程上的时候,会把session的flush mode 设为FlushMode.NEVER，因此，如果某个方法没有事务或者有只读事务，则不能对session做insert,update,delete操作，除非事先把session的flush mode手动设为auto
方案：
1、将singleSession设为false，这样只要改 web.xml，缺点是Hibernate Session的Instance可能会大增，使用的JDBC Connection量也会大增，如果Connection Pool的maxPoolSize设得太小，很容易就出问题。<!-- singleSession默认为true,若设为false则等于没用OpenSessionInView -->
2、在控制器中自行管理Session的FlushMode，麻烦的是每个有Modify的Method都要多几行程式
session.setFlushMode(FlushMode.AUTO);
session.update(user);
session.flush();
3、Extend OpenSessionInViewFilter，Override protected Session getSession(SessionFactory sessionFactory)，将FlushMode直接改为Auto。
4、让方法受Spring的事务控制（service和配置文件对应）