Mybatis初始化

Mybatis初始化流程就是组装Configuration对象的过程,在这个过程中主要就是初始化环境变量和初始化Mapper.xml的映射。大致流程如下:

  1. SqlSessionFactoryBuilder.build(Reader reader):根据mybatis-config.xml配置文件简历SqlSessionFactory的时候会去触发生成XMLConfigBuilder对象解析配置并生成SqlSessionFactory。

    public class SqlSessionFactoryBuilder {
    public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    //生成配置解析对象
    XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
    //根据配置,解析配置生成SqlSessionFactory对象
    return build(parser.parse());
    }

     //创建SqlSessionFactory对象
     public SqlSessionFactory build(Configuration config) {
     return new DefaultSqlSessionFactory(config);
    

    }
    }

  2. XMLConfigBuilder.parse():开始了解析config配置文件并且初始化。

    public Configuration parse() {
    if (parsed) {
    throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    //解析config配置文件
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
    }

    //解析config配置文件
    private void parseConfiguration(XNode root) {
    try {
    //解析properties文件里面的参数,譬如数据库地址和用户密码这些
    propertiesElement(root.evalNode("properties"));
    //解析mybatis环境参数的配置
    Properties settings = settingsAsProperties(root.evalNode("settings"));
    loadCustomVfs(settings);
    //解析类型别名的配置
    typeAliasesElement(root.evalNode("typeAliases"));
    //解析插件的配置
    pluginElement(root.evalNode("plugins"));
    objectFactoryElement(root.evalNode("objectFactory"));
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
    reflectorFactoryElement(root.evalNode("reflectorFactory"));
    settingsElement(settings);
    //解析环境的配置,譬如多数据库名称
    environmentsElement(root.evalNode("environments"));
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));
    //解析类型处理器的配置
    typeHandlerElement(root.evalNode("typeHandlers"));
    //mapper.xml文件的解析
    mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
    }

下面挑几个关键的配置解析进行讲解:

  • typeAliasesElement(root.evalNode("typeAliases")):类型别名的解析,在Mapper.xml里面的namespace中会去使用到。
    private void typeAliasesElement(XNode parent) {
    if (parent != null) {
    for (XNode child : parent.getChildren()) {
    //如果直接是个包的话就把该包的所有类都注册到typeAliasRegistry中
    if ("package".equals(child.getName())) {
    String typeAliasPackage = child.getStringAttribute("name");
    configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
    } else {
    String alias = child.getStringAttribute("alias");
    String type = child.getStringAttribute("type");
    try {
    //加载类的class文件到方法区生成Class对象
    Class<?> clazz = Resources.classForName(type);
    if (alias == null) {
    typeAliasRegistry.registerAlias(clazz);
    } else {
    typeAliasRegistry.registerAlias(alias, clazz);
    }
    } catch (ClassNotFoundException e) {
    throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
    }
    }
    }
    }
    }typeHandlerElement(root.evalNode("typeHandlers"));
  • typeHandlerElement(root.evalNode("typeHandlers")):类型处理器解析,在设置参数和转换结果的时候会用到,在后面再仔细讲解下TypeHandler的使用。
    private void typeHandlerElement(XNode parent) throws Exception {
    if (parent != null) {
    for (XNode child : parent.getChildren()) {
    //如果元素是个包的话就把这个包里的所有类型处理器注册进去
    if ("package".equals(child.getName())) {
    String typeHandlerPackage = child.getStringAttribute("name");
    typeHandlerRegistry.register(typeHandlerPackage);
    } else {
    String javaTypeName = child.getStringAttribute("javaType");
    String jdbcTypeName = child.getStringAttribute("jdbcType");
    String handlerTypeName = child.getStringAttribute("handler");
    Class<?> javaTypeClass = resolveClass(javaTypeName);
    JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
    Class<?> typeHandlerClass = resolveClass(handlerTypeName);
    if (javaTypeClass != null) {
    if (jdbcType == null) {
    typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
    } else {
    typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
    }
    } else {
    typeHandlerRegistry.register(typeHandlerClass);
    }
    }
    }
    }
    }
  • mapperElement((root.evalNode("mappers"))):mapper.xml文件解析
    public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
    configurationElement(parser.evalNode("/mapper"));
    configuration.addLoadedResource(resource);
    //这里是解析具体的每个Mapper.xml映射文件并生成MapperProxyFactory
    bindMapperForNamespace();
    }
    //这里去最终处理resultMap标签,因为在解析的时候如果有依赖其他的标签的话会暂停
    parsePendingResultMaps();
    //这里去最终处理Cache标签,因为在解析的时候如果有依赖其他的标签的话会暂停
    parsePendingCacheRefs();
    //这里去最终处理select等标签,因为在解析的时候如果有依赖其他的标签的话会暂停
    parsePendingStatements();
    }
    通过namespace定义的名称类型,生成对应的MapperProxyFactory并注册到Configuration的MapperRegistry内,最后的Mapper接口是通过MapperProxyFactory生成。Mapper.xml里面的很多元素是有依赖的,并且xml文件是按顺序进行解析的,所以在解析到有依赖的元素时便把当前的元素置为incomplete并且放到列表里面(incompleteStatements、incompleteCacheRefs、incompleteResultMaps和incompleteMethods),然后去解析后续元素,等后面再最终去处理这些元素。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 226,197评论 6 524
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 97,254评论 3 410
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 173,718评论 0 370
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,801评论 1 305
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,732评论 6 404
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 54,200评论 1 318
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 42,389评论 3 433
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 41,484评论 0 282
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,024评论 1 328
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,013评论 3 352
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,125评论 1 359
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,698评论 5 353
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 43,407评论 3 342
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,795评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,996评论 1 278
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,724评论 3 384
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,150评论 2 368

推荐阅读更多精彩内容