七天带你入门Mybatis源码第一天，mybatis架构设计

野性酷女 2023-02-14 03:17 19阅读 0赞

前言：这是我最近学习的一个系列，Mybatis源码系列。打算把自己最近看的东西输出出来，和大家一起交流下。也算是对自己近期学习的一个总结吧。有很多人不理解为啥要看源码？他们认为看源码没有用，就是浪费时间，还有一些人认为看源码都是一些大佬看的东西等等。但是在我看来，我们学习源码，不是要扣清楚每一个算法的具体实现，而是清楚这个框架的整体架构的轮廓，是学习人家的编码设计风格，架构思想。俗话说的好，见多识广吧。我也会分享我看源码的方式和心得体会，也欢迎大家和我交流心得和体会。

今天是mybatis源码的第一讲，我想先分享我看源码的一些步骤吧。

1.你要会用这个框架（我这有点说废话了）

2.你要结合自己的经验，自己设计这个框架的架构（这个步骤很重要，这是你自己思考的过程，当然你的设计肯定和人家差很多，但是，这一步也是非常重要的）

3.设计了自己的框架之后，去官网看下这个框架的架构图，思考下为啥这样，对比你的设计，有啥不同，为啥他们会这样设计

4.看完架构图之后，也不要着急看源码，先看下这个框架的包结构，大致猜一下这些包结构和架构图哪一块能够对应上

5.先大致看几个平时常用的接口，看看接口的方法，不要看实现类，一般的实现类太多，没必要这么着急看

6.可以写一个简单的demo，根据架构图，一块一块的看，分析

总结四个字：**思考，验证**

**没有思考这个源码看下来会非常吃力的，而且收获也不是很大，一定要思考，再加上你的验证，基本就差不多了**

有了我上面的分析，我们来按照这个流程，来分析一下呗：

1.什么是mybatis

这个我就不过多介绍了，我们看下没有mybatis的时候，我们用jdbc那个年代可能需要做的事情吧

JDBC的时候我们需要做很多：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70][]

非常繁琐，有了mybatis之后，我们只需要写一个接口和配置一个xml（也可以写注解）就可以搞定，非常轻松

2.那我们怎样使用这个mybatis呢（详情可以看下这个官网：[https://mybatis.org/mybatis-3/zh/getting-started.html][https_mybatis.org_mybatis-3_zh_getting-started.html]）

下面这一段入门我就从官网copy一下，因为等下要用到这些东西

### 从 XML 中构建 SqlSessionFactory ###

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

>     String resource = "org/mybatis/example/mybatis-config.xml";
>     InputStream inputStream = Resources.getResourceAsStream(resource);
>     SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。后面会再探讨 XML 配置文件的详细内容，这里先给出一个简单的示例：

<?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>

当然，还有很多可以在 XML 文件中配置的选项，上面的示例仅罗列了最关键的部分。 注意 XML 头部的声明，它用来验证 XML 文档的正确性。environment 元素体中包含了事务管理和连接池的配置。mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息。

### 不使用 XML 构建 SqlSessionFactory ###

如果你更愿意直接从 Java 代码而不是 XML 文件中创建配置，或者想要创建你自己的配置建造器，MyBatis 也提供了完整的配置类，提供了所有与 XML 文件等价的配置项。

>     DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
>     TransactionFactory transactionFactory = new JdbcTransactionFactory();
>     Environment environment = new Environment("development", transactionFactory, dataSource);
>     Configuration configuration = new Configuration(environment);
>     configuration.addMapper(BlogMapper.class);
>     SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

注意该例中，configuration 添加了一个映射器类（mapper class）。映射器类是 Java 类，它们包含 SQL 映射注解从而避免依赖 XML 文件。不过，由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套联合映射），仍然需要使用 XML 配置。有鉴于此，如果存在一个同名 XML 配置文件，MyBatis 会自动查找并加载它（在这个例子中，基于类路径和 BlogMapper.class 的类名，会加载 BlogMapper.xml）。具体细节稍后讨论。

### 从 SqlSessionFactory 中获取 SqlSession ###

既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

try (SqlSession session = sqlSessionFactory.openSession()) {
      Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
    }

诚然，这种方式能够正常工作，对使用旧版本 MyBatis 的用户来说也比较熟悉。但现在有了一种更简洁的方式——使用和指定语句的参数和返回值相匹配的接口（比如 BlogMapper.class），现在你的代码不仅更清晰，更加类型安全，还不用担心可能出错的字符串字面值以及强制类型转换。

例如：

try (SqlSession session = sqlSessionFactory.openSession()) {
      BlogMapper mapper = session.getMapper(BlogMapper.class);
      Blog blog = mapper.selectBlog(101);
    }

这就可以使用mybatis了

如果对mybatis这样使用不是很熟悉的同学，麻烦自己动手实验几次，看了这个入门我们自己可以设计一下这个mybatis的架构设计（每个人看完这个入门后，设计可能都不相同，我们要开发自己的脑洞，去思考下）

我的简略设计架构图如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 1][]

首先我们需要有一个配置类，就是需要在mybatis配置的配置文件，要配置我的Enviroments 和DataSource，transactionManag，我的Mappers接口等

其次就是这一系列的执行过程，在这执行的过程可以搞一点，动态改变的拦截器，最后要有一个和spring整合的一个模块

3.我们可以看下mybatis的官方架构图吧

从网上找了一个：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 2][]

他这个架构图更细致，我们设计的那个架构图，只能要草图来形容，不过整体设计还是差不多的。

4.我们看下Mybatis包的结构图和架构图的对应部分吧

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 3][]

我们可以大致猜测一每个包都是啥功能吧

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 4][]

我就不一一标注了，我觉得大家可以大胆的猜测一下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 5][]

今天的架构设计先暂时到这。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200531232633900.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70
[https_mybatis.org_mybatis-3_zh_getting-started.html]: https://mybatis.org/mybatis-3/zh/getting-started.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200531235349529.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200531235939156.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200601000219670.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200601000455275.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200601000534993.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29sZHNoYXVp,size_16,color_FFFFFF,t_70