MyBatis3.5.2参考文档

c#小王子 2022-03-19 542 Java

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

入门

安装

从 XML 中构建 SqlSessionFactory

不使用 XML 构建 SqlSessionFactory

从 SqlSessionFactory 中获取 SqlSession

探究已映射的 SQL 语句

作用域（Scope）和生命周期

安装

要使用 MyBatis，只需将 mybatis-x.x.x.jar 文件置于 classpath 中即可。

如果使用 Maven 来构建项目，则需将下面的 dependency 代码置于 pom.xml 文件中：

1. <dependency> 
2. <groupId>org.mybatis</groupId> 
3. <artifactId>mybatis</artifactId> 
4. <version>x.x.x</version> 
5. </dependency>

从 XML 中构建 SqlSessionFactory

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

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

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

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

1. <?xml version="1.0" encoding="UTF-8" ?> 
2. <!DOCTYPE configuration 
3. PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
4. "http://mybatis.org/dtd/mybatis-3-config.dtd"> 
5. <configuration> 
6. <environments default="development"> 
7. <environment id="development"> 
8. <transactionManager type="JDBC"/> 
9. <dataSource type="POOLED"> 
10. <property name="driver" value="${driver}"/> 
11. <property name="url" value="${url}"/> 
12. <property name="username" value="${username}"/> 
13. <property name="password" value="${password}"/> 
14. </dataSource> 
15. </environment> 
16. </environments> 
17. <mappers> 
18. <mapper resource="org/mybatis/example/BlogMapper.xml"/> 
19. </mappers> 
20. </configuration>

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

不使用 XML 构建 SqlSessionFactory

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

1. DataSource dataSource = BlogDataSourceFactory.getBlogDataSource(); 
2. TransactionFactory transactionFactory = new JdbcTransactionFactory(); 
3. Environment environment = new Environment("development", transactionFactory, dataSource); 
4. Configuration configuration = new Configuration(environment); 
5. configuration.addMapper(BlogMapper.class); 
6. 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 语句。例如：

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

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

例如：

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

现在我们来探究一下这里到底是怎么执行的。

探究已映射的 SQL 语句

现在你可能很想知道 SqlSession 和 Mapper 到底执行了什么操作，但 SQL 语句映射是个相当大的话题，可能会占去文档的大部分篇幅。不过为了让你能够了解个大概，这里会给出几个例子。在上面提到的例子中，一个语句既可以通过 XML 定义，也可以通过注解定义。我们先看看 XML 定义语句的方式，事实上 MyBatis 提供的全部特性都可以利用基于 XML 的映射语言来实现，这使得 MyBatis 在过去的数年间得以流行。如果你以前用过 MyBatis，你应该对这个概念比较熟悉。不过自那以后，XML 的配置也改进了许多，我们稍后还会再提到。这里给出一个基于 XML 映射语句的示例，它应该可以满足上述示例中 SqlSession 的调用。

1. <?xml version="1.0" encoding="UTF-8" ?> 
2. <!DOCTYPE mapper 
3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 
5. <mapper namespace="org.mybatis.example.BlogMapper"> 
6. <select id="selectBlog" resultType="Blog"> 
7. select * from Blog where id = #{id} 
8. </select> 
9. </mapper>

为了这个简单的例子，我们似乎写了不少配置，但实际上它并不多。在一个 XML 映射文件中，可以定义无数个映射语句，这样一来，XML 头部和文档类型声明占去的部分就显得微不足道了。而文件的剩余部分具备自解释性，很容易理解。在命名空间 “org.mybatis.example.BlogMapper” 中定义了一个名为 “selectBlog” 的映射语句，允许你使用指定的完全限定名 “org.mybatis.example.BlogMapper.selectBlog” 来调用映射语句，就像上

面例子中那样：

1. Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);

你可能注意到这和使用完全限定名调用 Java 对象的方法类似。这样，该命名就可以直接映射到在命名空间中同名的 Mapper 类，并将已映射的 select 语句中的名字、参数和返回类型匹配成方法。因此你就可以像上面那样很容易地调用这个对应 Mapper 接口的方法，就像下面这样：

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

第二种方法有很多优势，首先它不依赖于字符串字面值，会更安全一点；其次，如果你的 IDE 有代码补全功能，那么代码补全可以帮你快速选择已映射的 SQL 语句。提示对命名空间的一点说明在之前版本的 MyBatis 中，命名空间（Namespaces）的作用并不大，是可选的。但现在，随着命名空间越发重要，你必须指定命名空间。

命名空间的作用有两个，一个是利用更长的完全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。

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

完全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使

用时就会产生“短名称不唯一”的错误，这种情况下就必须使用完全限定名。对于像 BlogMapper 这样的映射器类来说，还有另一种方法来处理映射。它们映射的语句可以不用 XML 来配置，而可以使用 Java 注解来配置。比如，上面的 XML 示例可被替换如下：

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

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

【下载地址】

百度网盘链接：https://pan.baidu.com/s/1Z6w8qfkoqmNllwdDuLc-Ew

提取码：324p