MyBatis3 教程 中文版

MyBatis 3 用户指南

从文档中复制代码的警告

是的，这不是一个法律上的警告，但是它可以帮助你保持清醒的认识。从美学上来讲，现代的文字处理工具在制作可读性强和格式良好的文本上做了大量的工作。然而，它们也往往会由于插入特殊字符而完全破坏代码示例，有时看起来和你想要的是一模一样的。“引号"和连字符就是一个很好的例子-在IDE环境或文本编辑器中，左边的那个符号就不会正常起作用，至少不会是你想要的那个效果。

阅读本文档，就要享受它，希望它能对你有帮助。当遇到代码段示例的时候，可以寻找示例和下载（包括单元测试等），或是来自网站和邮件列表的示例。

帮助我们把文档做得更好…

如果你发现了本文档的遗漏之处，或者丢失MyBatis特性的说明时，那么最好的方法就是了解一下这个遗漏之处然后把它记录下来。

我们在wiki接收公共的文档贡献：

https://www.sodocs.net/doc/8211051549.html,/confluence/oss/display/IBATIS/Contribute+ Documentation

你也是本文档的最佳作者，其他用户也会来阅读它的。

关于翻译

MyBatis 3的用户指南翻译由南磊完成，若对翻译质量有任何意见和建议，请联系nanlei1987@https://www.sodocs.net/doc/8211051549.html,或https://www.sodocs.net/doc/8211051549.html,/nanlei1987，愿和大家共同提高，共同进步。

本文档免费发布和使用，但不可用于任何商业途径，版权归译者南磊所有，源文档版权归MyBatis社区所有。

目录

什么是MyBatis？ (5)

入门 (5)

从XML中构建SqlSessionFactory (5)

不使用XML构建SqlSessionFactory (6)

从SqlSessionFactory中获取SqlSession (6)

探究已映射的SQL语句 (7)

命名空间的一点注释 (8)

范围和生命周期 (8)

SqlSessionFactoryBuilder (8)

SqlSessionFactory (9)

SqlSession (9)

映射器实例 (9)

XML映射配置文件 (10)

properties (10)

Settings (11)

typeAliases (12)

typeHandlers (13)

objectFactory (14)

plugins (15)

environments (16)

transactionManager (17)

dataSsource (17)

mappers (19)

SQL映射的XML文件 (19)

select (20)

insert，update，delete (21)

sql (23)

Parameters (24)

resultMap (25)

高级结果映射 (27)

id，result (29)

支持的JDBC类型 (30)

构造方法 (30)

关联 (31)

集合 (34)

鉴别器 (36)

缓存 (38)

使用自定义缓存 (38)

参照缓存 (39)

动态SQL (39)

if (40)

choose, when, otherwise (40)

trim, where, set (41)

foreach (43)

Java API (44)

应用目录结构 (44)

SqlSessions (45)

SqlSessionFactoryBuilder (45)

SqlSessionFactory (47)

SqlSession (48)

SelectBuilder (53)

SqlBuilder (56)

什么是MyBatis？

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

入门

每一个MyBatis的应用程序都以一个SqlSessionFactory对象的实例为核心。SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象来获得。SqlSessionFactoryBuilder对象可以通过XML配置文件，或从以往使用惯例中准备好的Configuration类实例中来构建SqlSessionFactory对象。

从XML中构建SqlSessionFactory

从XML文件中构建SqlSessionFactory的实例非常简单。这里建议你使用类路径下的资源文件来配置，但是你可以使用任意的Reader实例，这个实例包括由文字形式的文件路径或URL形式的文件路径file://来创建。MyBatis包含了一些工具类，称作为资源，这些工具类包含一些方法，这些方法使得从类路径或其它位置加载资源文件更加简单。

String resource = "org/mybatis/example/Configuration.xml";

Reader reader = Resources.getResourceAsReader(resource);

sqlMapper = new SqlSessionFactoryBuilder().build(reader);

XML配置文件包含对MyBatis系统的核心设置，包含获取数据库连接实例的数据源和决定事务范围和控制的事务管理器。关于XML配置文件的详细内容可以在文档后面找到，这里给出一个简单的示例：

"https://www.sodocs.net/doc/8211051549.html,/dtd/mybatis-3-config.dtd">

