MyBatis基础知识汇总

文章目录

• • MyBatis简介
  • • 简介
    • MyBatis历史
    • 为什么要用MyBatis？
  • MyBatis入门
  • • 安装
    • 从XML中构建SqlSessionFactory
    • 不使用 XML 构建 SqlSessionFactory
    • 从 SqlSessionFactory 中获取 SqlSession
    • 探究已映射的 SQL 语句
    • 命名空间
    • 作用域（Scope）和生命周期
    • 映射器实例（Mapper Instances）
    • Mybatis操作数据库
  • MyBatis-全局配置文件
  • • Properties属性
    • settings设置
    • typeAliases别名处理器
    • typeHandlers类型处理器
    • 事务管理器（transactionManager）
    • 数据源（dataSource）
    • 映射器（mappers）
    • • 使用相对于类路径的资源引用
      • 使用完全限定资源定位符（URL）
      • 使用映射器接口实现类的完全限定类名
      • 将包内的映射器接口实现全部注册为映射器
  • MyBatis-映射文件
  • • 更新（insert, update 和 delete）
    • • 主键生成方式
    • 参数（Parameters）
    • • 参数（Parameters）传递
      • 参数处理
    • select元素
    • 自动映射
    • resultMap
    • id&result
  • MyBatis-动态SQL
  • • if
    • choose（when，otherwise）
  • MyBatis-缓存机制
  • • 一级缓存
    • 一级缓存演示&失效情况
    • 二级缓存
    • 缓存属性
    • 缓存有关设置

MyBatis简介

简介

• MyBatis是支持定制化SQL、存储过程以及高级映射的优秀的持久层框架。
• MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。
• MyBatis可以使用简单的XML或者注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录。

MyBatis历史

• 原是Apache的一个开源项目iBatis，2010年6月这个项目由Apache Software Foundation迁移到了Google Code，随着开发团队转投Google Code旗下，iBatis3.x正式更名为MyBatis，代码于2013年11 月迁移到Github
• iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）

为什么要用MyBatis？

1) MyBatis是一个半自动化的持久层框架。

2) JDBC

（1） SQL夹在Java代码块里，耦合度高导致硬编码内伤

（2） 维护不易且实际开发需求中sql是有变化，频繁修改的情况多见

3) Hibernate和JPA

（1） 长难复杂SQL，对于Hibernate而言处理也不容易

（2） 内部自动生产的SQL，不容易做特殊优化

（3） 基于全映射的全自动框架，大量字段的POJO进行部分映射时比较困难。导致数据库性能下降。

4) 对开发人员而言，核心sql还是需要自己优化

5) sql和java编码分开，功能边界清晰，一个专注业务、一个专注数据。

MyBatis入门

安装

• 要使用MyBatis，只需将[mybatis-x.x.x.jar]文件置于classpath中即可。
• 如果使用Maven来构建项目，则需将下面的dependency代码置于pom.xml文件中：

  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>x.x.x</version>
  </dependency>
             

从XML中构建SqlSessionFactory

• 每个基于MyBatis的应用都是以一个SqlSessionFactory的实例为中心的。
• SqlSessionFactory的实例可以通过SqlSessionFactoryBuilder获得。而SqlSessionFactoryBuilder则可以从XML配置文件或一个预先定制的Configuration的实例构建出SqlSessionFactory的实例。
• 从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。但是也可以使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，可使从 classpath 或其他位置加载资源文件更加容易。

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

• XML 配置文件（configuration 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 映射器（这些 mapper 的 XML 文件包含了 SQL 代码和映射定义信息）。

不使用 XML 构建 SqlSessionFactory

• 如果你更愿意直接从 Java 程序而不是 XML 文件中创建 configuration，或者创建你自己的 configuration 构建器，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 映射对于大多数高级映射（比如：嵌套 Join 映射）来说仍然是必须的。有鉴于此，如果存在一个对等的 XML 配置文件的话，MyBatis 会自动查找并加载它（这种情况下， BlogMapper.xml 将会基于类路径和 BlogMapper.class 的类名被加载进来）

从 SqlSessionFactory 中获取 SqlSession

• 既然有了 SqlSessionFactory ，顾名思义，就可以从中获得 SqlSession 的实例了
• SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法
• 可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

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

