mybatis使用在日常開(kāi)發(fā)中很簡(jiǎn)單，基本沒(méi)有門檻，都是和Spring直接集成，然后把之前的一些配置copy到spring的配置文件中就可以使用。具體mybatis的配置文件加載代碼，已經(jīng)SqlSession執(zhí)行的細(xì)節(jié)都被封裝到了框架中，符合面向?qū)ο缶幊?，但是存在一個(gè)問(wèn)題就是那些細(xì)節(jié)的代碼慢慢都被遺忘。寫這個(gè)博客就是記錄一下，以后忘記可以看看。僅此而已。

Mybatis配置文件的讀取和SqlSessionFactory的構(gòu)建

在mybatis中加載的基本的順序是讀取配置文件，然后構(gòu)建SqlSessionFactory，通過(guò)SqlSessionFactory獲取Session實(shí)例，最后通過(guò)Session實(shí)例獲取到對(duì)應(yīng)Mapper的代理對(duì)象，通過(guò)代理對(duì)象來(lái)調(diào)用CRUD方法執(zhí)行數(shù)據(jù)的操作。

SqlSessionFactory構(gòu)建

public class UserService {

    private static SqlSessionFactory sqlSessionFactory;
    //加載xml文件
    static {
        InputStream inputStream = null;
        try {
            //讀取配置文件
            inputStream = Resources.getResourceAsStream("mybatis-config.xml");
            //構(gòu)建SqlSessionFactory
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //關(guān)閉流
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

先將Mybatis核心配置文件mybatis-config.xml讀取到流中，然后交給SqlSessionFactoryBuilder構(gòu)建SqlSessionFactory對(duì)象，在構(gòu)建前會(huì)對(duì)核心配置文件進(jìn)行一系列的分析，并將分析的內(nèi)容放到Configuration實(shí)例中，分析的過(guò)程之前的博客中有，可以翻一翻參考一下。

到這里是sqlSessionFactory構(gòu)建完成，接下來(lái)看如何使用。

SqlSession、Mapper的獲取以及使用

public void insert() {
    //獲取SqlSession
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //獲取UserMapper
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    UserMode mode = new UserMode();
    mode.setUserName("Joker");
    mode.setUserPhone("15612341234");
    mode.setUserAge(20);
    //調(diào)用插入方法
    mapper.insert(mode);
}

這里實(shí)現(xiàn)的邏輯的方法不難，關(guān)鍵是在于SqlSession和UserMapper的獲取，這里和大家一起看看源碼。

SqlSession獲取源碼

在SqlSessionFactory是個(gè)接口，其實(shí)現(xiàn)是DefaultSqlSessionFactory，在這個(gè)類中有各種獲取SqlSession實(shí)例的方法，根據(jù)上面的實(shí)例代碼，找到openSession方法的實(shí)現(xiàn)。

public SqlSession openSession() {
   /**
   * configuration中獲取默認(rèn)的Executor執(zhí)行器的類型
   * 第二個(gè)參數(shù)是事務(wù)隔離級(jí)別
   * 第三個(gè)參數(shù)表示是否自動(dòng)提交，默認(rèn)值是false
   **/
  return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}

執(zhí)行器Executor類型有多種，如果在mapper.xml文件中沒(méi)有特殊的配置基本使用的都是默認(rèn)的執(zhí)行器SimpleExecutor。事務(wù)隔離級(jí)別和是否自動(dòng)提交都是使用默認(rèn)的值。

進(jìn)入到openSessionFromDataSource方法中后，從上面的傳入?yún)?shù)可以知道，在這個(gè)方法中就是根據(jù)Executor執(zhí)行器的類型創(chuàng)建相對(duì)應(yīng)的實(shí)例，同時(shí)也會(huì)根據(jù)數(shù)據(jù)相關(guān)的參數(shù)構(gòu)建出對(duì)應(yīng)的事務(wù)管理器。待著兩個(gè)實(shí)例構(gòu)建結(jié)束，就會(huì)根據(jù)這兩個(gè)實(shí)例去構(gòu)建最終需要的SqlSession實(shí)例。源碼如下：

/**
 * 構(gòu)建Session
 * @param execType 執(zhí)行器類型
 * @param level 事務(wù)隔離界別
 * @param autoCommit 是否自動(dòng)提交
 * @return
 */
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
        //configuration獲取環(huán)境配置信息
        final Environment environment = configuration.getEnvironment();
        //事務(wù)管理器工廠
        final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
        //創(chuàng)建事務(wù)管理器
        tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
        //創(chuàng)建執(zhí)行器executor
        final Executor executor = configuration.newExecutor(tx, execType);
        //構(gòu)建Session
        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();
    }
}

