MyBatis 系列 1

Oct 49, 4119
Oct 219, 21029

MyBatis

问

MyBatis 是什么？如何使用？基本原理是什么？

各组件对象的作用域 (Scope) 和生命周期有哪些？

答

概念

MyBatis 是一款优秀的持久层框架。

支持

定制化 SQL
存储过程
高级映射

有以下好处

避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 中的 POJO(Plain Old Java Objects) 为数据库中的记录

使用

将 mybatis-x.x.x.jar 包置于 classpath 中

若采用 Maven 构建项目，需要将下面的配置置于 pom.xml 文件中：

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

基本原理

从 XML 配置文件或 Configuration 中构建出 SqlSessionFactoryBuilder
SqlSessionFactoryBuilder 构建出 SqlSessionFactory 的实例
SqlSessionFactory 的实例是基于 MyBatis 应用的核心
SqlSessionFactory 创建出每一个 SqlSession，用于操作数据库

构建 SqlSessionFactory

使用 XML 构建

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>

然后，SqlSessionFactoryBuilder 基于这段内容构建出 SqlSessionFactory：

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

不使用 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);

注意，不管采用哪种方式，有两项配置必须得有：

DataSource，即获取数据库连接实例的数据源
TransactionManager，即决定事务作用域和控制方式的事务管理器

获取 SqlSession

创建完 SqlSessionFactory，接着就可以从中获取 SqlSession 实例。

SqlSession 包含了面向数据库执行 SQL命令所需的所有方法，可直接执行 SQL 语句，如：

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

但一般不采用上述方式，可采用如下更简洁的方式。

只需描述每个语句的参数和返回值的接口，就能执行更清晰和类型安全的代码，而且不同担心易错的字符串常量和强制类型转换：

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

上述 BlogMapper 的 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>

也可以用注解的方式定义：

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

作用域和生命周期

SqlSessionFactoryBuilder：最佳作用域是方法作用域，即局部方法变量，用完即释放。
SqlSessionFactory：最佳作用域是应用作用域，运行期间保持单例。
SqlSession：最佳作用域是方法作用域。每个线程都有自己的 SqlSession 实例，非线程安全。
映射器实例：最佳作用域是方法作用域。映射器实例的接口是从 SqlSession 中获得的，用完丢弃。

使用 SqlSession 和映射器实例的最佳实践：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}