MyBatis 学习笔记

什么是Mybatis

MyBatis 是一款优秀的持久层框架，是Apache的一个Java开源项目 ，它支持自定义 SQL、存储过程以及高级映射， 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。 MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO为数据库中的记录。

• 原名 iBatis，在由 Apache 迁移到了谷歌，更名为 MyBatis。因此，MyBatis 指的就是 iBatis 3.x 后的版本
• 采用 ORM（Object Relational Mapping，对象关系映射）思想实现的持久化层框架。而之前学习的 JDBC 只是一种规范，JdbcTemplate 和 DBUtil 都是简单封装了 JDBC 的工具类

---

Mybatis和Hibernate的关联

1. Hibernate是全自动全映射的ORM框架，使用HQL来定制SQL；而Mybatis是半自动的
2. Hibernate会自动映射对象属性和数据库字段，自动生产SQL语句，供直接调用，但同样因为此，Hibernate难以优化SQL，且学习HQL的成本较高
3. Mybatis以配置文件或注解的方式编写SQL，仅封装了预编译、设置参数、执行SQL、封装结果等操作， 只需要掌握 SQL 和 MyBatis 相关配置就可以使用，学习成本相对更低

安装

目前Mybatis能够在githup上直接下载

https://github.com/mybatis/mybatis-3/releases

要使用Mybatis只需要将 mybatis-xxx.jar 文件置于类路径(classpath)中即可。

maven依赖如下（除了mybatis外，还需要导入和数据库版本适配的驱动包）

<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>

<!-- database connector  -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.17</version>
</dependency>

构建全局配置文件

创建 mybatis-config.xml 配置文件，一般直接置于resource目录下。

该文件包含了对Mybatis系统的核心设置，包括获取数据库连接实例的数据源(DataSource)、决定事务作用域和控制方式的事务管理器(TransactionManager)。

首先简单配置如下：

<?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>
    <!-- 和spring整合后 environments配置将废除 -->
    <!--环境配置，可以配置多个，根据id选择默认环境 -->
  <environments default="development">
    <environment id="development">
        <!-- 使用JDBC事务管理 -->
      <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>
    <!-- 配置文件映射，指定配置文件的位置，每个mapper都需要在核心配置文件中注册后才可使用 -->
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

• environment 元素体中包含了事务管理和连接池的配置
• mappers元素则包含了一组映射器(mapper)，这些映射器的 XML文件包含了SQL代码和映射定义信息

通过配置文件构建Utils类

每个基于Mybatis的应用都是以一个SqlSessionFactory的实例为核心的。

而SqlSessionFactory的实例则可以通过SqlSessionFactoryBuilder获得。

而SqlSessionFactoryBuilder则可以从XML配置文件中构建

示例代码如下：

public class MybatisUtils {
    // 声明静态属性
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            // 获取核心配置文件路径
            String resource = "mybatis-config.xml";
            // 封装为字节流
            InputStream inputStream = Resources.getResourceAsStream(resource);
            // 创建根据核心文件创建对象
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取SqlSession对象
     */
    public static SqlSession getSqlSession() {
           // 根据工厂类创建SqlSession对象并返回
        return sqlSessionFactory.openSession();
    }

创建测试类

创建POJO对象

public class User {
    private int id;
    private String name;
    private String pwd;