• 诚然这种方式能够正常工作，并且对于使用旧版本 MyBatis 的用户来说也比较熟悉，不过现在有了一种更直白的方式。使用对于给定语句能够合理描述参数和返回值的接口（比如说BlogMapper.class），你现在不但可以执行更清晰和类型安全的代码，而且还不用担心易错的字符串字面值以及强制类型转换。

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

探究已映射的 SQL 语句

• 在上面提到的两个例子中，一个语句应该是通过 XML 定义，而另外一个则是通过注解定义。先看 XML 定义这个，事实上 MyBatis 提供的全部特性可以利用基于 XML 的映射语言来实现，这使得 MyBatis 在过去的数年间得以流行。如果以前用过 MyBatis，这个概念应该会比较熟悉。不过 XML 映射文件已经有了很多的改进，随着文档的进行会愈发清晰。这里给出一个基于 XML 映射语句的示例，它应该可以满足上述示例中 SqlSession 的调用。

  <?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">
  <mapper namespace="org.mybatis.example.BlogMapper">
    <select id="selectBlog" resultType="Blog">
      select * from Blog where id = #{id}
    </select>
  </mapper>
             

• 对于这个简单的例子来说似乎有点小题大做了，但实际上它是非常轻量级的。在一个 XML 映射文件中，你想定义多少个映射语句都是可以的，这样下来，XML 头部和文档类型声明占去的部分就显得微不足道了。文件的剩余部分具有很好的自解释性。在命名空间“org.mybatis.example.BlogMapper”中定义了一个名为“selectBlog”的映射语句，这样它就允许你使用指定的完全限定名“org.mybatis.example.BlogMapper.selectBlog”来调用映射语句，就像上面的例子中做的那样：
• 注意到这和使用完全限定名调用 Java 对象的方法是相似的，之所以这样做是有原因的。这个命名可以直接映射到在命名空间中同名的 Mapper 类，并将已映射的 select 语句中的名字、参数和返回类型匹配成方法。这样你就可以像上面那样很容易地调用这个对应 Mapper 接口的方法。不过让我们再看一遍下面的例子：

  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
             

• 第二种方法有很多优势，首先它不是基于字符串常量的，就会更安全；其次，如果你的 IDE 有代码补全功能，那么你可以在有了已映射 SQL 语句的基础之上利用这个功能。

命名空间

• 命名空间（Namespaces）在之前版本的 MyBatis 中是可选的，这样容易引起混淆因此毫无益处。现在命名空间则是必须的，且意于简单地用更长的完全限定名来隔离语句
• 命名空间使得所见到的接口绑定成为可能，尽管你觉得这些东西未必用得上，你还是应该遵循这里的规定以防哪天你改变了主意。出于长远考虑，使用命名空间，并将它置于合适的 Java 包命名空间之下，你将拥有一份更加整洁的代码并提高了 MyBatis 的可用性
• **命名解析：**为了减少输入量，MyBatis 对所有的命名配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则
  1. 完全限定名（比如“commypackage.MyMapper.selectAllThings”）将被直接查找并且找到即用
  2. 短名称（比如“selectAllThings”）如果全局唯一也可以作为一个单独的引用。如果不唯一，有两个或两个以上的相同名称（比如“com.foo.selectAllThings ”和“com.bar.selectAllThings”），那么使用时就会收到错误报告说短名称是不唯一的，这种情况下就必须使用完全限定名
• 对于像 BlogMapper 这样的映射器类（Mapper class）来说，还有另一招来处理。它们的映射的语句可以不需要用 XML 来做，取而代之的是可以使用 Java 注解。比如，上面的 XML 示例可被替换如下：

  package org.mybatis.example;
  public interface BlogMapper {
    @Select("SELECT * FROM blog WHERE id = #{id}")
    Blog selectBlog(int id);
  }
             

• 对于简单语句来说，注解使代码显得更加简洁，然而 Java 注解对于稍微复杂的语句就会力不从心并且会显得更加混乱。因此，如果你需要做很复杂的事情，那么最好使用 XML 来映射语句
• 选择何种方式以及映射语句的定义的一致性对你来说有多重要这些完全取决于你和你的团队。换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换。

作用域（Scope）和生命周期