当然，在XML配置文件中还有很多可以配置的，上面的示例指出的则是最关键的部分。要注意XML头部的声明，需要用来验证XML文档正确性。environment元素体中包含对事务管理和连接池的环境配置。mappers元素是包含所有mapper（映射器）的列表，这些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);

注意这种情况下配置是添加映射器类。映射器类是Java类，这些类包含SQL映射语句的注解从而避免了XML文件的依赖，XML映射仍然在大多数高级映射（比如：嵌套Join 映射）时需要。出于这样的原因，如果存在XML配置文件的话，MyBatis将会自动查找和加载一个对等的XML文件（这种情况下，基于类路径下的BlogMapper.class类的类名，那么BlogMapper.xml将会被加载）。后面我们会了解更多。

从SqlSessionFactory中获取SqlSession

现在，我们已经知道如何获取SqlSessionFactory对象了，基于同样的启示，我们就可以获得SqlSession的实例了。SqlSession对象完全包含以数据库为背景的所有执行SQL操作的方法。你可以用SqlSession实例来直接执行已映射的SQL语句。例如：

SqlSession session = sqlMapper.openSession();

try {

Blog blog = (Blog) session.selectOne(

"org.mybatis.example.BlogMapper.selectBlog", 101);

} finally {

session.close();

}

这种方法起到的作用，和我们使用之前的MyBatis版本是相似的，现在有一种更简洁的方法。使用合理描述参数和SQL语句返回值的接口（比如BlogMapper.class），这样现在就可以执行更简单，更安全的代码，没有容易发生的字符串文字和转换的错误。

例如：

SqlSession session = sqlSessionFactory.openSession();

try {

BlogMapper mapper = session.getMapper(BlogMapper.class);

Blog blog = mapper.selectBlog(101);

} finally {

session.close();

}

现在我们来探究一下这里到底执行了什么。

探究已映射的SQL语句

这里你也许想知道通过SqlSession和Mapper对象到底执行了什么操作。已映射的SQL 语句是一个很大的主题，而且这个主题会贯穿本文档的大部分内容。为了给出一个宏观的概念，这里有一些示例。

上面提到的任何一个示例，语句是通过XML或注解定义的。我们先来看看XML。使用基于XML的映射语言，在过去的几年中使得MyBatis非常流行，它为MyBatis提供所有的特性设置。如果你以前用过MyBatis，这个概念就应该很熟悉了，但是XML映射文件也有很多的改进，后面我们会详细来说。这里给出一个基于XML映射语句的示例，这些语句应该可以满足上述示例中SqlSession对象的调用。

"https://www.sodocs.net/doc/8211051549.html,/dtd/mybatis-3-mapper.dtd">

select * from Blog where id = #{id}

这个简单的例子中看起来有很多额外的东西，但是也相当简洁了。如果你喜欢，你可以在一个单独的XML映射文件中定义很多的映射语句，除XML头部和文档类型声明之外，你可以得到很多方便之处。在文件的剩余部分是很好的自我解释。在命名空间“com.mybatis.example.BlogMapper”中，它定义了一个名为“selectBlog”的映射语句，这样它允许你使用完全限定名“org.mybatis.example.BlogMapper.selectBlog”来调用映射语句，我们下面示例中所有的写法也是这样的。

Blog blog = (Blog) session.selectOne(

"org.mybatis.example.BlogMapper.selectBlog", 101);

要注意这个使用完全限定名调用Java对象的方法是相似的，这样做是有原因的。这个命名可以直接映射相同命名空间下的映射器类，使用一个名称，参数和返回值和已映射的查询语句都一样的方法即可。这就允许你非常容易地调用映射器接口中的方法，这和你前面看到的是一样的，下面这个示例中它又出现了。

BlogMapper mapper = session.getMapper(BlogMapper.class);

Blog blog = mapper.selectBlog(101);

第二种方式有很多的优点，首先它不是基于文字的，那就更安全了。第二，如果你的IDE有代码补全功能，那么你可以利用它来操纵已映射的SQL语句。第三，不需要强制类

型转换，同时BlogMapper接口可以保持简洁，返回值类型很安全（参数类型也很安全）。

命名空间的一点注释

