深入OpenSessionInViewFilter内幕

       最近不知道干些什么好,无论做什么都觉得没劲,为了强迫自己学习,准备研究些开源项目的源码,从中找点乐趣,先来个大家熟悉的OpenSessionInViewFilter,下面我将逐步分析OpenSessionInViewFilter 的源码,了解OpenSessionInViewFilter 的原理,欣赏spring优雅的代码,本文只分析源码不做功能介绍,如果有朋友不熟悉OpenSessionInViewFilter,但是又有兴致阅读此文可以先百度或google一下.

Spring中对OpenSessionInViewFilter的描述如下：
     它是一个Servlet2.3过滤器，用来把一个Hibernate Session和一次完整的请求过程对应的线程相绑定。目的是为了实现"Open Session in View"的模式。例如： 它允许在事务提交之后延迟加载显示所需要的对象。
下面从处理请求的入口读起,下面所指的session均为hibernate session不再特别说明,本文观点纯属个人观点如有错误请批评指正不胜感激.

 

OpenSessionInViewFilter 的父类OncePerRequestFilter(抽象类)的方法,是过滤器的入口,是处理请求的第一个方法.

1. public final void doFilter
2. ( ServletRequest request, ServletResponse response, FilterChain filterChain)
3.         throws ServletException, IOException {
4.     //首选判断进行过滤的是否是http请求
5.     if (!(request instanceof HttpServletRequest) || !(response instanceof HttpServletResponse)) {
6.         throw new ServletException("OncePerRequestFilter just supports HTTP requests");
7.     }
8.     //如果是http请求的话进行强转
9.     HttpServletRequest httpRequest = (HttpServletRequest) request;
10.     HttpServletResponse httpResponse = (HttpServletResponse) response;
11.     //alreadyFilteredAttributeName 是一个标识,用于判断是否需要进行OpenSessionInViewFilter
12.     String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName();
13.     if (request.getAttribute(alreadyFilteredAttributeName) != null || shouldNotFilter(httpRequest)) {
14.         // Proceed without invoking this filter...
15.         filterChain.doFilter(request, response);
16.     }
17.     else {
18.         // Do invoke this filter...
19.         request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE);
20.         //下面这个方法是abstract方法由OpenSessionInViewFilter 实现,是OpenSessionInViewFilter 的核心方法
21.         doFilterInternal(httpRequest, httpResponse, filterChain);
22.     }
23. }

好下面让我们进入doFilterInternal一探究竟

