【MyBatis源码】SqlSessionFactoryBuilder源码分析

news2024/11/24 2:07:50

文章目录

    • 概述
    • 类结构
    • 从 InputStream 创建 SqlSessionFactory
    • XMLConfigBuilder构建Configuration
      • XMLConfigBuilder初始化方法
        • parse()方法
        • parseConfiguration
        • 属性(properties)

概述

SqlSessionFactory 是 MyBatis 的核心接口之一,提供创建 SqlSession 的方法。SqlSession 则是与数据库交互的主要接口,负责执行 SQL 命令和映射结果。SqlSessionFactoryBuilder 类的作用就是从 XML 配置文件或者其他配置源中加载配置信息,构建出 SqlSessionFactory 实例。

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

类结构

在这里插入图片描述
SqlSessionFactoryBuilder 的基本结构如上,可以看出该类主要提供的就是build方法,但是参数不同,主要有3个不同参数类型的构建。
build(Reader reader):解析配置文件
build(InputStream inputStream):解析配置流
build(Configuration config):从 Configuration 对象构建 SqlSessionFactory

从 InputStream 创建 SqlSessionFactory

接下来我们将深入解析 SqlSessionFactoryBuilder 中的 build(InputStream inputStream) 方法的实现及其背后的细节。

  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      // XMLConfigBuilder用来解析XML配置文件
      // 使用构建者模式
      // parser.parse()使用XPATH解析XML对象,将配置文件转换为Configuration对象
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      // new DefaultSqlSessionFactory,该对象持有Configuration对象
      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.
      }
    }
  }

【方法参数说明】
• InputStream inputStream: 用于读取 XML 配置文件的输入流。这个流包含了 MyBatis 的配置信息,通常来自于 mybatis-config.xml 文件。
• String environment: 指定当前使用的环境。MyBatis 支持多种环境配置,例如开发、测试和生产。这个参数用于从配置中选择合适的数据库连接设置。具体使用那个由配置决定。
在这里插入图片描述
• Properties properties: 用于传递额外的配置信息。可以通过 Properties 对象向配置文件中添加一些动态的参数,便于灵活配置。

XMLConfigBuilder构建Configuration

MyBatis通过XMLConfigBuilder类完成Configuration对象的构建工作。下面是通过XMLConfigBuilder类创建Configuration的案例代码:

  /**
   * 测试XMLConfigBuilder类完成Configuration对象的构建
   */
  @Test
  public void test5() throws Exception {
    InputStream resource = Resources.getResourceAsStream(MybatisTest.class.getClassLoader(), "mybatis-config.xml");
    XMLConfigBuilder xmlConfigBuilder = new XMLConfigBuilder(resource);
    Configuration parse = xmlConfigBuilder.parse();
    System.out.println(parse);
  }

在这里插入图片描述

XMLConfigBuilder初始化方法

  public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
    // XPathParser是基于java path解析器,用于解析Mybatis中的配置文件
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
  }
  public XPathParser(InputStream inputStream, boolean validation, Properties variables, EntityResolver entityResolver) {
    commonConstructor(validation, variables, entityResolver);
    // 解析XML文档为Document对象
    this.document = createDocument(new InputSource(inputStream));
  }

继续回到上一层代码,看XMLConfigBuilder的this()。super(new Configuration());
调用父类构造函数:创建一个新的 Configuration 对象,并将其传递给父类构造函数,表明当前 XMLConfigBuilder 的实例将使用这个全局配置对象。
在这里插入图片描述
在这里插入图片描述
以上的全局变量可以在mybatis的官方文档找到解释说明
在这里插入图片描述
https://mybatis.org/mybatis-3/zh_CN/configuration.html

MyBatis 的 Configuration 类是全局配置文件的核心,负责存储和管理应用程序的各种配置信息
Configuration 构造函数的主要作用是初始化类型别名注册器、设置默认的事务工厂、数据源、缓存策略、日志实现和语言驱动,确保 MyBatis 配置的灵活性和易用性。

parse()方法

继续看XMLConfigBuilder类parse()方法的实现,代码如下:


  public Configuration parse() {
    // 防止parse()方法被同一个实例多次调用
    if (parsed) {
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    // parser.evalNode("/configuration") 获取配置文件configuration节点XNode对象
    // parseConfiguration:解析配置文件各个节点
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
  }
parseConfiguration

继续看parseConfiguration核心方法
在这里插入图片描述
在parseConfiguration()方法中,对于标签的子节点,都有一个单独的方法处理,例如使用propertiesElement()方法解析标签,使用pluginElement()方法解析标签。MyBatis主配置文件中所有标签的用途如下。

具体配置这里可以对着MyBatis 的配置文件官方文档进行参考
https://mybatis.org/mybatis-3/zh_CN/configuration.html

属性(properties)

这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。例如:

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。比如:

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

这个例子中的 username 和 password 将会由 properties 元素中设置的相应值来替换。 driver 和 url 属性将会由 config.properties 文件中对应的值来替换。这样就为配置提供了诸多灵活选择。
也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值。例如:

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);

