Mybatis入门

2018-08-25 本文已影响0人小淼不卖萌

1. 简介

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

2.安装

要使用 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>

3. 构建SqlSessionFactory

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

XML构建SqlSessionFactory

MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，可使从 classpath 或其他位置加载资源文件更加容易。

# 使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的 文件路径来配置
String resource = "org/mybatis/example/mybatis-config.xml";

# 路径转化成流
InputStream inputStream = Resources.getResourceAsStream(resource);

# 构建SqlSessionFactory
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 文档正确性
environment 元素体中包含了事务管理和连接池的配置
mappers 元素则是包含一组 mapper 映射器（这些 mapper 的 XML 文件包含了 SQL 代码和映射定义信息）。

不使用 XML 构建 SqlSessionFactory

不使用XML 文件中创建 configuration，或者创建你自己的 configuration 构建器，MyBatis也提供了完整的配置类

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 sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

configuration 添加了一个映射器类（mapper class）---- Java 类，它们包含** SQL 映射语句的注解**从而避免了 XML 文件的依赖。
由于 Java 注解的一些限制加之某些 MyBatis 映射的复杂性，XML 映射对于大多数高级映射（比如：嵌套 Join 映射）来说仍然是必须的
有鉴于此，如果存在一个对等的 XML 配置文件的话，MyBatis 会自动查找并加载它（这种情况下， BlogMapper.xml 将会基于类路径和 BlogMapper.class 的类名被加载进来）

4. 从 SqlSessionFactory 中获取 SqlSession

SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法
可以通过SqlSession 实例来直接执行已映射的 SQL 语句
使用对于给定语句能够合理描述参数和返回值的接口（比如说BlogMapper.class）

【1】XML定义映射

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

【2】注解定义映射类

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

5. 探究已映射的 SQL 语句

SqlSession 和 Mapper 到底执行了什么操作

命名空间（Namespaces）

命名空间在现在的Mybatis版本中是必须的，意于简单地用更长的完全限定名来隔离语句。

命名空间使得你所见到的接口绑定成为可能
出于长远考虑，使用命名空间，并将它置于合适的 Java 包命名空间之下，你将拥有一份更加整洁的代码并提高了 MyBatis 的可用性。
命名解析：为了减少输入量，MyBatis 对所有的命名配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。
完全限定名（比如“com.mypackage.MyMapper.selectAllThings”）将被直接查找并且找到即用。
短名称（比如“selectAllThings”）如果全局唯一也可以作为一个单独的引用。如果不唯一，有两个或两个以上的相同名称（比如“com.foo.selectAllThings ”和“com.bar.selectAllThings”），那么使用时就会收到错误报告说短名称是不唯一的，这种情况下就必须使用完全限定名。

【1】XML

MyBatis 提供的全部特性可以利用基于 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">
<mapper namespace="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

非常轻量级的。在一个 XML 映射文件中，你想定义多少个映射语句都是可以的
在命名空间“org.mybatis.example.BlogMapper”中定义了一个名为“selectBlog”的映射语句，就允许你使用指定的完全限定名“org.mybatis.example.BlogMapper.selectBlog”来调用映射语句:
```
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
```
这和使用完全限定名调用 Java 对象的方法是相似的
这个命名可以直接映射到在命名空间中同名的 Mapper 类，并将已映射的 select 语句中的名字、参数和返回类型匹配成方法

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

【2】注解

首先它不是基于字符串常量的，就会更安全
如果你的 IDE 有代码补全功能，那么你可以在有了已映射 SQL 语句的基础之上利用这个功能。
BlogMapper 这样的映射器类（Mapper class）来说，上面的 XML 示例可被替换如下：

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

对于简单语句来说，注解使代码显得更加简洁
Java 注解对于稍微复杂的语句就会力不从心并且会显得更加混乱--如果做很复杂的事情，那么最好使用 XML 来映射
永远不要拘泥于一种方式----都得会

6. 作用域（Scope）和生命周期

对象生命周期和依赖注入框架

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

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

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

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();
}

【注】：

DAO + 实例 + 设置主键 + 关联查询（+延时加载） + 一二级缓存 + Spring整合 + 逆向工程===>Mybatis入门及实践