1. protected void doFilterInternal(HttpServletRequest request,
2.         HttpServletResponse response, FilterChain filterChain)
3.         throws ServletException, IOException {
4.     /**
5.      * 从spring的上下文中取得SessionFactory对象
6.      * WebApplicationContext wac = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext());
7.      * return (SessionFactory) wac.getBean(getSessionFactoryBeanName(),SessionFactory.class);
8.      * getSessionFactoryBeanName()方法默认返回"sessionFactory"字符串,在spring配置文件中可要注意了,别写错了.
9.      */
10.     SessionFactory sessionFactory = lookupSessionFactory(request);
11.     boolean participate = false;// 标识过滤器结束时是否进行关闭session等后续处理
12.     if (isSingleSession()) {//单session模式
13.         //判断能否在当前线程中取得sessionFactory对象对应的session
14.         if (TransactionSynchronizationManager.hasResource(sessionFactory)) {
15.             //当能够找到session的时候证明会有相关类处理session的收尾工作,这个过滤器不能进行关闭session操作,否则会出现重复关闭的情况.
16.             participate = true;//但我并没有想出正常使用的情况下什么时候会出现这种情况.
17.         } else {
18.             Session session = getSession(sessionFactory);//当前线程取不到session的时候通过sessionFactory创建,下面还会详细介绍此方法
19.             //将session绑定到当前的线程中,SessionHolder是session的一层封装,里面有个存放session的map,而且是线程同步的Collections.synchronizedMap(new HashMap(1));
20.             //但是单session模式下一个SessionHolder对应一个session,核心方法是getValidatedSession 取得一个open状态下的session,并且取出后从map中移出.
21.             TransactionSynchronizationManager.bindResource(sessionFactory,

;                new SessionHolder(session));

        }

    } else {//这段是非单session模式的处理情况,没有研究.但粗略看上去,大概思想是一样的

        if (SessionFactoryUtils.isDeferredCloseActive(sessionFactory)) {

            participate = true;

        } else {

            SessionFactoryUtils.initDeferredClose(sessionFactory);

        }

    }

    try {

        //将session绑定到了当前线程后,就该处理请求了

        filterChain.doFilter(request, response);

    }finally {

        if (!participate) {

            if (isSingleSession()) {

                //当请求结束时,对于单session模式,这时候要取消session的绑定,因为web容器(Tomcat等)的线程是采用线程池机制的,线程使用过后并不会销毁.

                SessionHolder sessionHolder = (SessionHolder) TransactionSynchronizationManager

                        .unbindResource(sessionFactory);

                //取消绑定只是取消session对象和线程对象之间的引用,还没有关闭session,不关闭session相对于不关闭数据库连接,所以这里要关闭session

                closeSession(sessionHolder.getSession(), sessionFactory);

            } else {

                //非单session模式,没有研究.

                SessionFactoryUtils.processDeferredClose(sessionFactory);

            }

        }

    }

}

下面详细介绍TransactionSynchronizationManager的几个关键的方法