命名空间在之前版本的MyBatis中是可选项，非常混乱在使用上也没有帮助。现在，命名空间是必须的，而且有一个目的，它使用更长的完全限定名来隔离语句。

命名空间使得接口绑定成为可能，就像你看到的那样，如果之前不了解，那么现在你就会使用它们了，你应该按照下面给出示例的来练习，以免改变自己的想法。使用命名空间，并将它放在合适的Java包空间之下，这将会使你的代码变得简洁，在很长的时间内提高MyBatis的作用。

命名解析：为了减少输入量，MyBatis对所有的命名配置元素使用如下的命名解析规则，包括语句，结果映射，缓存等。

●直接查找完全限定名（比如“com.mypackage.MyMapper.selectAllThings”），如果

发现就使用。

●短名称（比如“selectAllThings”）可以用来引用任意含糊的对象。而如果有两个

或两个以上的（比如“com.foo.selectAllThings”和“com.bar.selectAllThings”）,

那么就会得到错误报告，说短名称是含糊的，因此就必须使用完全限定名。

对BlogMapper这样的映射器类来说，还有一个妙招。它们中间映射的语句可以不需要在XML中来写，而可以使用Java注解来替换。比如，上面的XML示例可以如下来替换：package org.mybatis.example;

public interface BlogMapper {

@Select("SELECT * FROM blog WHERE id = #{id}")

Blog selectBlog(int id);

}

对于简单语句来说，使用注解代码会更加清晰，然而Java注解对于复杂语句来说就会混乱，应该限制使用。因此，如果你不得不做复杂的事情，那么最好使用XML来映射语句。

当然这也取决于你和你的项目团队的决定，看哪种更适合你来使用，还有以长久方式来使用映射语句的重要性。也就是说，不要将自己局限在一种方式中。你可以轻松地将注解换成XML映射语句，反之亦然。

范围和生命周期

理解我们目前已经讨论过的不同范围和生命周期类是很重要的。不正确的使用它们会导致严重的并发问题。

SqlSessionFactoryBuilder

这个类可以被实例化，使用和丢弃。一旦你创建了SqlSessionFactory后，这个类就不需要存在了。因此SqlSessionFactoryBuilder实例的最佳范围是方法范围（也就是本地方法变量）。你可以重用SqlSessionFactoryBuilder来创建多个SqlSessionFactory实例，但是最好的方式是不需要保持它一直存在来保证所有XML解析资源，因为还有更重要的事情要做。

SqlSessionFactory

一旦被创建，SqlSessionFactory实例应该在你的应用程序执行期间都存在。没有理由来处理或重新创建它。使用SqlSessionFactory的最佳实践是在应用程序运行期间不要重复创建多次。这样的操作将被视为是非常糟糕的。因此SqlSessionFactory的最佳范围是应用范围。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。然而这两种方法都不认为是最佳实践。这样的话，你可以考虑依赖注入容器，比如Google Guice或Spring。这样的框架允许你创建支持程序来管理单例SqlSessionFactory的生命周期。

SqlSession

每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段甚至是实例字段中。也绝不能将SqlSession实例的引用放在任何类型的管理范围中，比如Serlvet架构中的HttpSession。如果你现在正用任意的Web框架，要考虑SqlSession放在一个和HTTP请求对象相似的范围内。换句话说，基于收到的HTTP请求，你可以打开了一个SqlSession，然后返回响应，就可以关闭它了。关闭Session很重要，你应该确保使用finally块来关闭它。下面的示例就是一个确保SqlSession关闭的基本模式：SqlSession session = sqlSessionFactory.openSession();

try {

// do work

} finally {

session.close();

}

在你的代码中一贯地使用这种模式，将会保证所有数据库资源都正确地关闭（假设你没有通过你自己的连接关闭，这会给MyBatis造成一种迹象表明你要自己管理连接资源）。

映射器实例

映射器是你创建绑定映射语句的接口。映射器接口的实例可以从SqlSession中获得。那么从技术上来说，当被请求时，任意映射器实例的最宽范围和SqlSession是相同的。然而，映射器实例的最佳范围是方法范围。也就是说，它们应该在使用它们的方法中被请求，然后就抛弃掉。它们不需要明确地关闭，那么在请求对象中保留它们也就不是什么问题了，这和SqlSession相似。你也许会发现，在这个水平上管理太多的资源的话会失控。保持简单，将映射器放在方法范围内。下面的示例就展示了这个实例：

