ORM框架之Mybatis(八):mybatis基础代码的了解和源码跟踪

mybatis使用在日常开发中很简单,基本没有门槛,都是和Spring直接集成,然后把之前的一些配置copy到spring的配置文件中就可以使用。具体mybatis的配置文件加载代码,已经SqlSession执行的细节都被封装到了框架中,符合面向对象编程,但是存在一个问题就是那些细节的代码慢慢都被遗忘。写这个博客就是记录一下,以后忘记可以看看。仅此而已。

Mybatis配置文件的读取和SqlSessionFactory的构建

在mybatis中加载的基本的顺序是读取配置文件,然后构建SqlSessionFactory,通过SqlSessionFactory获取Session实例,最后通过Session实例获取到对应Mapper的代理对象,通过代理对象来调用CRUD方法执行数据的操作。

SqlSessionFactory构建
public class UserService {

    private static SqlSessionFactory sqlSessionFactory;
    //加载xml文件
    static {
        InputStream inputStream = null;
        try {
            //读取配置文件
            inputStream = Resources.getResourceAsStream("mybatis-config.xml");
            //构建SqlSessionFactory
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //关闭流
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

先将Mybatis核心配置文件mybatis-config.xml读取到流中,然后交给SqlSessionFactoryBuilder构建SqlSessionFactory对象,在构建前会对核心配置文件进行一系列的分析,并将分析的内容放到Configuration实例中,分析的过程之前的博客中有,可以翻一翻参考一下。

到这里是sqlSessionFactory构建完成,接下来看如何使用。

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);
    //调用插入方法
    mapper.insert(mode);
}

这里实现的逻辑的方法不难,关键是在于SqlSessionUserMapper的获取,这里和大家一起看看源码。

SqlSession获取源码

SqlSessionFactory是个接口,其实现是DefaultSqlSessionFactory,在这个类中有各种获取SqlSession实例的方法,根据上面的实例代码,找到openSession方法的实现。

public SqlSession openSession() {
   /**
   * configuration中获取默认的Executor执行器的类型
   * 第二个参数是事务隔离级别
   * 第三个参数表示是否自动提交,默认值是false
   **/
  return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}

执行器Executor类型有多种,如果在mapper.xml文件中没有特殊的配置基本使用的都是默认的执行器SimpleExecutor。事务隔离级别和是否自动提交都是使用默认的值。

进入到openSessionFromDataSource方法中后,从上面的传入参数可以知道,在这个方法中就是根据Executor执行器的类型创建相对应的实例,同时也会根据数据相关的参数构建出对应的事务管理器。待着两个实例构建结束,就会根据这两个实例去构建最终需要的SqlSession实例。源码如下:

/**
 * 构建Session
 * @param execType 执行器类型
 * @param level 事务隔离界别
 * @param autoCommit 是否自动提交
 * @return
 */
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
        //configuration获取环境配置信息
        final Environment environment = configuration.getEnvironment();
        //事务管理器工厂
        final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
        //创建事务管理器
        tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
        //创建执行器executor
        final Executor executor = configuration.newExecutor(tx, execType);
        //构建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();
    }
}

基本的流程和上面的解释一样。至于再深入的代码就不再详尽的贴出来啦(源码的内容太多,入口已提供,可以自己跟进去详细的了解),但是下面可以大概的说一下。

mybatis-config.xml核心配置文件中有个environment标签,这个标签中会配置相应的数据源信息和事务管理器的信息。在源码中将这些参数传入到事务管理器工厂中,构建工厂对象TransactionFactory,接着调用其创建事务管理器对象的方法。到这里事务管理器实例创建完成。

然后根据构建好的事务管理器和执行器类型去构建执行器对象,执行器对象的类型共有三种,从ExecutorType枚举类中可以看到,分别是是BATCH批处理模式,REUSE复用模式,SIMPLE简单模式。在newExecutor方法中对执行器类型做了判断,当不是批处理或者复用模式的时候就默认使用简单模式,当然后面还有对cacheEnabled的判断,如果支持缓存,还需要对上面的SimpleExecutor包装一层,然后就是对整个执行链的包装。至此执行器构建完成。(执行器构建的过程使用的是装饰器模式)

事务管理器、执行器构建结束,使用Configuration、执行器和是否自动提交参数,构建SqlSession对象,这个过程很简单,就是将这些参数设置到SqlSession对象成员变量中。

Mapper获取源码

Mapper本身只是一个接口,在从SqlSession对象中get获取对象的时候,是使用的动态代理,在mybatis源码中有一个模块叫做binding,在这里面有具体做动态代理的实现。看源码:

public <T> T getMapper(Class<T> type) {
    //通过configuration构建Mapper实例
    return configuration.<T>getMapper(type, this);
}

SqlSession中有个Configuration实例,通过这个实例使用的getMapper方法构建Mapper代理对象,进入后会调用MapperRegistry(Mapper注册器),在注册器里面会构建MapperProxyFactory工厂类,然后通过工厂类的newInstance方法构建具体的代理对象MapperProxy

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    //根据type到knowMappers中获取MapperProxyFactory实例
    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生成对象实例
        return mapperProxyFactory.newInstance(sqlSession);
    } catch (Exception e) {
        throw new BindingException("Error getting mapper instance. Cause: " + e, e);
    }
}

通过这里就完成了Mapper代理对象的创建,并返回。

insert方法调用

mapper.xml文件的结果过程中,有对应的方法解析,每个方法解析后会对应有一个MappedStatement。最终会调用到执行器Executor中的update方法。整个执行的过程相对比较复杂一点,这里就不贴出源码,有兴趣的可以看一下,篇幅有限,在后续的博客文章里面再详细说Executor执行各种方法的方式和流程。

本文作者:程序猿杨鲍
版权归作者所有,转载请注明出处

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容