// ... 或者 ...

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

:用于配置MyBatis数据连接相关的环境及事务管理器信息。通过该标签可以配置多个环境信息,然后指定具体使用哪个。标签的配置信息如下:

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <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>
environmentsElement(root.evalNode("environments"));

在这里插入图片描述
【序号1】这里的isSpecifiedEnvironment主要是主要用于判断当前指定的环境是否与传入的环境 ID 匹配,如果配置了多个environment标签组,则选择与环境 ID 匹配的那个进行加载处理。这个方法主要在环境配置的上下文中使用,例如在解析 XML 配置文件时,需要确保当前配置与指定的环境匹配。这对于支持多环境配置(如开发、测试、生产等)非常重要。
【序号2】这段代码是 MyBatis 中用于处理事务工厂配置的一个方法,主要负责从 XML 配置中解析并创建 TransactionFactory 实例。
在这里插入图片描述
【序号3】dataSourceElement用于解析获取数据库连接相关的配置信息。

private DataSourceFactory dataSourceElement(XNode context) throws Exception {
    if (context != null) {
      String type = context.getStringAttribute("type");
      // 获取<dataSource>子节点的配置
      Properties props = context.getChildrenAsProperties();
      // 根据getStringAttribute("type");获取对应的实现DataSourceFactory
      DataSourceFactory factory = (DataSourceFactory) resolveClass(type).getDeclaredConstructor().newInstance();
      // 映射转换数据源配置 driver;url;username;password
      factory.setProperties(props);
      return factory;
    }
    throw new BuilderException("Environment declaration requires a DataSourceFactory.");
  }

在这里插入图片描述
更多使用参见官方文档

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

鸿蒙原生应用开发及部署:首选华为云,开启HarmonyOS NEXT App新纪元

目录 前言 HarmonyOS NEXT&#xff1a;下一代操作系统的愿景 1、核心特性和优势 2、如何推动应用生态的发展 3、对开发者和用户的影响 华为云服务在鸿蒙原生应用开发中的作用 1、华为云ECS C系列实例 &#xff08;1&#xff09;全维度性能升级 &#xff08;2&#xff…

SQLite3库增删改查实现数据管理

1. SQLite3简介 SQLite3是一个轻量级的、嵌入式的关系型数据库管理系统&#xff0c;在保存测序数据或结果等时可使用&#xff0c;简单高效&#xff0c;并且有无需服务器、单文件存储数据、支持标准SQL、支持跨平台等优势。 本文以Sqlite3数据库为基础&#xff0c;创建代码示例…

【实验八】前馈神经网络(4)优化问题

1 参数初始化 模型构建 模型训练 优化 完整代码 2 梯度消失问题 模型构建 模型训练 完整代码 3 死亡Relu问题 模型构建 模型训练 优化 完整代码 1 参数初始化 实现一个神经网络前&#xff0c;需要先初始化模型参数。如果对每一层的权重和偏置都用0初始化&#xff0…

Vscode配置CC++编程环境的使用体验优化和补充说明

文章目录 快速编译运行&#x1f47a;code runner插件方案Code Runner Configuration 直接配置 相关指令和快捷键默认task配置和取消默认 配置文件补充介绍(可选 推荐阅读)&#x1f60a;使用vscode预置变量和环境变量环境变量的使用使用环境变量的好处环境变量可能引起的问题 检…

计算机网络:网络层 —— IPv4 地址与 MAC 地址 | ARP 协议

文章目录 IPv4地址与MAC地址的封装位置IPv4地址与MAC地址的关系地址解析协议ARP工作原理ARP高速缓存表 IPv4地址与MAC地址的封装位置 在数据传输过程中&#xff0c;每一层都会添加自己的头部信息&#xff0c;最终形成完整的数据包。具体来说&#xff1a; 应用层生成的应用程序…

【秋冬进补】灵芝玉叶膏冬令上选减补两不误

秋冬季不仅是进补季&#xff0c;也是肥胖增涨的季节&#xff0c;气温降低了&#xff0c;运动、户外活动量减少了&#xff0c;消耗吸收率减慢&#xff0c;饮食中肉类比例上升&#xff0c;绿蔬少了&#xff0c;油热量增加了&#xff0c;肥胖几率也一样增加了。因此&#xff0c;选…

HTML5 + CSS3 + JavaScript 编程语言学习教程

HTML5 CSS3 JavaScript 编程语言学习教程 欢迎来到这篇关于 HTML5、CSS3 和 JavaScript 的详细学习教程&#xff01;无论你是初学者还是有一定基础的开发者&#xff0c;这篇文章都将帮助你深入理解这三种技术的核心概念、语法和应用。 目录 HTML5 1.1 HTML5 简介1.2 HTML5 …

10月第4周AI资讯

阅读时间&#xff1a;3-4min 更新时间&#xff1a;2024.10.21-2024.10.25 目录 CoI-Agent&#xff1a;一键生成科研idea的AI研究助手 波兰电台正式启用 AI 主播 Claude可以像人类一样使用计算机 简单文本即可创建个性化语音 AI音乐制作工具新突破 CoI-Agent&#xff1a;…

