老規矩,先上案例程式碼,我們按照這個案例一步一步的搞定Mybatis原始碼。
public class MybatisApplication { public static final String URL = "jdbc:mysql://localhost:3306/mblog"; public static final String USER = "root"; public static final String PASSWORD = "123456"; public static void main(String[] args) { String resource = "mybatis-config.xml"; InputStream inputStream = null; SqlSession sqlSession = null; try { inputStream = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); sqlSession = sqlSessionFactory.openSession(); UserMapper userMapper = sqlSession.getMapper(UserMapper.class); System.out.println(userMapper.selectById(1)); } catch (Exception e) { e.printStackTrace(); } finally { try { inputStream.close(); } catch (IOException e) { e.printStackTrace(); } sqlSession.close(); } }
前面我們已經講了Mybatis是如何解析相關配置檔案的,如果怕迷路,還是建議先看前一篇文章:
Mybatis是如何解析配置檔案的?看完終於明白了
由於很多小夥伴在催,說Mybatis原始碼系列好像何時才有下文了,為此老田熬夜寫了這篇。
繼續開擼~~
SqlSession sqlSession = sqlSessionFactory.openSession();
前面那篇文章已經分析了,這裡的sqlSessionFactory其實就是DefaultSqlSessionFactory。
所以這裡,我們就從DefaultSqlSessionFactory裡的openSession方法開始。
public class DefaultSqlSessionFactory implements SqlSessionFactory { private final Configuration configuration; public DefaultSqlSessionFactory(Configuration configuration) { this.configuration = configuration; } //建立session,這個方法直接呼叫本類中的另外一個方法 @Override public SqlSession openSession() { return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false); } //其實是呼叫這個方法 private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) { Transaction tx = null; try { //對應xml標籤<environments> ,這個在配置檔案解析的時候就已經存放到configuration中了。 final Environment environment = configuration.getEnvironment(); final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment); tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit); //建立一個executor來執行SQL final Executor executor = configuration.newExecutor(tx, execType); //這裡也說明了,為什麼我們程式碼裡的SqlSession是DefaultSqlSession return new DefaultSqlSession(configuration, executor, autoCommit); } catch (Exception e) { closeTransaction(tx); // may have fetched a connection so lets call close() throw ExceptionFactory.wrapException("Error opening session. Cause: " + e, e); } finally { ErrorContext.instance().reset(); } } private TransactionFactory getTransactionFactoryFromEnvironment(Environment environment) { if (environment == null || environment.getTransactionFactory() == null) { return new ManagedTransactionFactory(); } return environment.getTransactionFactory(); }
這個方法中的主要內容有:下面我們就來逐個攻破。
建立事務Transaction事務工廠型別可以配置為JDBC型別或者MANAGED型別。
❝
JdbcTransactionFactory生產JdbcTransaction。
ManagedTransactionFactory生產ManagedTransaction。
❞
如果配置的JDBC,則會使用Connection物件的commit()、rollback()、close()方法來管理事務。
如果我們配置的是MANAGED,會把事務交給容器來管理,比如JBOSS,Weblogic。因為我們是本地跑的程式,如果配置成MANAGED就會不有任何事務。
但是,如果我們專案中是Spring整合Mybatis,則沒有必要配置事務,因為我們會直接在applicationContext.xml裡配置資料來源和事務管理器,從而覆蓋Mybatis的配置。
建立執行器Executor呼叫configuration的newExecutor方法建立Executor。
final Executor executor = configuration.newExecutor(tx, execType);//Configuration中public Executor newExecutor(Transaction transaction, ExecutorType executorType) { executorType = executorType == null ? defaultExecutorType : executorType; executorType = executorType == null ? ExecutorType.SIMPLE : executorType; Executor executor; //第一步 if (ExecutorType.BATCH == executorType) { executor = new BatchExecutor(this, transaction); } else if (ExecutorType.REUSE == executorType) { executor = new ReuseExecutor(this, transaction); } else { executor = new SimpleExecutor(this, transaction); } //第二步 if (cacheEnabled) { executor = new CachingExecutor(executor); } //第三步 executor = (Executor) interceptorChain.pluginAll(executor); return executor; }
此方法分三個步驟。
第一步:建立執行器Executor的基本型別有三種:
public enum ExecutorType { SIMPLE, REUSE, BATCH}
SIMPLE為預設型別。
為什麼要讓抽象類BaseExecutor實現Executor介面,然後讓具體實現類繼承抽象類呢?
這就是模板方法模式的實現。
❝
模板方法模式就是定義一個演算法骨架,並允許子類為一個或者多個步驟提供實現。模板方法是得子類可以在不改變演算法結構的情況下,重新定義演算法的某些步驟。
❞
關於模板方法模式推薦閱讀:
如何快速掌握模板方法模式
抽象方法是在子類彙總實現的,每種執行器自己實現自己的邏輯,BaseExecutor最終會呼叫到具體的子類中。
抽象方法protected abstract int doUpdate(MappedStatement ms, Object parameter) throws SQLException;protected abstract List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException;protected abstract <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException;protected abstract <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql) throws SQLException;
第二步:快取裝飾在上面程式碼中的第二步
if (cacheEnabled) { executor = new CachingExecutor(executor);}
如果cacheEnabled=true,會用裝飾器設計模式對Executor進行裝飾。
第三步:外掛代理快取裝飾完後,就會執行
executor = (Executor) interceptorChain.pluginAll(executor);
這裡會對Executor植入外掛邏輯。
比如:分頁外掛中就需要把外掛植入的Executor
好了,到此,執行器建立的就搞定了。
建立DefaultSqlSession物件把前面解析配置檔案建立的Configuration物件和建立的執行器Executor賦給DefaultSqlSession中的屬性。
public DefaultSqlSession(Configuration configuration, Executor executor, boolean autoCommit) { this.configuration = configuration; this.executor = executor; this.dirty = false; this.autoCommit = autoCommit;}
到這裡,SqlSession(DefaultSqlSession)物件就建立完畢。
總結本文我們講了如何建立SqlSession的幾個步驟,最後我們獲得一個DefaultSqlSession物件,裡面包含了執行器Executor和配置物件Configuration。Executor是SQL的實際執行物件。Configuration裡儲存著配置檔案內容。
本文原始碼分析的整個流程如下圖:
碼字不易,點個讚唄