1. public abstract class TransactionSynchronizationManager {
2. //线程局部变量,为每一个使用该变量的线程都提供一个变量值的副本,每一个线程都可以独立地改变自己的副本,而不会与其它线程的副本冲突,用于存放session
3. private static final ThreadLocal resources = new ThreadLocal();
4. public static boolean hasResource(Object key) {//判断当前线程是否已经绑定了session,key是sessionFactory对象,一个sessionFactory可以绑定一个session
5.     Assert.notNull(key, "Key must not be null");//spring的Assert类不错,大家可以看看很简单
6.     Map map = (Map) resources.get();
7.     return (map != null && map.containsKey(key));
8. }
9. public static void bindResource(Object key, Object value) throws IllegalStateException {//绑定session到当前线程
10.     Assert.notNull(key, "Key must not be null");
11.     Assert.notNull(value, "Value must not be null");
12.     Map map = (Map) resources.get();//ThreadLocal对象只可以存放一个对象,所以使用map来扩展
13.     if (map == null) {
14.         map = new HashMap();
15.         resources.set(map);
16.     }
17.     if (map.containsKey(key)) {
18.         throw new IllegalStateException("Already value [" + map.get(key) + "] for key [" + key +
19.                 "] bound to thread [" + Thread.currentThread().getName() + "]");
20.     }
21.     map.put(key, value);
22. }
23. static Object unbindResource(Object key) throws IllegalStateException {//取消当前线程对session的绑定
24.     Assert.notNull(key, "Key must not be null");
25.     Map map = (Map) resources.get();
26.     if (map == null || !map.containsKey(key)) {
27.         throw new IllegalStateException(
28.                 "No value for key [" + key + "] bound to thread [" + Thread.currentThread().getName() + "]");
29.     }
30.     Object value = map.remove(key);
31.     if (map.isEmpty()) {
32.         resources.set(null);
33.     }
34.     return value;
35. }
36. 另外一个非常关键的方法是OpenSessionInViewFilter的getSession方法,我们看这个方法的关键并不是如何取得session,而且注意这里设置了FlushMode
37. protected Session getSession(SessionFactory sessionFactory)
38.         throws DataAccessResourceFailureException {
39.     Session session = SessionFactoryUtils.getSession(sessionFactory, true);
40.     FlushMode flushMode = getFlushMode();//默认情况下是FlushMode.NEVER
41.     if (flushMode != null) {
42.         session.setFlushMode(flushMode);
43.     }
44.     return session;
45. }

    读到这个地方,大家对ThreadLocal 感兴趣的话,可以看下我以前写的一篇文章http://blog.csdn.net/sunyujia/archive/2008/06/15/2549564.aspx
    FlushMode.NEVER：
    调用Session的查询方法时，不清理缓存
    调用Session.commit()时，不清理缓存
    调用Session.flush()时，清理缓存
    不过FlushMode.NEVER已经不再建议使用了
    官方描述如下
    Deprecated. use MANUAL instead. 使用FlushMode.MANUAL来代替
    The Session is never flushed unless Session.flush() is explicitly called by the application. This mode is very efficient for read only transactions.
    直到调用Session.flush()才会将变化反应到数据库,在只读的情况下是效率非常高的
    详见http://www.hibernate.org/hib_docs/v3/api/org/hibernate/FlushMode.html
    我们来细看SessionFactoryUtils.getSession(sessionFactory, true);

    
    
    1. public static Session getSession(SessionFactory sessionFactory, boolean allowCreate) throws DataAccessResourceFailureException, IllegalStateException {
    2.     try {
    3.         return doGetSession(sessionFactory, null, null, allowCreate);
    4.     }
    5.     catch (HibernateException ex) {
    6.         throw new DataAccessResourceFailureException("Could not open Hibernate Session", ex);
    7.     }
    8. }

    从上面可以看出doGetSession才是真正的核心方法,这里非常重要的是HibernateTemplate也是调用此方法

    
    
    1. protected Session getSession() {
    2.     if (isAlwaysUseNewSession()) {
    3.         return SessionFactoryUtils.getNewSession(getSessionFactory(), getEntityInterceptor());
    4.     }else if (!isAllowCreate()) {
    5.         return SessionFactoryUtils.getSession(getSessionFactory(), false);
    6.     }else {
    7.         return SessionFactoryUtils.getSession(
    8.                 getSessionFactory(), getEntityInterceptor(), getJdbcExceptionTranslator());
    9.     }
    10. }

    无论如何调用最后都是落实到SessionFactoryUtils.doGetSession这个方法上面,无论这个方法最后是否返回了null实际上在方法中都取得了session,
    这是整个流程中最复杂的一个方法,部分代码我理解的也很不好,大家一起研究研究.

    
    
    1. private static Session doGetSession(
    2.         SessionFactory sessionFactory, Interceptor entityInterceptor,
    3.         SQLExceptionTranslator jdbcExceptionTranslator, boolean allowCreate)
    4.         throws HibernateException, IllegalStateException {
    5.     Assert.notNull(sessionFactory, "No SessionFactory specified");
    6.     //取当前线程绑定
    7. 的session
    8.     SessionHolder sessionHolder = (SessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
    9.     //sessionHolder就可以看成是当前线程绑定的session了
    10.     if (sessionHolder != null && !sessionHolder.isEmpty()) {
    11.         Session session = null;
    12.         if (TransactionSynchronizationManager.isSynchronizationActive() &
    13.                 sessionHolder.doesNotHoldNonDefaultSession()) {//判断spring的事务管理是否是激活的,同时SessionHolder对象中有且仅有一个session
    14.             // Spring transaction management is active ->
    15.             // register pre-bound Session with it for transactional flushing.
    16.             session = sessionHolder.getValidatedSession();
    17.             //在开事务的时候HibernateTransactionManager类中的doBegin方法会将isSynchronizedWithTransaction设置为true,暂时不知道什么情况下会进入如下代码块
    18.             if (session != null && !sessionHolder.isSynchronizedWithTransaction()) {
    19.                 TransactionSynchronizationManager.registerSynchronization(
    20.                         new SpringSessionSynchronization(sessionHolder, sessionFactory, jdbcExceptionTranslator, false));
    21.                 sessionHolder.setSynchronizedWithTransaction(true);
    22.                 // Switch to FlushMode.AUTO, as we have to assume a thread-bound Session
    23.                 // with FlushMode.NEVER, which needs to allow flushing within the transaction.
    24.                 FlushMode flushMode = session.getFlushMode();
    25.                 if (flushMode.lessThan(FlushMode.COMMIT) &
    26.                         !TransactionSynchronizationManager.isCurrentTransactionReadOnly()) {
    27.                     session.setFlushMode(FlushMode.AUTO);
    28.                     sessionHolder.setPreviousFlushMode(flushMode);
    29.                 }
    30.             }
    31.         }
    32.         else {
    33.             // No Spring transaction management active -> try JTA transaction synchronization.
    34.             //在没用事务的情况下下面的方法中只调用了sessionHolder.getValidatedSession();
    35.             session = getJtaSynchronizedSession(sessionHolder, sessionFactory, jdbcExceptionTranslator);
    36.         }
    37.         if (session != null) {
    38.             return session;//在使用了OpenSessionInViewFilter的情况下,HibernateTemplate执行此方法会在这里return
    39.         }
    40.     }
    41.     //如果当前线程没有绑定session那么无论如何都是要创建session的,但是否会return还要取决于allowCreate等条件,在后面会看到
    42.     Session session = (entityInterceptor != null ?
    43.             sessionFactory.openSession(entityInterceptor) : sessionFactory.openSession());
    45.     // Use same Session for further Hibernate actions within the transaction.
    46.     // Thread object will get removed by synchronization at transaction completion.
    47.     //判断spring的事务管理是否是激活的,目前我分析结果是在单session情况下,只有OpenSessionInViewFilter调用此方法,才会执行到这里,这种情况下是不会有事务的.
    48.     //可见下面if块里面的代码是针对非单session,并且有事务的情况处理的.
    49.     if (TransactionSynchronizationManager.isSynchronizationActive())& ;{
    50.         // We're within a Spring-managed transaction, possibly from JtaTransactionManager.
    51.         logger.debug("Registering Spring transaction synchronization for new Hibernate Session");
    52.         SessionHolder holderToUse = sessionHolder;
    53.         if (holderToUse == null) {
    54.             holderToUse = new SessionHolder(session);
    55.         }
    56.         else {
    57.             holderToUse.addSession(session);
    58.         }
    59.         if (TransactionSynchronizationManager.isCurrentTransactionReadOnly()) {
    60.             session.setFlushMode(FlushMode.NEVER);//只读情况下,可以提高效率同时也防止了脏数据等
    61.         }
    62.         TransactionSynchronizationManager.registerSynchronization(
    63.                 new SpringSessionSynchronization(holderToUse, sessionFactory, jdbcExceptionTranslator, true));
    64.         holderToUse.setSynchronizedWithTransaction(true);//这个变量真是很费解不知道什么情况下会为false呢?
    65.         if (holderToUse != sessionHolder) {//从这里可以看出非单session情况下,有事务也是要绑定session的只是颗粒度不同而已,我猜非单session事务结束后session就被关闭了.
    66.             TransactionSynchronizationManager.bindResource(sessionFactory, holderToUse);
    67.         }
    68.     }
    69.     else {
    70.         // No Spring transaction management active -> try JTA transaction synchronization.
    71.         registerJtaSynchronization(session, sessionFactory, jdbcExceptionTranslator, sessionHolder);
    72.     }
    74.     // Check whether we are allowed to return the Session.
    75.     //校验能否创建session的动作居然是放在创建session之后处理的,有点不解.
    76.     if (!allowCreate && !isSessionTransactional(session, sessionFactory)) {
    77.         closeSession(session);
    78.         throw new IllegalStateException("No Hibernate Session bound to thread, " +
    79.             "and configuration does not allow creation of non-transactional one here");
    80.     }
    81.     return session;
    82. }