『手撕 Mybatis 源码』02 - 加载配置文件

加载配置文件

获取输入流

  1. myBatis 的配置文档层次架构
    在这里插入图片描述
  2. 首先从读入开始查看是怎么加载配置文件的,现在从这里打个断点
public class MybatisTest {
  @Test
  public void test1() throws IOException {
        // 1. 通过类加载器对配置文件进行加载,加载成了字节输入流,存到内存中
        // 注意:配置文件并没有被解析
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    ...
  }
}
  1. 然后发现会通过一个 classLoaderWrapper: ClassLoader 的包装器来把数据源读入,返回输入流
public class Resources {
  ...
  public static InputStream getResourceAsStream(ClassLoader loader, String resource) throws IOException {
	InputStream in = classLoaderWrapper.getResourceAsStream(resource, loader);
    ...
  }
}
  1. 继续进入会发现其实会通过 getClassLoaders(classLoader) 返回对应加载器之后再进行读取。现在的 classLoader 是 null
public class ClassLoaderWrapper {
  ...
  public InputStream getResourceAsStream(String resource, ClassLoader classLoader) {
    return getResourceAsStream(resource, getClassLoaders(classLoader));
  }
}
  1. 其中 getClassLoaders(classLoader) 代码如下
public class ClassLoaderWrapper {
  // 默认类加载器
  ClassLoader defaultClassLoader;
  // 系统类加载器
  ClassLoader systemClassLoader;
  ...
  ClassLoader[] getClassLoaders(ClassLoader classLoader) {
    return new ClassLoader[]{
        // 参数指定的类加载器
        classLoader,
        // 系统指定的默认加载器
        defaultClassLoader,
        // 当前线程绑定的类加载器
        Thread.currentThread().getContextClassLoader(),
        // 当前类使用的类加载器
        getClass().getClassLoader(),
        systemClassLoader};
  }
}
  1. 拿到加载器集合之后才正在的调用读取源方法,最后返回输入流,判断方法如下
public class ClassLoaderWrapper {
  ...
  InputStream getResourceAsStream(String resource, ClassLoader[] classLoader) {
    // 循环 ClassLoader,通过指定或默认的 ClassLoader 读取文件
    for (ClassLoader cl : classLoader) {
      // 如果加载器不是空的
      if (null != cl) {
        // 先用这个加载器尝试读一下
        InputStream returnValue = cl.getResourceAsStream(resource);

        // 如果返回没结果,有可能是因为缺少个 "/",添加后再读一下
        if (null == returnValue) {
          returnValue = cl.getResourceAsStream("/" + resource);
        }
        
        if (null != returnValue) {
          // 如果读取到,终止循环,返回结果
          return returnValue;
        }
      }
    }
    return null;
  }
}
  1. 当输入流读成功之后,就返回
public class Resources {
  ...
  public static InputStream getResourceAsStream(ClassLoader loader, String resource) throws IOException {
	InputStream in = classLoaderWrapper.getResourceAsStream(resource, loader);
	// 找到输入流之后,就返回了
    if (in == null) {
      throw new IOException("Could not find resource " + resource);
    }
    return in;
  }
}
  1. 问题:为什么需要 ClassLoaderWrapper 包装器,而不直接使用 ClassLoader?
  • 因为它需要拿来判断资源路径是否为空
  • 根据路径加载好的输入流是否为空
  • 使用的类加载器是否为空
  • 异常处理

解析配置文件

  1. 首先先通过 SqlSessionFactoryBuilder 构建 sqlSessionFactory,我们能知道 sqlSessionFactory 肯定包含了所有配置文件信息
public class MybatisTest {

  @Test
  public void test1() throws IOException {
    ...
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    ...
  }
}
  1. 首先是调用 build() 方法,发现我们 environment 输入的是 null
public class SqlSessionFactoryBuilder {
	...
	  public SqlSessionFactory build(InputStream inputStream) {
    return build(inputStream, null, null);
  }
  // environment 运行环境信息的 id 值
  public SqlSessionFactory build(InputStream inputStream, String environment) {
    return build(inputStream, environment, null);
  }
  ...
}
  • 其实正常来说,我们可以自己配置 environment 参数,因为我们知道 Mybatis 是支持多环境配置,定义就在 sqlMapConfig.xml
<configuration>
  ...
    <environment id="development">
	...
    </environment>
  ...
</configuration>
  1. 然后就需要通过 XMLConfigBuilder 来将输入流创建成 document 对象
