Play源碼深刻之六：數據庫與事務管理

由前面的文章大體知道，Play的事務由過濾器中處理，這裏理一下Play框架與數據庫相關的部分。 

主要是play.db包中的DBPlugin/DB類，與play.db.jpa包中的JPAPlugin/JPA類有關，前者管理數據源，後者管理JPA。另外由於play是基於ActiveRecord模型，在play.db.jpa.JPAEnhancer類中，play織入了許多輔助方法。 

DBPlugin/JPAPlugin類屬於PlayPlugin子類，在play發出的事件中處理相關操做。由於DBPlugin的index比JPAPlugin的大，因此DBPlugin的事件處理會在JPAPlugin的前面。這裏須要注意play處理順序，在前半部分請求是從0到100000，後半部分響應時是從100000到0處理，因此整個處理過程是0、100、1000、...1000、100、0。

0:play.CorePlugin
100:play.data.parsing.TempFilePlugin
200:play.data.validation.ValidationPlugin
300:play.db.DBPlugin
400:play.db.jpa.JPAPlugin
450:play.db.Evolutions
500:play.i18n.MessagesPlugin
600:play.libs.WS
700:play.jobs.JobsPlugin
100000:play.plugins.ConfigurablePluginDisablingPlugin

從配置文件中加載數據源主要發生在onApplicationStart，並可配置多個數據源。在配置數據源的時候，play會試探性鏈接，用來判斷數據源是否可用。

public class DBPlugin extends PlayPlugin {  
    @Override
    public void onApplicationStart() {
        if (changed()) {
            String dbName = "";
            try {
                ...
                Set dbNames = Configuration.getDbNames();
                Iterator it = dbNames.iterator();
                while(it.hasNext()) {
                    dbName = it.next();
                    ...

                    if (isJndiDatasource || datasourceName.startsWith("java:")) {
                        ... 
                    } else {
                        ...
                        url = ds.getJdbcUrl();
                        Connection c = null;
                        try {
                            c = ds.getConnection();
                        } finally {
                            if (c != null) {
                                c.close();
                            }
                        }
                        Logger.info("Connected to %s for %s", ds.getJdbcUrl(), dbName);
                        DB.datasources.put(dbName, extDs);
                    }
                }
            } catch (Exception e) {
                ...
            }
        }
    }
}

以前寫過一篇基於play 1.2.3的多數據庫文章： 多數據庫切換。 JPAPlugin中，處理邏輯較多。主要集中在下面四個方法：

public class JPAPlugin extends PlayPlugin {
    @Override
    public Object bind(RootParamNode rootParamNode, String name, Class clazz, java.lang.reflect.Type type, Annotation[] annotations) {....}

    @Override
    public void enhance(ApplicationClass applicationClass) throws Exception {...}

    @Override
    public void onApplicationStart() {...}

    @Override
    public Filter getFilter() {...}
}

bind方法，將請求中域對象加入HibernateSession之中。 

enhance方法，爲基於play.db.jpa.JPABase的子Model織入相應輔助代碼。 

onApplicationStart方法，根據數據配置實例工廠。 

getFilter方法，獲取過濾器，這裏就是事務相關的過濾器。 

在play.db.jpa.JPA:withTransaction()方法中，能夠看出，play已經能夠同時管理多個數據庫的事務，在1.2.3版本這是沒有見過。

public class JPA {
    public static  T withTransaction(String dbName, boolean readOnly, F.Function0 block) throws Throwable {
        if (isEnabled()) {
            boolean closeEm = true;
            // For each existing persisence unit
           
            try {
                // we are starting a transaction for all known persistent unit
                // this is probably not the best, but there is no way we can know where to go from
                // at this stage
                for (String name : emfs.keySet()) {
                    EntityManager localEm = JPA.newEntityManager(name);
                    JPA.bindForCurrentThread(name, localEm, readOnly);

                    if (!readOnly) {
                        localEm.getTransaction().begin();
                    }
                }

                T result = block.apply();
              
                boolean rollbackAll = false;
                // Get back our entity managers
                // Because people might have mess up with the current entity managers
                for (JPAContext jpaContext : get().values()) {
                    EntityManager m = jpaContext.entityManager;
                    EntityTransaction localTx = m.getTransaction();
                    // The resource transaction must be in progress in order to determine if it has been marked for rollback
                    if (localTx.isActive() && localTx.getRollbackOnly()) {
                        rollbackAll = true;
                    }
                }

                for (JPAContext jpaContext : get().values()) {
                    EntityManager m = jpaContext.entityManager;
                    boolean ro = jpaContext.readonly;
                    EntityTransaction localTx = m.getTransaction();
                    // transaction must be active to make some rollback or commit
                    if (localTx.isActive()) {
                        if (rollbackAll || ro) {
                            localTx.rollback();
                        } else {
                            localTx.commit();
                        }
                    }
                }
                return result;
            } catch (...) {
                
            } finally {
                ...
            }      
        } else {
            return block.apply();
        }
    }
}

對於每一個數據庫實例逐一開啓事務，處理用戶代碼以後，檢查每一個實例，若是有一個回滾，則全部事務都回滾，若是沒有則逐一提交。 

雖然Play2.x已經橫在前方，可是Play1.x還在演進，我想這是全部Play1.x用戶所指望的。