    /**
    *  加上对应的构造方法、getters&setters、toString()
    */
}

创建持久层接口

public interface UserMapper {
    User getUserById(int id);
}

创建对应的XML映射文件

<?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">
<!-- namespace 命名空间，绑定一个对应的 Mapper 接口，且为全限定类名 -->
<mapper namespace="com.kuang.dao.UserMapper">
    <!-- id 为指定接口的方法，parameterType为传入参数类型，resultType为返回值类型 -->
    <select id="getUserById" parameterType="int" resultType="com.kuang.pojo.User">
        select * from user user where id = #{id}
    </select>

</mapper>

在核心配置文件中注册

<mappers>
    <mapper resource="com/kuang/dao/UserMapper.xml"/>
</mappers>

测试

使用Junit进行测试

@Test
public void test3() {
    // 调用自己编写的工具类获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    // 传入接口的字节码文件，创建代理对象
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    // 执行方法，并传入参数
    User u = userMapper.getUserById(1);
    // 打印
    System.out.println(u);
    // 释放资源
    sqlSession.close();
}

详解

具体步骤如下：

1. 通过字节流加载 核心配置文件(即 mybatis-config.xml)
2. 使用SqlSessionFactoryBuilder读取输入流，并创建处SqlSessionFactory
3. 使用SqlSessionFactory创建SqlSession
4. 使用SqlSession创建代理对象(即 mapper)
5. 通过代理对象调用方法并获取查询结果
6. 释放资源

和传统JDBC写法比较

MyBatis

JDBC

连接池技术管理

手动地、频繁地创建和释放连接，浪费系统资源

SQL和代码分离，易于维护

SQL经常变动，字符串拼接繁琐且容易出错

自动将java对象映射到sql语句，自动实现结果封装

SQL语句的set内容、where条件都不一定，参数个数不明确，十分麻烦，且需要手动遍历封装

作用域和生命周期

SqlSessionFactoryBuilder

• 这个类可以被实例化、使用和丢弃，一旦创建了SqlSessionFactory后就不需要它了
• 最佳作用域是方法作用域（局部方法作用域）
• 没必要长期保留该对象，以保证所有的XML解析资源可以被释放

SqlSessionFactory

• 一旦被创建就应该在应用运行期间一直存在，不应该重复创建
• 最佳作用域是应用作用域，可使用单例模式或静态单例模式创造

SqlSession

• SqlSession的实例不是线程安全的，因此不能共享，即每个线程都应该有一个它自己的SqlSession实例
• 它的最佳作用域是请求或方法作用域，绝不能将SqlSession实例的引用放在一个类的静态域或实例变量
• 对SqlSession的关闭很重要，应该把关闭操作放到 finally块中，或者使用 try-with-source 方法获取

映射器实例

• 映射器是一些绑定映射语句的接口，接口实例从SqlSession中获得

• 合适的作用域是方法作用域，即映射器应该在调用它们的方法中被获取，使用完毕后即丢弃

MyBatis的配置文件十分重要！

结构

• configuration（配置）

  • properties（属性）

  • settings（设置）

  • typeAliases（类型别名）

  • typeHandlers（类型处理器）

  • objectFactory（对象工厂）

  • plugins（插件）

  • environments（环境配置）

    • environment（环境变量）

      • transactionManager（事务管理器）
      • dataSource（数据源）

  • databaseIdProvider（数据库厂商标识）