public class SqlSessionFactoryBuilder {
  ...
  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      // XMLConfigBuilder:用来解析XML配置文件
      // 使用构建者模式:
      // 	- 好处:降低耦合、分离复杂对象的创建
      // 1. 创建 XPathParser 解析器对象,根据 inputStream 解析成了 document 对象 
      // 2. 创建全局配置对象 Configuration 对象
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      ...
	}
}

注意:对于返回至少 4 个参数以上的对象,最好使用 构建者模式

  1. XMLConfigBuilder 的构造器中就会通过创建一个 XPathParser 对象,里面就会包含一个 document 对象,也就是 XPathParser 其实只会专门负责解析配置文件而已
public class XMLConfigBuilder extends BaseBuilder {
  ...
  public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
    // XPathParser 基于 Java XPath 解析器,用于解析  MyBatis 中的配置文件
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
  }
}
  • createDocument() 的东西过于细节,就先不关注了,反正最终就是,通过 dom 解析,获取 Document 对象,然后赋值到成员变量中
public class XPathParser {
  ...
  public XPathParser(InputStream inputStream, boolean validation, Properties variables, EntityResolver entityResolver) {
    commonConstructor(validation, variables, entityResolver);
    // 解析 XML 文档为 Document 对象
    this.document = createDocument(new InputSource(inputStream));
  }
}
  1. 然后开始初始化 XMLConfigBuilder,首先会创建一个 Configuration 对象
public class XMLConfigBuilder extends BaseBuilder {
  private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
    //  创建全局 Configuration 对象,并通过 TypeAliasRegistry 注册一些 Mybatis 内部相关类的别名
    super(new Configuration());
    ...
  }
}
  1. 简单来看看 Configuration 的构造方法,可以看到注册了一堆别名器
public class Configuration {
  ...
      // 为什么使用 JDBC 别名就能使用 jdbc 事务管理呢? sqlConfig.xml,原因就是在这
  public Configuration() {
   
    // TypeAliasRegistry(类型别名注册器)
    // 注册事务工厂的别名
    typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
    typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);
    ...
  }
}
  • 问题:为什么使用 JDBC 别名就能使用 jdbc 事务管理呢?
    • 原因就是这里, 因为我们在 sqlMapConfig.xml 中,指定了用哪个工厂来赋值,其中的 type 字段就是
<configuration>
	...
    <environment id="development">
      <!-- 使用jdbc事务管理 -->
      <transactionManager type="JDBC" />
      <!-- 数据库连接池 -->
      <dataSource type="POOLED">
		...
      </dataSource>
    </environment>
	...
</configuration>
  1. 回到 build() 得到 XMLConfigBuilder 后,才真正开始执行分析
public class SqlSessionFactoryBuilder {
  ...
  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
   
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);

      // parser.parse():使用 XPATH 解析 XML 配置文件,将配置文件封装到 Configuration 对象
      // 返回 DefaultSqlSessionFactory 对象,该对象拥有 Configuration 对象(封装配置文件信息)
      // parse():配置文件就解析完成了
      return build(parser.parse());
  }
}

XMLConfigBuilder 解析 Document 获取配置存入 configuration

  1. 继续从 parser.parse() 里面进入会看到 parse() 只会解析一次
public class XMLConfigBuilder extends BaseBuilder {
  ...
  public Configuration parse() {
    // 一开始是 false,只会计息一次
    if (parsed) {
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;

    // parser.evalNode("/configuration"):通过 XPATH 解析器,解析 configuration 根节点
    // 从 configuration 根节点开始解析,最终将解析出的内容封装到 Configuration 对象中
    parseConfiguration(parser.evalNode("/configuration"));

    return configuration;
  }
}
  1. 然后通过 evalNode() 将解析 /configuration 下的所有内容成 Xnode
public class XPathParser {
  ...
  public XNode evalNode(String expression) {
    // 根据XPATH语法,获取指定节点
    return evalNode(document, expression);
  }