SqlSession session = sqlSessionFactory.openSession();

try {

BlogMapper mapper = session.getMapper(BlogMapper.class);

// do work

} finally {

session.close();

}

XML映射配置文件

MyBatis的XML配置文件包含了影响MyBatis行为甚深的设置和属性信息。XML文档的高层级结构如下：

●configuration配置

●properties属性

●settings设置

●typeAliases类型命名

●typeHandlers类型处理器

●objectFactory对象工厂

●plugins插件

●environments环境

●environment环境变量

●transactionManager事务管理器

●dataSource数据源

●映射器

properties

这些是外部化的，可替代的属性，这些属性也可以配置在典型的Java属性配置文件中，或者通过properties元素的子元素来传递。例如：

其中的属性就可以在整个配置文件中使用，使用可替换的属性来实现动态配置。比如：

这个例子中的username和password将会由properties元素中设置的值来替换。driver和url属性将会从包含进来的config.properties文件中的值来替换。这里提供很多配置的选项。

属性也可以被传递到SqlSessionBuilder.build()方法中。例如：

SqlSessionFactory factory =

sqlSessionFactoryBuilder.build(reader, props);

// ... or ...

SqlSessionFactory factory =

sqlSessionFactoryBuilder.build(reader, environment, props);

如果在这些地方，属性多于一个的话，MyBatis按照如下的顺序加载它们：

●在properties元素体内指定的属性首先被读取。

●从类路径下资源或properties元素的url属性中加载的属性第二被读取，它会

覆盖已经存在的完全一样的属性。

●作为方法参数传递的属性最后被读取，它也会覆盖任一已经存在的完全一样的

属性，这些属性可能是从properties元素体内和资源/url属性中加载的。

因此，最高优先级的属性是那些作为方法参数的，然后是资源/url属性，最后是properties 元素中指定的属性。

Settings

这些是极其重要的调整，它们会修改MyBatis在运行时的行为方式。下面这个表格描述了设置信息，它们的含义和默认值。

typeAliases

类型别名是为Java类型命名一个短的名字。它只和XML配置有关，只用来减少类完全限定名的多余部分。例如：

使用这个配置，“Blog”可以任意用来替代“domain.blog.Blog”所使用的地方。

对于普通的Java类型，有许多内建的类型别名。它们都是大小写不敏感的，由于重载

typeHandlers

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

这样做的话，简单实现TypeHandler接口（org.mybatis.type），然后映射新的类型处理器类到Java类型，还有可选的一个JDBC类型。例如：

// E xampleTypeHandler.java

public class ExampleTypeHandler implements TypeHandler { public void setParameter(PreparedStatement ps, int i, Object

parameter,JdbcType jdbcType) throws SQLException {

ps.setString(i, (String) parameter);

}

public Object getResult(ResultSet rs, String columnName) throws SQLException {

return rs.getString(columnName);

}

public Object getResult(CallableStatement cs, int columnIndex) throws SQLException {

return cs.getString(columnIndex);

}

}

// MapperConfig.xml

handler="org.mybatis.example.ExampleTypeHandler"/>

使用这样的类型处理器将会覆盖已经存在的处理Java的String类型属性和V ARCHAR 参数及结果的类型处理器。要注意MyBatis不会审视数据库元信息来决定使用哪种类型，所以你必须在参数和结果映射中指定那是V ARCHAR类型的字段，来绑定到正确的类型处理器上。这是因为MyBatis直到语句被执行都不知道数据类型的这个现实导致的。

objectFactory

MyBatis每次创建结果对象新的实例时，它使用一个ObjectFactory实例来完成。如果参数映射存在，默认的ObjectFactory不比使用默认构造方法或带参数的构造方法实例化目标类做的工作多。如果你想重写默认的ObjectFactory，你可以创建你自己的。比如：// E xampleObjectFactory.java

public class ExampleObjectFactory extends DefaultObjectFactory { public Object create(Class type) {

return super.create(type);

}

public Object create(Class type,List constructorArgTypes, List