基本的流程和上面的解釋一樣。至于再深入的代碼就不再詳盡的貼出來(lái)啦(源碼的內(nèi)容太多，入口已提供，可以自己跟進(jìn)去詳細(xì)的了解)，但是下面可以大概的說(shuō)一下。

在mybatis-config.xml核心配置文件中有個(gè)environment標(biāo)簽，這個(gè)標(biāo)簽中會(huì)配置相應(yīng)的數(shù)據(jù)源信息和事務(wù)管理器的信息。在源碼中將這些參數(shù)傳入到事務(wù)管理器工廠中，構(gòu)建工廠對(duì)象TransactionFactory，接著調(diào)用其創(chuàng)建事務(wù)管理器對(duì)象的方法。到這里事務(wù)管理器實(shí)例創(chuàng)建完成。

然后根據(jù)構(gòu)建好的事務(wù)管理器和執(zhí)行器類型去構(gòu)建執(zhí)行器對(duì)象，執(zhí)行器對(duì)象的類型共有三種，從ExecutorType枚舉類中可以看到，分別是是BATCH批處理模式，REUSE復(fù)用模式，SIMPLE簡(jiǎn)單模式。在newExecutor方法中對(duì)執(zhí)行器類型做了判斷，當(dāng)不是批處理或者復(fù)用模式的時(shí)候就默認(rèn)使用簡(jiǎn)單模式，當(dāng)然后面還有對(duì)cacheEnabled的判斷，如果支持緩存，還需要對(duì)上面的SimpleExecutor包裝一層，然后就是對(duì)整個(gè)執(zhí)行鏈的包裝。至此執(zhí)行器構(gòu)建完成。(執(zhí)行器構(gòu)建的過(guò)程使用的是裝飾器模式)

事務(wù)管理器、執(zhí)行器構(gòu)建結(jié)束，使用Configuration、執(zhí)行器和是否自動(dòng)提交參數(shù)，構(gòu)建SqlSession對(duì)象，這個(gè)過(guò)程很簡(jiǎn)單，就是將這些參數(shù)設(shè)置到SqlSession對(duì)象成員變量中。

Mapper獲取源碼

Mapper本身只是一個(gè)接口，在從SqlSession對(duì)象中get獲取對(duì)象的時(shí)候，是使用的動(dòng)態(tài)代理，在mybatis源碼中有一個(gè)模塊叫做binding，在這里面有具體做動(dòng)態(tài)代理的實(shí)現(xiàn)?？丛创a：

public <T> T getMapper(Class<T> type) {
    //通過(guò)configuration構(gòu)建Mapper實(shí)例
    return configuration.<T>getMapper(type, this);
}

在SqlSession中有個(gè)Configuration實(shí)例，通過(guò)這個(gè)實(shí)例使用的getMapper方法構(gòu)建Mapper代理對(duì)象，進(jìn)入后會(huì)調(diào)用MapperRegistry(Mapper注冊(cè)器)，在注冊(cè)器里面會(huì)構(gòu)建MapperProxyFactory工廠類，然后通過(guò)工廠類的newInstance方法構(gòu)建具體的代理對(duì)象MapperProxy。

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    //根據(jù)type到knowMappers中獲取MapperProxyFactory實(shí)例
    final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
    if (mapperProxyFactory == null) {
        throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
    }
    try {
        //mapperProxyFactory生成對(duì)象實(shí)例
        return mapperProxyFactory.newInstance(sqlSession);
    } catch (Exception e) {
        throw new BindingException("Error getting mapper instance. Cause: " + e, e);
    }
}

通過(guò)這里就完成了Mapper代理對(duì)象的創(chuàng)建，并返回。

insert方法調(diào)用

在mapper.xml文件的結(jié)果過(guò)程中，有對(duì)應(yīng)的方法解析，每個(gè)方法解析后會(huì)對(duì)應(yīng)有一個(gè)MappedStatement。最終會(huì)調(diào)用到執(zhí)行器Executor中的update方法。整個(gè)執(zhí)行的過(guò)程相對(duì)比較復(fù)雜一點(diǎn)，這里就不貼出源碼，有興趣的可以看一下，篇幅有限，在后續(xù)的博客文章里面再詳細(xì)說(shuō)Executor執(zhí)行各種方法的方式和流程。

本文作者：程序猿楊鮑
版權(quán)歸作者所有，轉(zhuǎn)載請(qǐng)注明出處