  public XNode evalNode(Object root, String expression) { // 获取需选中的内容,转换成 xnode
    Node node = (Node) evaluate(expression, root, XPathConstants.NODE);
    if (node == null) {
      return null;
    }
    return new XNode(this, node, variables);
  }
  ...
}
  • 其中 Xnode 包含的内容就是 sqlMapConfig.xml 标签 <configuration> 下的所有内容
  1. 进入到 parseConfiguration() 之后会发现很多 **Element() 的函数,很关键,这些都是把 /configuration 节点下的内容解析出来,存到 configuration 对象中
public class XMLConfigBuilder extends BaseBuilder {
	...
	  private void parseConfiguration(XNode root) {
    try {
      // 解析 </properties> 标签
      propertiesElement(root.evalNode("properties"));
      // 解析 </settings> 标签
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      loadCustomLogImpl(settings);
      // 解析 </typeAliases> 标签
      typeAliasesElement(root.evalNode("typeAliases"));
      // 解析 </plugins> 标签
      pluginElement(root.evalNode("plugins"));
      // 解析 </objectFactory> 标签
      objectFactoryElement(root.evalNode("objectFactory"));
      // 解析 </objectWrapperFactory> 标签
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      // 解析 </reflectorFactory> 标签
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      // 解析 </environments> 标签
      environmentsElement(root.evalNode("environments"));
      // 解析 </databaseIdProvider> 标签
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      // 解析 </typeHandlers> 标签
      typeHandlerElement(root.evalNode("typeHandlers"))
      // 解析 </mappers> 标签 加载映射文件流程主入口
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }
}
  1. 跳到 environmentsElement() 看看
  • 首先它会从 Xnode 节点中提取 /environments 元素,然后判断存不存在内容
  • 然后判断是否传入过 environment 参数,如果没有,就从 /environments 拿到 default 属性 要激活的环境
  • 拿到环境后,开始根据每个标签下定义的 type 属性 创建各个工厂类,最后封装到 configuration
public class XMLConfigBuilder extends BaseBuilder {
  ...
  private void environmentsElement(XNode context) throws Exception {
    // 如果定义了environments
    if (context != null) {
      // 方法参数如何没有传递 environment,则解析 sqlMapConfig.xml 中的
      if (environment == null) {
        // <environments default="development" >
        environment = context.getStringAttribute("default");
      }

      //遍历解析 environment 节点,找到生效的 environment
      for (XNode child : context.getChildren()) {
        // 获得 id 属性值
        String id = child.getStringAttribute("id");
        // 判断 id 和 environment 值是否相等
        if (isSpecifiedEnvironment(id)) {

          // <transactionManager type="JDBC" /> 创建事务工厂对象
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));

          // <dataSource type="POOLED"> 创建数据源对象
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          DataSource dataSource = dsFactory.getDataSource();
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);

          // 将 Environment 存到 configuraion 中
          configuration.setEnvironment(environmentBuilder.build());
          break;
        }
      }
    }
  }
}
  • transactionManagerElement()type 属性 作用就是起的别名里面已经有对应工厂类了,直接初始化即可
public class XMLConfigBuilder extends BaseBuilder {
  ...
  private TransactionFactory transactionManagerElement(XNode context) throws Exception {
    if (context != null) {
      String type = context.getStringAttribute("type");
      Properties props = context.getChildrenAsProperties();
      TransactionFactory factory = (TransactionFactory) resolveClass(type).getDeclaredConstructor().newInstance();
      factory.setProperties(props);
      return factory;
    }
    throw new BuilderException("Environment declaration requires a TransactionFactory.");
  }
}
  1. 再来看看 mapperElement() 解析 /mappers 的情况
  • 它会根据子标签 /package 还是 /mapper 进行处理,先简单看看 /mapper 的解析
  • 它会从 /mapper 中解析出 resource 属性url 属性class 属性,这 3 者是互斥的,只能用其中一个
  • resource 属性 的解析,还需要使用 XMLMapperBuilder 来专门解析