理解目前已经讨论过的不同作用域和生命周期类是至关重要的，因为错误的使用会导致非常严重的并发问题。

• 对象生命周期和依赖注入框架
  • 依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器（mapper）并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。如果对如何通过依赖注入框架来使用 MyBatis 感兴趣可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。

1) SqlSessionFactoryBuilder

• 这个类可以被实例化、使用和丢弃，一旦创建了SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。
• 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但是最好还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。

2) SqlSessionFactory

• SqlSessionFactory一旦被创建就应该在应用的运行期间一直存在，没有任何理由对它进行清除或重建。
• 使用SqlSessionFactory的最佳实践是在应用运行期间不要重复创建多次，多次重建SqlSessionFactory被视为一种代码“坏味道（bad smell）”。因此SqlSessionFactory 的最佳作用域是应用作用域。
• 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

3) SqlSession

• 每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
• 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。也绝不能将 SqlSession 实例的引用放在任何类型的管理作用域中，比如 Servlet 架构中的 HttpSession。如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。下面的示例就是一个确保 SqlSession 关闭的标准模式：

  SqlSession session = sqlSessionFactory.openSession();
  try {
    // do work
  } finally {
    session.close();
  }
             

• 在你的所有的代码中一致性地使用这种模式来保证所有数据库资源都能被正确地关闭。

映射器实例（Mapper Instances）

• 映射器是一个创建来绑定映射的语句的接口
• 映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲，任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。
• 尽管如此，映射器实例的最佳作用域是方法作用域。也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可废弃。并不需要显式地关闭映射器实例，尽管在整个请求作用域（request scope）保持映射器实例也不会有什么问题，但是很快你会发现，像 SqlSession 一样，在这个作用域上管理太多的资源的话会难于控制。所以要保持简单，最好把映射器放在方法作用域（method scope）内。下面的示例就展示了这个实践：

  SqlSession session = sqlSessionFactory.openSession();
  try {
    BlogMapper mapper = session.getMapper(BlogMapper.class);
    // do work
  } finally {
    session.close();
  }
             

Mybatis操作数据库

1) 创建MyBatis全局配置文件

• MyBatis的全局配置文件包含了影响MyBatis行为甚深的设置（settings）和属性（properties）信息、如数据库连接池信息等。指导着MyBatis进行工作。我们可以参照官方文件的配置示例。

2) 创建SQL映射文件

• 映射文件的作用就相当于是定义Dao接口的实现类如何工作。这也是我们使用MyBatis时编写的最多的文件。

MyBatis-全局配置文件

MyBatis的配置文件包含了影响MyBatis行为的设置（settings）和属性（properties）信息。文档的顶层结构如下：

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);
  
  // ... or ...
  
  SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);
             

• 如果属性在不只一个地方进行了配置，那么 MyBatis 将按照下面的顺序来加载：
  1. 在 properties 元素体内指定的属性首先被读取
  2. 然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性
  3. 最后读取作为方法参数传递的属性，并覆盖已读取的同名属性
• 因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的是 properties 属性中指定的属性。

settings设置

• 这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。

设置参数	描述	有效值	默认值
cacheEnabled	全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存。	true | false	TRUE
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态。	true | false	FALSE
useColumnLabel	使用列标签代替列名。不同的驱动在这方面会有不同的表现， 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。	true | false	TRUE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数。	任意正整数	Not Set (null)
mapUnderscoreToCamelCase	是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。	true | false	FALSE

• 一个配置完整的 settings 元素的示例如下：

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

• 当这样配置时，Blog可以用在任何使用

  domain.blog.Blog

  的地方。
• 也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如:

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

• 每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author；若有注解，则别名为其注解值。看下面的例子：

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

• 值得注意的是，MyBatis已经为许多常见的Java类型内建了相应的类型别名。他们都是大小写敏感的，我们在起别名的时候千万不要占用已有的别名

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

typeHandlers类型处理器

• 无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。

