【设计模式精讲】开源实战之剖析MyBatis框架：MyBatis中的设计模式之Builder模式

文章目录
第七章开源实战
7.2 剖析MyBatis框架中用到的经典设计模式
7.2.1 MyBatis回顾
7.2.1.1 MyBatis与ORM框架
7.2.1.1 MyBatis的基础使用
7.2.2 MyBatis中使用到的设计模式
7.2.2.1 Builder模式

个人主页：道友老李
欢迎加入社区：道友老李的学习社区

第七章开源实战
7.2 剖析MyBatis框架中用到的经典设计模式
7.2.1 MyBatis回顾
7.2.1.1 MyBatis与ORM框架
MyBatis 是一个 ORM（Object Relational Mapping，对象 - 关系映射）框架。ORM 框架主要是根据类和数据库表之间的映射关系，帮助程序员自动实现对象与数据库中数据之间的互相转化。

ORM 负责将程序中的对象存储到数据库中、将数据库中的数据转化为程序中的对象

Mybatis架构

1、mybatis配置

SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。

mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。

2、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂

3、由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。

4、mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。

5、Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象，sql的id即是Mapped statement的id。

6、Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，输入参数映射就是jdbc编程中对preparedStatement设置参数。

7、Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中，输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
7.2.1.1 MyBatis的基础使用
因为 MyBatis 依赖 JDBC 驱动，所以，在项目中使用 MyBatis，除了需要引入 MyBatis 框架本身（mybatis.jar）之外，还需要引入 JDBC 驱动（比如，访问 MySQL 的 JDBC 驱动实现类库 mysql-connector-java.jar）。

导入MyBatis的坐标和其他相关坐标

<dependency>

<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>

</dependency>

<dependency>

<groupId>mysql</groupId>   
<artifactId>mysql-connector-java</artifactId>    
<version>5.1.6</version>    
<scope>runtime</scope>

</dependency>

<dependency>

<groupId>junit</groupId>    
<artifactId>junit</artifactId>    
<version>4.12</version>    
<scope>test</scope>

</dependency>

<dependency>

<groupId>log4j</groupId>    
<artifactId>log4j</artifactId>    
<version>1.2.17</version>

</dependency>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
创建user数据表
CREATE DATABASE mybatis_db;
USE mybatis_db;

CREATE TABLE user (
id int(11) NOT NULL auto_increment,
username varchar(32) NOT NULL COMMENT '用户名称',
birthday datetime default NULL COMMENT '生日',
sex char(1) default NULL COMMENT '性别',
address varchar(256) default NULL COMMENT '地址',
PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

-- insert.... 略
1
2
3
4
5
6
7
8
9
10
11
12
13
编写User实体
public class User {

private Integer id;
private String username;
private Date birthday;
private String sex;
private String address;
// getter/setter 略

}
1
2
3
4
5
6
7
8
编写UserMapper映射文件
public interface UserMapper {

public List<User> findAll();

}
1
2
3
4
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper

    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--查询所有-->
<select id="findAll" resultType="com.mashibing.domain.User">
    select * from user
</select>

</mapper>
1
2
3
4
5
6
7
8
9
10
编写MyBatis核心文件
<?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">

<!--环境配置-->
<environments default="mysql">
    <!--使用MySQL环境-->
    <environment id="mysql">
        <!--使用JDBC类型事务管理器-->
        <transactionManager type="JDBC"></transactionManager>
        <!--使用连接池-->
        <dataSource type="POOLED">
            <property name="driver" value="com.mysql.jdbc.Driver"></property>
            <property name="url" value="jdbc:mysql:///mybatis_test"></property>
            <property name="username" value="root"></property>
            <property name="password" value="123456"></property>
        </dataSource>
    </environment>
</environments>

<!--加载映射配置-->
<mappers>
    <mapper resource="com/mashibing/mapper/UserMapper.xml"></mapper>
</mappers>

</configuration>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
编写测试类
public class MainApp {

public static void main(String[] args) throws IOException {

    // 加载核心配置文件
    InputStream is = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 获取SqlSessionFactory工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
    // 获取SqlSession会话对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    // 执行sql
    List<User> list = sqlSession.selectList("com.mashibing.mapper.UserMapper.findAll");
    for (User user : list) {
        System.out.println(user);
    }
    // 释放资源
    sqlSession.close();
}

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
7.2.2 MyBatis中使用到的设计模式
7.2.2.1 Builder模式
Builder模式的定义是“将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示。”，它属于创建类模式，建造者模式可以将部件和其组装过程分开，一步一步创建一个复杂的对象。用户只需要指定复杂对象的类型就可以得到该对象，而无须知道其内部的具体构造细节。

《effective-java》中第2条也提到：遇到多个构造器参数时，考虑用构建者(Builder)模式。

在Mybatis环境的初始化过程中，SqlSessionFactoryBuilder会调用XMLConfigBuilder读取所有的MybatisMapConfig.xml和所有的*Mapper.xml文件，构建Mybatis运行的核心对象Configuration对象，然后将该Configuration对象作为参数构建一个SqlSessionFactory对象。

其中XMLConfigBuilder在构建Configuration对象时，也会调用XMLMapperBuilder用于读取*.Mapper文件，而XMLMapperBuilder会使用XMLStatementBuilder来读取和build所有的SQL语句。

在这个过程中，有一个相似的特点，就是这些Builder会读取文件或者配置，然后做大量的XpathParser解析、配置或语法的解析、反射生成对象、存入结果缓存等步骤，这么多的工作都不是一个构造函数所能包括的，因此大量采用了Builder模式来解决。

对于builder的具体类，方法都大都用build*开头，比如SqlSessionFactoryBuilder为例，它包含以下方法：

从建造者模式的设计初衷上来看，SqlSessionFactoryBuilder 虽然带有 Builder 后缀，但不要被它的名字所迷惑，它并不是标准的建造者模式。一方面，原始类 SqlSessionFactory 的构建只需要一个参数，并不复杂。

另一方面，Builder 类SqlSessionFactoryBuilder 仍然定义了多包含不同参数列表的构造函数。实际上，SqlSessionFactoryBuilder 设计的初衷只不过是为了简化开发。因为构建 SqlSessionFactory 需要先构建 Configuration，而构建 Configuration 是非常复杂的，需要做很多工作，比如配置的读取、解析、创建 n 多对象等。为了将构建 SqlSessionFactory 的过程隐藏起来，对程序员透明，MyBatis 就设计了 SqlSessionFactoryBuilder 类封装这些构建细节。

【设计模式精讲】开源实战之剖析MyBatis框架：MyBatis中的设计模式之Builder模式

唠叨的甘蔗

引用和评论

DeepSeek：探索AI前沿的先锋力量

Mybatis源码-缓存机制

Mybatis源码-插件的使用和原理

Mybatis-基础使用

Mybatis源码-加载映射文件与动态代理

Mybatis源码-配置加载

Mybatis源码-SqlSession获取