mybatis源码分析-资源加载-上篇

资源加载

mybatis资源加载的过程主要是处理xml里面的三种类型的标签<configuration><mapper><select|insert|update|delete>这三种标签分别对应三个处理类:XMLConfigurationBuilder;XMLMapperBuilder;XMLStatementBuilder。这三个类解析完数据之后会将所有的数据都放到configuration对象中。方便后面getMapper,和执行sql使用。在解析过程中也会将各种标签,属性创建合理的对象来与之对应起来。

  • Properties 在configuration对象中保存配置文件中<properties>的值。在propertiesElement这个方法中被解析
  • TypeHandlerRegistry 类型处理器注册的类,用来处理查询到的结果中jdbc类型和java类型不匹配进行映射。默认情况下Mybatis已经提供了许多类型匹配处理器
  • TypeAliasRegistry 别名处理注册的类,用来收集别名与class对应的映射,默认Mybatis已经提供了许多类型映射例如list表示java.util.List

处理configuration标签

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

看一下SqlSessionFactoryBuilder类代码,可以知道没有构造方法直接采用默认的构造方法,然后使用build方法创建SqlSessionFactory对象。这个类采用了build模式,仿照了spring里面实例ClassPathXmlApplicationContext类的方式。多个方法最终都是调用一个方法类实例,如果没有传参,则采用默认方式。

  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        inputStream.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }
  
  public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }

先看创建XMLConfigBuilder对象的过程

  public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
      //XMLConfigBuilder对象持有XPathParser对象
      //XPathParser对象持有Document对象
      //Document对象持有inputStream对象解析出来的xml文档的完整数据。解析方式采用JDK中的javax.xml.parsers
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
  }

继续看一下实例化XPathParser对象

    //分析xml
  public XPathParser(InputStream inputStream, boolean validation, Properties variables, EntityResolver entityResolver) {
    //这个创建对象,比较简单,就是属性的赋值
      commonConstructor(validation, variables, entityResolver);

    this.document = createDocument(new InputSource(inputStream));
  }

以上实现方式采用的是java提供的xml解析方式,在javax.xml.parser这个包里面。目前通过上面的操作xml文件已经变成了Document对象。可以通个getElementByName等等方法获得Element元素。并且这个Document对象已经间接的被XMLConfigBuilder持有。继续调用XMLConfigBuilder.parse()方法。

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

先看上面的parser.evalNode("/configuration")我们在配置Mybatis的时候可以看到根节点就是configuration。可以猜测应该是拿到configuration这个节点的所有数据

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

加载configuration细节

继续看这句parseConfiguration(parser.evalNode("/configuration"));这个方法里面是要处理configuration节点。在parser.evalNode("/configuration")里面已经拿到了<configuration>节点,这个节点被封装成了XNode对象。XNode对象是将Node对象作为属性(设计模式的原则:组合优于继承)在对象中使用,这个XNode就是获得<configuration>节点中的各种数据。然后通过paserConfiguration方法处理这个节点。其实就是注册各种信息。看源代码

  private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
        //获得properties节点,保存到configuration.variables属性里面
      propertiesElement(root.evalNode("properties"));

      //将别名添加到configuration.TypeAliasRegistry 这个里面已经默认注册了常用的数据类
        /**
         * 下面简单列几个mybatis提供的默认类型别名。当然也可以自定义。会解析下面标签
         * <typeAlias alias="Author" type="org.apache.ibatis.domain.blog.Author"/>
         * registerAlias("byte", Byte.class);
         * registerAlias("byte[]", Byte[].class);
         * registerAlias("_byte", byte.class);
         * registerAlias("ResultSet", ResultSet.class);
         * registerAlias("list", List.class);
         */
      typeAliasesElement(root.evalNode("typeAliases"));
      //这个是解析插件,暂时跳过
      pluginElement(root.evalNode("plugins"));
      //这个也没怎么用到,先跳过
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectionFactoryElement(root.evalNode("reflectionFactory"));
      settingsElement(root.evalNode("settings"));
      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      //看一下这个类型处理器
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

加载properties节点

上面只标注了一些经常使用的节点解析过程,一些不常用的就没有分析,例如objectFactory,objectWrapperFactory就不分析了。先来看一下properties这种键值对解析过程。过程很简单分为两种情况:

  • 直接是键值对存在的直接生成Properties对象
  • 使用Resource进行引入文件的,先读取文件变为inputStream流,然后从中读出键值对

最后解析完数据,将Properties对象保存到configuration对象中configuration.setVariables(defaults);

    //将配置文件里面的properties解析出来,保存到configuration对象里面的variables里面
  private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
        //直接解析类似:<property name="a" value="a1"/>种的键值对
      Properties defaults = context.getChildrenAsProperties();
      //处理Resource这种资源:<properties resource="org/apache/ibatis/databases/blog/blog-derby.properties"/>
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      Properties vars = configuration.getVariables();
      if (vars != null) {
        defaults.putAll(vars);
      }
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }

加载typeAlias节点

继续分析第二个方法typeAliasesElement(root.evalNode("typeAliases"));这个方法是处理别名。当时用<typeAlias alias="Author" type="org.apache.ibatis.domain.blog.Author"/>的时候就是在时用别名。这些别名回注册到configuration对象里面TypeAliasRegistry对象。这个对象里面已经默认创建了一些常用类型的别名,这就是为什么在写sql的时候可以直接使用resultType="list"因为这个类型已经默认注册到TypeAliasRegistry而在执行sql之后返回类型会先到configuration对象里面找到TypeAliasRegistry里面是否有这个别名的对象,如果没有就只用反射Class创建对象。下面简单看看TypeAliasRegistry。所有的类型最终都是放在map里面

public class TypeAliasRegistry {

  private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>();

  public TypeAliasRegistry() {
    registerAlias("string", String.class);

    registerAlias("byte", Byte.class);
    registerAlias("long", Long.class);
    registerAlias("short", Short.class);
    //省略...
    }
}

加载typeHandler节点

注册的过程比较简单就是将name作为可以,class作为值放到map对象里面。细节就不介绍了。跳过不常用的属性objectFactory,objectWrapperFactory,reflectionFactory,可以简单看一下setting。在使用mybatis的时候只要有许多默认的setting配置。这些配置就是从settingsElement(root.evalNode("settings"));里面注入进去的。如果没有设置那么统统都读取默认配置,设置了就用你自己的。再来看一下类型处理器TypeHandler这个是指查询sql之后返回的jdbs类型和java类型不匹配时可以使用你自定义的类型来处理返回数据。Mybatis里面已经设置了好多默认的类型处理器。

    /**
     * 处理这种类型标签。分别将javaType,jdbcType,handler三个属性注册到configuration.typeHandlerRegistry里面
     * <typeHandler javaType="String" jdbcType="VARCHAR" handler="org.apache.ibatis.builder.ExampleTypeHandler"/>
     * @param parent
     * @throws Exception
     */
  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);
          }
        }
      }
    }
  }

上面的注册过程很简单,就是读取node下面的jdbcType和javaType和处理类handler。然后注册到typeHandlerRegistry里面。看一下默认的类型处理器

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

推荐阅读更多精彩内容