类型处理器	Java 类型	JDBC 类型
BooleanTypeHandler	java.lang.Boolean, boolean	数据库兼容的 BOOLEAN
ByteTypeHandler	java.lang.Byte, byte	数据库兼容的 NUMERIC 或 BYTE
ShortTypeHandler	java.lang.Short, short	数据库兼容的 NUMERIC 或 SHORT INTEGER
IntegerTypeHandler	java.lang.Integer, int	数据库兼容的 NUMERIC 或 INTEGER
LongTypeHandler	java.lang.Long, long	数据库兼容的 NUMERIC 或 LONG INTEGER
FloatTypeHandler	java.lang.Float, float	数据库兼容的 NUMERIC 或 FLOAT
DoubleTypeHandler	java.lang.Double, double	数据库兼容的 NUMERIC 或 DOUBLE
BigDecimalTypeHandler	java.math.BigDecimal	数据库兼容的 NUMERIC 或 DECIMAL
StringTypeHandler	java.lang.String	CHAR, VARCHAR
DateTypeHandler	java.util.Date	TIMESTAMP
DateOnlyTypeHandler	java.util.Date	DATE
TimeOnlyTypeHandler	java.util.Date	TIME

事务管理器（transactionManager）

• 在 MyBatis 中有两种类型的事务管理器（也就是 type=”[JDBC|MANAGED]”）
  1. JDBC：这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域
  2. MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。例如:

     <transactionManager type="MANAGED">
       <property name="closeConnection" value="false"/>
     </transactionManager>
                

• 提示：如果正在使用 Spring + MyBatis，则没有必要配置事务管理器， 因为 Spring 模块会使用自带的管理器来覆盖前面的配置。
• 这两种事务管理器类型都不需要任何属性。它们不过是类型别名，换句话说，可以使用

  TransactionFactory

  接口的实现类的完全限定名或类型别名代替它们。

  public interface TransactionFactory {
    void setProperties(Properties props);  
    Transaction newTransaction(Connection conn);
    Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);  
  }
             

• 任何在 XML 中配置的属性在实例化之后将会被传递给 setProperties() 方法。你也需要创建一个 Transaction 接口的实现类，这个接口也很简单：

  public interface Transaction {
    Connection getConnection() throws SQLException;
    void commit() throws SQLException;
    void rollback() throws SQLException;
    void close() throws SQLException;
    Integer getTimeout() throws SQLException;
  }
             

• 使用这两个接口，你可以完全自定义 MyBatis 对事务的处理。

数据源（dataSource）

• dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。
• 许多 MyBatis 的应用程序会按示例中的例子来配置数据源。虽然这是可选的，但为了使用延迟加载，数据源是必须配置的。
• 有三种内建的数据源类型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）
  1. UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接。虽然有点慢，但对于在数据库连接可用性方面没有太高要求的简单应用程序来说，是一个很好的选择。 不同的数据库在性能方面的表现也是不一样的，对于某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：
     • driver – 这是 JDBC 驱动的 Java 类的完全限定名（并不是 JDBC 驱动中可能包含的数据源类）
     • url – 这是数据库的 JDBC URL 地址
     • username – 登录数据库的用户名
     • password – 登录数据库的密码
     • defaultTransactionIsolationLevel – 默认的连接事务隔离级别
     • 作为可选项，也可以传递属性给数据库驱动。要这样做，属性的前缀为“driver.”，例如： driver.encoding=UTF8
     • 这将通过 DriverManager.getConnection(url,driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动

1. POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。这是一种使得并发 Web 应用快速响应请求的流行处理方式。
   • 除了上述提到UNPOOLED下的属性外，还有更多属性用来配置 POOLED 的数据源
     • poolMaximumActiveConnections – 在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10
     • poolMaximumIdleConnections – 任意时间可能存在的空闲连接数
     • poolMaximumCheckoutTime – 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
     • poolTimeToWait – 这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）
     • poolMaximumLocalBadConnectionTolerance – 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程. 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3 (新增于 3.4.5)
     • poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息
     • poolPingEnabled – 是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false
     • poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）
2. JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：
   • initial_context – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么 data_source 属性将会直接从 InitialContext 中寻找
   • data_source – 这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找
   • 和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给初始上下文。比如：
     • env.encoding=UTF8 这就会在初始上下文（InitialContext）实例化时往它的构造方法传递值为 UTF8 的 encoding 属性

映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，现在就要定义 SQL 映射语句了。但是首先需要告诉 MyBatis 到哪里去找到这些语句。 Java 在自动查找这方面没有提供一个很好的方法，所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用， 或完全限定资源定位符（包括 file:/// 的 URL），或类名和包名等。例如：

使用相对于类路径的资源引用

<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>
           

使用完全限定资源定位符（URL）

<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>
           

使用映射器接口实现类的完全限定类名

<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
           

将包内的映射器接口实现全部注册为映射器

<mappers>
  <package name="org.mybatis.builder"/>
</mappers>
           

这些配置会告诉了 MyBatis 去哪里找映射文件，剩下的细节就应该是每个 SQL 映射文件了

MyBatis-映射文件

• MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好
• 映射文件指导着MyBatis如何进行数据库增删改查，有着非常重要的意义
• SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）
  1. cache – 给定命名空间的缓存配置
  2. cache-ref – 其他命名空间缓存配置的引用
  3. resultMap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
  4. sql – 可被其他语句引用的可重用语句块
  5. insert – 映射插入语句
  6. update – 映射更新语句
  7. delete – 映射删除语句
  8. select – 映射查询语句

更新（insert, update 和 delete）

• 数据变更语句 insert，update 和 delete 的实现非常接近：

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">
</insert> 

<update
  id="updateAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">
</update> 

<delete
  id="deleteAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">
</delete>
           

Insert、update、delete属性

属性	描述
id	命名空间中的唯一标识符，可被用来代表这条语句。
parameterType	将要传入语句的参数的完全限定类名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
flushCache	将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句）。
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
statementType	STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
useGeneratedKeys	（仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。
keyProperty	（仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
keyColumn	（仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
databaseId	如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。

主键生成方式

• 如果你的数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），那么你可以设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性上
• 例如，如果上面的 Author 表已经对 id 使用了自动生成的列类型，那么语句可以修改为:

  <insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
    insert into Author (username,password,email,bio)
    values (#{username},#{password},#{email},#{bio})
  </insert>
             

• 而对于不支持自增型主键的数据库（例如Oracle），则可以使用selectKey子元素：selectKey元素将会首先运行，id会被设置，然后插入语句会被调用

  <insert id="insertAuthor">
    <selectKey keyProperty="id" resultType="int" order="BEFORE">
      select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
    </selectKey>
    insert into Author
     (id, username, password, email,bio, favourite_section)
    values
     (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
  </insert>
             

• 在上面的示例中，selectKey 元素将会首先运行，Author 的 id 会被设置，然后插入语句会被调用。这给你了一个和数据库中来处理自动生成的主键类似的行为，避免了使 Java 代码变得复杂
• selectKey 元素描述如下：

  <selectKey
    keyProperty="id"
    resultType="int"
    order="BEFORE"
    statementType="PREPARED">
             

• selectKey属性如下：

参数（Parameters）

参数（Parameters）传递

1) 单个参数

• 可以接受基本类型，对象类型，集合类型的值
• 这种情况MyBatis可直接使用这个参数，不需要经过任何处理。

2) 多个参数

• 任意多个参数，都会被MyBatis重新包装成一个Map传入。Map的key是param1，param2,0,1…，值就是参数的值。

3) 命名参数

• 为参数使用@Param起一个名字，MyBatis就会将这些参数封装进map中，key就是我们自己指定的名字

4) POJO

• 当这些参数属于我们业务POJO时，我们直接传递POJO

5) Map

• 我们也可以封装多个参数为map，直接传递

参数处理

参数也可以指定一个特殊的数据类型：

1. javaType通常可以从参数对象中来去确定
2. 如果null被当做值来传递，对于所有可能为空的列，jdbcType需要被设置
3. 对于数值类型，还可以设置小数点后保留的位数
4. mode属性允许指定IN，OUT或者INOUT参数。如果参数为OUT或INOUT，参数对象属性的真实值将会被改变，就像在获取输出参数时所期望的那样
5. 参数位置支持的属性

   javaType、jdbcType、mode、numericScale、resultMap、typeHandler、jdbcTypeName、expression

6. 实际上通常被设置的是：可能为空的列名指定jdbcType

7. #{key}

   获取参数的值，预编译到SQL中。安全

8. ${key}

   获取参数的值，拼接到SQL中。有SQL注入问题。ORDER BY ${name}

select元素