  • mappers（映射器）

Properties（属性）

外部文件

<properties resource="db.properties">
    <property name="username" value="root"/>
    <property name="password" value="zhao"/>
</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都会被替换

属性加载顺序

1. 首先读取在 properties 元素体内指定的属性
2. 然后根据 properties 元素中的 resource属性或url属性读取外部文件，并覆盖掉之前读取过的同名属性
3. 最后读取作为方法参数传递的属性，覆盖掉之前读取过的同名属性

综上，优先级排名：方法参数 > 外部文件 > 大于核心配置文件

设置默认值

从MyBatis3.4.2开始，可以为占位符指定一个默认的值，如：

<dataSource type="POOLED">
      <property name="username" value="${username:ut_user}"/> <!-- 如果属性 'username' 没有被配置，'username' 属性的值将为 'ut_user' -->
</dataSource>

该特性默认关闭，若要使用，需先配置，如：

<properties resource="org/mybatis/example/config.properties">
      <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 启用默认值特性 -->
</properties>

但开启后，如果在属性命名中用到了 “:”，它就会被识别为默认值分隔符，鉴于 “:”，在三元运算等诸多场合都会被用到，所以需要修改默认值分隔符，也就是说，令找一种表示方式来代替 “:”，如

<properties resource="org/mybatis/example/config.properties">
      <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> <!-- 修改默认值的分隔符 -->
</properties>

<!-- 此时在属性获取内容处，应表达如下-->
<dataSource type="POOLED">
  <property name="username" value="${db:username?:ut_user}"/>
</dataSource>

Settings（设置）

这是MyBatis中极为重要的调整，会改变MyBatis的运行时行为。

设置名

描述

有效值

默认值

cacheEnabled

全局性地开启或关闭缓存

true | false

true

lazyLoadingEnabled

设置延迟加载，关联关系可通过设置 fetchType 属性来覆盖

true | false

false

aggressiveLazyLoading

任何方法调用都会加载该对象的所有延迟加载属性，否则延迟加载属性按需加载

true | false

false

multipleResultSetsEnabled

单个语句返回多个结果集

true | false

true

useColumnLabel

使用列标签代替列名

true | false

true

useGeneratedKeys

允许JDBC支持自动生成主键

true | false

false

autoMappingBehavior

自动将列映射到字段或属性
NONE：关闭自动映射
PARTIAL：自动映射没有定义嵌套结果映射的字段
FULL：自动映射任何复杂的结果集

NONE, PARTIAL, FULL

PARTIAL

autoMappingUnknownColumnBehavior

指定发现自动映射目标未知列的行为
NONE：不做任何反应
WARNING：输出警告日志
FAILING：映射失败

NONE, WARNING, FAILING

NONE

defaultExecutorType

配置默认执行器
SIMPLE：普通执行器
REUSE：重用预处理语句（PreparedStatement）
BATCH：既重用语句又批量更新

SIMPLE, REUSE, BATCH

SIMPLE

defaultStatementTimeout

超时时间

任意正整数

null

defaultFetchSize

为驱动的结果集获取数量（fetchSize）设定一个建议值

任意正整数

null

defaultResultSetType

指定语句默认的滚动策略

FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（即未设置）

null

safeRowBoundsEnabled

是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false

true | false

false

sageResultHandlerEnabled

是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false

true | false

false

mapUnderscoreToCamelCase

是否开启驼峰命名自动映射

true | false

false

localCacheScope

本地缓存机制的类型
SESSION：缓存一个会话中执行的所有查询
STATEMENT：仅对单个语句执行进行缓存，但对相同SqlSession的不同查询不会缓存

SESSION | STATEMENT

SESSION

jdbcTypeForNull

指定列的JDBC类型

JDBC常量，如：NULL, VARCHAR, OTHER

OTHER

lazyloadTriggerMethods

指定对象触发延迟加载的条件

用逗号分隔的方法列表

equals, clone, hashCode, toString

defaultScriptingLanguage

指定动态SQL生成使用的默认脚步语言

类型别名或全类名

org.apache.ibatis.scripting.xmltags.XMLLanguageDriver

defaultEnumTypeHandler

指定 Enum使用的默认 TyperHandlder

类型别名或全类名

org.apache.ibatis.type.EnumTypeHandler

callSettersOnNulls

指定当结果集中值为null时是否调用映射对象的 setter 方法（基本类型不能设置为null）

true | false

false

returnInstanceForEmptyRow

当返回行的所有列都是空时，MyBatis默认返回空实例对象

true | false

false

logPrefix

指定MyBatis增加到日志名称的前缀

任何字符串

null

logImpl

指定MyBatis所用日志的具体实现，未指定时自动查找

SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING

null

proxyFactory

指定MyBatis创建可延迟加载对象多用到的代理工具

CGLIB | JAVASSIST

JAVASSIST

vfsImpl

指定 VFS 的实现

自定义 VFS 的实现类全类名，以逗号分隔

null

useActualParamName

允许使用方法签名中的名称作为语句参数名称

true | false

true

configurationFactory

指定一个提供 Configuration 实例的类，用来加载被反序列化对象的延迟加载属性值（该类必须包含一个 static Configuration getConfiguration()方法）

类的别名或全类名

null

shrinkWhitespacesInSql

从SQL中删除多余的空格（会影响SQL中的文字字符串）

true | false

false

defaultSqlProviderType

指定一个类作为SQL语句提供类，需使用 @SelectProvider注解

类的别名或全类名

null

<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

typeAliases（类型别名）

给Java类型设置一个缩写的名字，仅用于XML配置，可减少重复，例：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

也可以指定一个包名，MyBatis会在包名下面自动搜索需要的Java类型，此时会使用类的首字母小写的类名作为别名。例：

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

此时也可以单独给类设置别名，使用 @Alias注解

@Alias("author")
public class Author {
    ...
}

常见的Java类型别名（不区分大小写）：

别名

映射类型

_byte

byte

_long

long

_short

short

_int | _integer

int

_double

double

_float

float

_boolean

boolean

string

String

byte

Byte

long

Long

short

Short

int | integer

Integer

double

Double

float

Float

boolean

Boolean

date

Date

decimal | bigdecimal

BigDecimal

object

Object

map

Map

hashmap

HashMap

list

List

arraylist

ArrayList

collection

Collection

iterator

Iterator

typeHandlers（类型处理器）

类型处理器用于将获取到的值转换为Java类型

类型处理器

Java类型

JDBC类型

BooleanTypeHandler

Boolean | boolean

BOOLEAN

ByteTypeHandler

Byte | byte

BYTE | NUMERIC

ShortTypeHandler

Short | short

SMALLINT | NUMERIC

IntegerTypeHandler

Integer | int

INTEGER | NUMERIC

LongTypeHandler

Long | long

BIGINT | NUMERIC

FloatTypeHandler

Float | float

FLOAT | NUMERIC

DoubleTypeHandler

Double | double

DOUBLE | NUMERIC

BigDecimalTypeHandler

BigDecimal

DECIMAL | NUMERIC

StringTypeHandler

String

CHAR | VARCHAR

ClobReaderTypeHandler

Reader

-

ClobTypeHandler

String

CLOB | LONGVARCHAR

NStringTypeHandler

String

NVARCHAR | NCHAR

NClobTypeHandler

String

NCLOB

BlobInputStreamTypeHandler

InputStream

-

ByteArrayTypeHandler

byte[ ]

数据库兼容的字节流类型

BlobTypeHandler

byte[ ]

BLOB | LONGVARBINARY

DateTypeHandler

Date

TIMESTAMP

DateOnlyTypeHandler

Date

DATE

TimeOnlyTypeHandler

Date

TIME

SqlTimestampTypeHandler

Timestamp

TIMESTAMP

SqlDateTypeHandler

Date

DATE

SqlTimeTypeHandler

Time

TIME

ObjectTypeHandler

Any

-

EnumTypeHandler

Enumeration Type

VARCHAR或任何能兼容的字符串类型，用来存储枚举的名称

EnumOrdinalTypeHandler

Enumeration Type

兼容 NUMERIC 或 DOUBLE 类型，用来存储枚举的序数值

SqlxmlTypeHandler

String

SQLXML

InstantTypeHandler

Instant

TIMESTAMP

LocalDateTimeTypeHandler

LocalDateTime

TIMESTAMP

LoalDateTypeHandler

LocalDate

DATE

LocalTimeTypeHandler

LocalTime

TIME

OffsetDateTimeTypeHandler

OffsetDateTime

TIMESTAMP

OffsetTimeTypeHandler

OffsetTime

TIME

ZonedDateTimeTypeHandler

ZonedDateTime

TIMESTAMP

YearTypeHandler

Year

INTEGER

MonthTypeHandler

Month

INTEGER

YearMonthTypeHandler

YearMonth

VARCHAR | LONGVARCHAR

JapaneseDateTypeHandler

JapaneseDate

DATE

objectFactory（对象工厂）

每次MyBatis创建结果对象的新实例时，都会使用一个对象工厂实例来完成实例化工作。

如果想要覆盖对象工厂的默认行为，可以通过创建自己的对象工厂来实现，

• 创建实例的方法 create()，包括无参构造和有参构造

• 配置工厂的方法 setProperties()，在初始化ObjectFactory后，元素体中定义的属性会作为参数传递过来

  public class ExampleObjectFactory extends DefaultObjectFactory {
  public Object create(Class type) {
  return super.create(type);
  }
  public Object create(Class type, List constructorArgTypes, List