[TypeError]: type ‘AbstractProvider‘ is not subscriptable

升级pdm到2.20.0后&#xff0c;执行pdm add --dev mypy时报错了&#xff1a; INFO: Adding group dev to lockfile Adding packages to dev dev-dependencies: pytest, pdm, ruff, click, mypy ⠋ 0:00:00 Resolving dependencies See /Users/mac10.12/Library/Logs/pdm/pdm-l…

(大开眼界)想要数据安全,企业需要选择正确的数据备份方案!七种常见数据备份策略方法及优缺点分析!

信息化时代&#xff0c;数据已成为企业的核心资产&#xff0c;其重要性不言而喻。 然而&#xff0c;随着数据价值的不断提升&#xff0c;其脆弱性也愈加明显。自然灾害、硬件故障、人为错误以及恶意攻击等因素&#xff0c;都可能导致数据的丢失或损坏。 因此&#xff0c;选择…

微信公众号(或微信浏览器)获取openId(网页授权)

下单支付需要openId 首先授权去拿到code --然后调用后太换取openId 1.去拿取code 下图中执行到window.location.href &#xff08; redirect_uri 传入当前路径-&#xff09;–执行后重新跳转到当前页面–但是路径上会带上code参数 //然后调用后台方法–将code传给后台得到 o…

如何找到优质的抖音视频素材

随着短视频的流行&#xff0c;越来越多的人开始拍摄和分享自己的作品。但很多创作者常常遇到一个问题&#xff1a;视频素材从哪里来&#xff1f;今天&#xff0c;我就为大家推荐一些优秀的网站&#xff0c;帮助你轻松找到优质的抖音视频素材。 蛙学网 首先推荐的是蛙学网。这个…

django快速基本配置(2)

知识星球 | 深度连接铁杆粉丝&#xff0c;运营高品质社群&#xff0c;知识变现的工具 目录 配置开发目录 配置MySQL数据库 配置Redis数据库 配置工程日志 用户注册 跨域CORS 注意 配置开发目录 libs 存放第三方的库文件 utils 存放项目自己定义的公共函数或类等 apps 存…

【SQL】SQL函数

&#x1f4e2; 前言 函数 是指一段可以直接被另一段程序调用的程序或代码。主要包括了以下4中类型的函数。 字符串函数数值函数日期函数流程函数 &#x1f384; 字符串函数 ⭐ 常用函数 函数 功能 CONCAT(S1,S2,...Sn) 字符串拼接&#xff0c;将S1&#xff0c;S2&#xff0…

Javaweb 实验4 xml

我发现了有些人喜欢静静看博客不聊天呐&#xff0c; 但是ta会点赞。 这样的人呢帅气低调有内涵&#xff0c; 美丽大方很优雅。 说的就是你&#xff0c; 不用再怀疑哦 实验四 XML 目的&#xff1a; 安装和使用XML的开发环境认识XML的不同类型掌握XML文档的基本语法了解D…

第二十章 Vue组件通信之父子通信

目录 一、引言 二、组件关系分类 三、组件通信的解决方案 3.1. 父子通信流程图 3.2. 父组件通过 props 将数据传递给子组件 3.2.1. 代码App.vue 3.2.2. 代码MySon.vue 3.3. 子组件利用 $emit 通知父组件修改更新 ​编辑3.3.1. 代码App.vue 3.3.2. 代码MySon.vue 3…

使用GDAL库的ogr2ogr将GeoJSON数据导入到PostgreSql中

数据下载 数据下载地址&#xff1a;https://datav.aliyun.com/portal/school/atlas/area_selector 我这里下载全国所有城市的数据进行导入 下载安装GDAL 以下是安装 ogr2ogr&#xff08;GDAL 工具集的一部分&#xff09;的步骤&#xff0c;适用于 Windows、macOS 和 Linux 系…

pycharm configurations中配置运行fastapi项目

环境 windows11 python3.11 fastapi0.115 使用virtualenv安装fastapi uvicorn pip install fastapi pip install uvicorn目的 在pycharm中可以一键运行&#xff0c;直接把命令行的运行参数配置到pycharm中, 即使用"uvicorn main:app --reload"运行main文件 配置 …

和小北一起Cozeplay | 扣子万圣节企划

前言&#xff1a; &#x1f383;&#x1f383;&#x1f383;在这个充满神秘与欢乐的万圣节季节&#xff0c;扣子携手小北&#xff0c;为大家带来了一场别开生面的Cozeplay活动&#xff01;无论你是想要体验一把惊悚刺激的万圣节氛围&#xff0c;还是想要展示自己的创意与才华&a…

工作转型与个人突破提升:如何在社会浪潮中激流勇进

文章目录 一、写在前面二、技术人的迷茫三、做好项目经理其实很难四、从纯技术者转型为管理者面临的事五、最重要的技能【重磅推荐&#xff01;免费简单内网穿透神器&#xff01;支持linuxwindows】 一、写在前面 近期工作变动&#xff0c;虽然说对于开发者而言&#xff0c;工…