查询语句是 MyBatis 中最常用的元素之一，光能把数据存到数据库中价值并不大，如果还能重新取出来才有用，多数应用也都是查询比修改要频繁。对每个插入、更新或删除操作，通常对应多个查询操作。这是 MyBatis 的基本原则之一，也是将焦点和努力放到查询和结果映射的原因。简单查询的 select 元素是非常简单的。

1) Select元素来定义查询操作

2) Id：唯一标识符

用来引用这条语句，需要和接口的方法名一致

3) parameterType：参数类型

可以不传，MyBatis会根据typeHandler自动推断

4) resultType：返回值类型

别名或者全类名，如果返回的是集合，定义集合中元素的类型。不能和resultMap同时使用。

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
resultType	从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形，那应该是集合可以包含的类型，而不能是集合本身。使用 resultType 或 resultMap，但不能同时使用。
resultMap	外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性，对其有一个很好的理解的话，许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType，但不能同时使用。
flushCache	将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false。
useCache	将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true。
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
fetchSize	影响驱动程序每次批量返回的结果行数。默认值为 unset（依赖驱动）。
statementType	STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
resultSetType	FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）。
databaseId	**如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；**如果带或者不带的语句都有，则不带的会被忽略。
resultOrdered	这个设置仅针对嵌套结果 select 语句适用：如果为 true，就是假设包含了嵌套结果集或是分组了，这样的话当返回一个主结果行的时候，就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值：false。
resultSets	这个设置仅对多结果集的情况适用，它将列出语句执行后返回的结果集并每个结果集给一个名称，名称是逗号分隔的。

自动映射

1) 全局setting设置

• autoMappingBehavior默认是PARTIAL，开启自动映射的功能。唯一的要求是列名和javaBean属性名一致
• 如果autoMappingBehavior设置为null则会取消自动映射
• 数据库字段命名规范，POJO属性符合驼峰命名法，如A_COLUMN->aColumn，我们可以开启自动驼峰命名规则映射功能，mapUnderscoreToCamelCase=true

2) 自定义resultMap，实现高级结果集映射

resultMap

• constructor - 类在实例化时, 用来注入结果到构造方法中
  • idArg - ID 参数; 标记结果作为 ID 可以帮助提高整体效能
  • arg - 注入到构造方法的一个普通结果
• id – 一个 ID 结果; 标记结果作为 ID 可以帮助提高整体效能
• result – 注入到字段或 JavaBean 属性的普通结果
• association – 一个复杂的类型关联;许多结果将包成这种类型；嵌入结果映射 – 结果映射自身的关联,或者参考一个
• collection – 复杂类型的集；嵌入结果映射 – 结果映射自身的集,或者参考一个
• discriminator – 使用结果值来决定使用哪个结果映射
  • case – 基于某些值的结果映射
• 嵌入结果映射 – 这种情形结果也映射它本身,因此可以包含很多相同的元素,或者它可以参照一个外部的结果映射

id&result

id 和 result 映射一个单独列的值到简单数据类型(字符串,整型,双精度浮点数,日期等)的属性或字段。

property	映射到列结果的字段或属性，例如：“username"或"address.street.number”
column	数据表的列名，通常和resultSet.getString(columnName)的返回值一致
javaType	一个Java类的完全限定名，或一个类型别名。如果映射到一个JavaBean，MyBatis通常可以断定类型
jdbcType	JDBC类型是仅仅需要对插入、更新和删除操作可能为空的列进行处理
typeHandler	类型处理器，使用这个属性，可以覆盖默认的类型处理器，这个属性值是类的完全限定名或者是一个类型处理器的实现。或者是类型别名

MyBatis-动态SQL

• 动态 SQL是MyBatis强大特性之一。极大的简化我们拼装SQL的操作
• 动态 SQL 元素和使用 JSTL 或其他类似基于 XML 的文本处理器相似
• MyBatis 采用功能强大的基于 OGNL 的表达式来简化操作
  1. if
  2. choose (when, otherwise)
  3. trim (where, set)
  4. foreach

if

<select id="getEmpWhereIf" resultType="com.htzw.bean.Employee">
        select * from employee where
        <if test="id != null">
            id = #{id} and 
        </if>
        <if test="lastName != null and !&quot;&quot;.equals(lastName)">
            last_name =#{lastName} and 
        </if>
        <if test="gender ==0 or gender ==1">
            gender=#{gender}
        </if>
    </select>
           