public class XMLConfigBuilder extends BaseBuilder {
  ...
  private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      // 获取 <mappers> 标签的子标签
      for (XNode child : parent.getChildren()) {
        // <package> 子标签
        if ("package".equals(child.getName())) {
			...
        } else {// <mapper>子标签
          // 获取<mapper>子标签的 resource 属性
          String resource = child.getStringAttribute("resource");
          // 获取 <mapper> 子标签的 url 属性
          String url = child.getStringAttribute("url");
          // 获取 <mapper> 子标签的 class 属性
          String mapperClass = child.getStringAttribute("class");
          // 它们是互斥的
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            try(InputStream inputStream = Resources.getResourceAsStream(resource)) {
              // 专门用来解析 mapper 映射文件
              XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
              // 通过 XMLMapperBuilder 解析 mapper 映射文件
              mapperParser.parse();
            }
          } else if (resource == null && url != null && mapperClass == null) {
            ErrorContext.instance().resource(url);
            try(InputStream inputStream = Resources.getUrlAsStream(url)){
              XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
              // 通过 XMLMapperBuilder 解析 mapper 映射文件
              mapperParser.parse();
            }
          } else if (resource == null && url == null && mapperClass != null) {
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            // 将指定 mapper 接口以及它的代理对象存储到一个 Map 集合中,key 为 mapper 接口类型,value 为代理对象工厂
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }
  ...
}
  1. 总结
    在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/21006.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

代码随想录算法训练营第二十三天|理论基础 77. 组合

文章目录 理论基础77.组合思路代码总结 理论基础 回溯算法&#xff1a;一种暴力搜索方式 回溯是递归的副产品&#xff0c;只要有递归就会有回溯。 回溯法&#xff0c;一般可以解决如下几种问题&#xff1a; 组合问题&#xff1a;N个数里面按一定规则找出k个数的集合切割问题…

学术加油站|基于LSM-tree存储系统的内存管理,最大限度降低I/O成本

本文系北京理工大学科研助理牛颂登所著&#xff0c;本篇也是 OceanBase 学术系列稿件第 10 篇。欢迎访问 OceanBase 官网获取更多信息&#xff1a;https://www.oceanbase.com/ 「牛颂登&#xff1a;北京理工大学科研助理&#xff0c;硕士期间在电子科技大学网络空间安全研究院从…

antd-vue-admin——通过链接跳过登录页直接进入系统内部——基础积累

最近在写后台管理系统&#xff0c;遇到一个需求&#xff0c;就是从系统A带参数可以直接进入到系统B内部。不通过系统B的登录页面进行登录。 一般系统的登录&#xff0c;都需要用户名和密码等参数&#xff0c;然后获取到token信息&#xff0c;最后进入到系统内部。 下面介绍具…

4. QT中的鼠标键盘事件 --- 鼠标拖拽案例

1. 说明 在QT的控件或者窗口当中&#xff0c;如果对于当前鼠标或者键盘的功能需要自己定义&#xff0c;可以重写父类当中对应虚函数&#xff0c;主要包括以下几个&#xff1a; //键盘按键按下 virtual void keyPressEvent(QKeyEvent *event); //键盘按键抬起 virtual void ke…

linux 常用命令awk

AWK 是一种处理文本文件的语言&#xff0c;是一个强大的文本分析工具。之所以叫 AWK 是因为其取了三位创始人 Alfred Aho&#xff0c;Peter Weinberger, 和 Brian Kernighan 的 Family Name 的首字符。 AWK用法 awk 用法&#xff1a;awk pattern {action} files 1.RS, ORS, F…

【c语言】组件化打包—静态库lib

创作不易&#xff0c;本篇文章如果帮助到了你&#xff0c;还请点赞 关注支持一下♡>&#x16966;<)!! 主页专栏有更多知识&#xff0c;如有疑问欢迎大家指正讨论&#xff0c;共同进步&#xff01; &#x1f525;c语言系列专栏&#xff1a;c语言之路重点知识整合 &#x…

CVE-2023-32233 Linux kernel

0x01 漏洞介绍 近日&#xff0c;研究人员发现了Linux内核的NetFilter框架中的新漏洞&#xff08;CVE-2023-32233&#xff09;。该漏洞可被本地用户用于将权限提升为root&#xff0c;并完全控制系统。问题的根源在于tfilter nf_tables是如何处理批处理请求的&#xff0c;经过身…

AutoSizer.exe:自动调整窗口大小的便捷工具

AutoSizer.exe是一款实用的桌面应用程序,它旨在帮助用户自动调整窗口大小,提供更好的用户体验。无论您是在使用Windows操作系统进行日常工作还是进行多任务处理,AutoSizer.exe可以简化您的工作流程,提高效率。本文将介绍AutoSizer.exe的下载地址、功能介绍、使用方法以及其…

为世界第一大癌症高效研发首创新药,AI大模型助力药物研发叩开未来之门

近日&#xff0c;三位高中生引爆了医药圈&#xff0c;他们使用人工智能&#xff08;AI&#xff09;引擎进行靶点发现&#xff0c;确定了多形性胶质母细胞瘤&#xff08;GBM&#xff09;的新治疗靶点&#xff0c;多形性胶质母细胞瘤&#xff08;GBM&#xff09;是最具侵袭性和最…

238:vue+openlayers绘制扩展,弓形、曲线、扇形、双箭头、进攻方向...

第238个 点击查看专栏目录 本示例的目的是介绍演示如何在vue+openlayers中利用ol-plot插件进行绘制图形扩展,可以绘制弓形、弧形、标志旗、战斗进攻图形等等。 直接复制下面的 vue+openlayers源代码,操作2分钟即可运行实现效果; 注意如果OpenStreetMap无法加载,请加载其他…

【Shell脚本】Linux安装Nginx以及开机自启

目录 一、Linux安装Nginx脚本1、把编写好的安装Nginx脚本放置到nginx.sh文件中2、在检查网络的时候&#xff0c;这里的IP地址&#xff0c;填写的需要安装Nginx服务器的IP地址3、这里的端口号可按照自己的需要进行修改4、安装Nginx脚本 二、Nginx开机自启 一、Linux安装Nginx脚本…

Spring【Again】——复杂POJO的绑定

简单介绍&#xff1a; Again系列是将之前的内容我认为做的不好的地方或者是理解不到位的地方再来一次&#xff0c;加深记忆或者改错。我们就在来复习一下之前我们说过的复杂类型的数据绑定。 先来复习一下简单数据绑定&#xff1a; 简单数据绑定就是我们在传递参数的时候&am…

玩转ChatGPT:快速制作PPT

一、写在前面 首先还是让小Chat推销下自己&#xff1a; 你是否曾经为制作 PPT 而烦恼&#xff1f;现在有了 ChatGPT&#xff0c;再也不必担心灵感枯竭啦&#xff01;使用 ChatGPT 撰写 PPT 可以让你轻松地组织思路、快速得到内容&#xff0c;无需任何营销口号&#xff0c;Cha…

C++模板类与继承

目录 分类 一、模板类不继承 &#xff08;1&#xff09;代码 &#xff08;2&#xff09;分析 &#xff08;3&#xff09;运行结果 二、模板类继承普通类 &#xff08;1&#xff09;代码 &#xff08;2&#xff09;分析 &#xff08;3&#xff09;运行结果 三、普通类继…

Win11校园网不弹出登录页面怎么回事?

Win11校园网不弹出登录页面怎么回事&#xff1f;最近有用户在使用校园网的时候遇到了一些问题&#xff0c;访问登录网站的时候&#xff0c;一直无法显示登录的界面。那么遇到这个情况如何去进行解决呢&#xff1f;一起来看看以下的解决方法分享吧。 解决方法如下&#xff1a; 方…

nodejs处理xlsx文件生成json文件

nodejs处理xlsx文件有好几种方式&#xff0c;这里用的是js-xlsx库&#xff1b; 需求 有一个 xlsx 的文件&#xff0c;里面有几个不同的 sheet&#xff0c;需要读取这个表格中不同 sheet 的数据&#xff0c;并且为每个 sheet 生成对应的 json 文件。 例如有一个名为 template…

文本三剑客之——Awk

Awk Awk简介Awk语法格式Awk常见内置变量Awk实例演示按行输出文本BEGIN模式和END模式按字段输出文本通过管道&#xff0c;双引号调用shell命令date 的用法getline的用法awk数组 Awk简介 Awk是一个功能强大的编辑工具&#xff0c;用于在Linux/UNIX 下对文本和数据进行处理。数据…

ChatGPT vs. Bing vs. Bard

随着 2022 年 ChatGTP 的推出&#xff0c;人工智能聊天机器人的世界突然走上了一条新道路。如今&#xff0c;密切关注 AI 的人都知道&#xff0c;不同公司推出了几款产品。从谷歌拥有自己的 Bard AI&#xff0c;到微软发布新的 Bing AI Chat&#xff0c;再到 OpenAI 发布GPT-4。…

用gost实现远程端口映射

gost 是一个非常优秀的tunnel. 支持多种形式的端口映射。 本文只介绍远程端口映射方式的tunnel. 远程端口映射的意思就是&#xff0c;将本地端的某个服务的端口A&#xff08;tcp/udp&#xff09;映射到远程的某个端口P上&#xff0c; 用户通过访问远程的端口P来访问本地端的这…

生态碳汇涡度通量数据分析

生态碳汇涡度相关监测与通量数据分析 朱老师&#xff08;副教授&#xff09;&#xff1a;来自国内重点高校&#xff0c;长期从事涡度通量观测与分析研究&#xff0c;发表SCI论文多篇&#xff0c;主持国家与地方科研项目多个&#xff0c;在生态环境数据处理与分析中具有丰富的实…