choose（when，otherwise）

<select id="getEmpChoose" resultType="com.htzw.bean.Employee">
        select * from employee
        <where>
            <choose>
                <when test="id != null">
                    id=#{id}
                </when>
                <when test="lastName != null and !&quot;&quot;.equals(lastName)">
                last_name =#{lastName}                
                 </when>
                 <otherwise>
                     1=1
                 </otherwise>
            </choose>
        </where>        
    </select>
           

MyBatis-缓存机制

• MyBatis 包含一个非常强大的查询缓存特性,它可以非常方便地配置和定制。缓存可以极大的提升查询效率
• MyBatis系统中默认定义了两级缓存
• 一级缓存和二级缓存
• 默认情况下，只有一级缓存（SqlSession级别的缓存，也称为本地缓存）开启
• 二级缓存需要手动开启和配置，他是基于namespace级别的缓存
• 为了提高扩展性。 MyBatis定义了缓存接口Cache。我们可以通过实现Cache接口来自定义二级缓存。

一级缓存

• 一级缓存(local cache)，即本地缓存, 作用域默认为sqlSession。当 Session flush 或 close 后, 该Session 中的所有 Cache 将被清空。
• 本地缓存不能被关闭, 但可以调用 clearCache()来清空本地缓存, 或者改变缓存的作用域。在mybatis3.1之后, 可以配置本地缓存的作用域。在 mybatis.xml 中配置

设置参数	描述	有效值	默认值
localCacheScope	MyBatis利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。**默认值为SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为STATEMENT，本地会话仅用在语句执行上，对相同SqlSession的不同调用将不会共享数据	SESSION | STATEMENT	SESSION

一级缓存演示&失效情况

• 同一次会话期间只要查询过的数据都会保存在当前SqlSession的一个Map中

  key：hashCode+查询的SqlId+编写的sql查询语句+参数

• 一级缓存失效的四种情况
  • 不同的SqlSession对应不同的一级缓存
  • 同一个SqlSession但是查询条件不同
  • 同一个SqlSession两次查询期间执行了任何一次增删改操作
  • 同一个SqlSession两次查询期间手动清空了缓存

二级缓存

1. 二级缓存(second level cache)，全局作用域缓存
2. 二级缓存默认不开启，需要手动配置
3. MyBatis提供二级缓存的接口以及实现，缓存实现要求
4. POJO实现Serializable接口
5. 二级缓存在 SqlSession 关闭或提交之后才会生效
6. 使用步骤
   1. 全局配置文件中开启二级缓存
   2. 需要使用二级缓存的映射文件处使用cache配置缓存
   3. 注意：POJO需要实现Serializable接口

缓存属性

1) eviction=“FIFO”：缓存回收策略：

• LRU – 最近最少使用的：移除最长时间不被使用的对象。

• FIFO – 先进先出：按对象进入缓存的顺序来移除它们。

• SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象。

• WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。

• 默认的是 LRU。

2) flushInterval：刷新间隔，单位毫秒

• 默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句时刷新

3) size：引用数目，正整数

• 代表缓存最多可以存储多少个对象，太大容易导致内存溢出

4) readOnly：只读，true/false

• true：只读缓存；会给所有调用者返回缓存对象的相同实例。 因此这些对象不能被修改。这提供了很重要的性能优势。

• false：读写缓存；会返回缓存对象的拷贝（通过序列化）。这会慢一些，但是安全，因此默认是 false。

缓存有关设置

1. 全局setting的cacheEnable
   • 配置二级缓存的开关。一级缓存一直是打开的。
2. select标签的useCache属性
   • 配置这个select是否使用二级缓存。一级缓存一直是使用的
3. sql标签的flushCache属性
   • 增删改默认flushCache=true。 sql执行以后，会同时清空一级和二级缓存
   • 查询默认flushCache=false
4. sqlSession.clearCache()
   • 只是用来清除一级缓存
5. 当在某一个作用域 (一级缓存Session/二级缓存Namespaces) 进行了 C/U/D 操作后，默认该作用域下所有 select 中的缓存将被clear