本书作者:测试开发刚哥,文章版权归个人所有,未经授权请勿转载。
MyBatis 是什么
MyBatis 是 Java 的持久层框架,GitHub 的 star 数高达 15.8k,是 Java 技术栈中最热门的 ORM 框架之一。它支持自定义 SQL、存储过程以及高级映射,可以通过 XML 或注解来配置和映射原始类型、接口和 Java POJOs 为数据库中的记录。
POJOs,Plain Old Java Objects,纯的传统意义的 Java 对象,最基本的 Java Bean 只有属性加上属性的 get 和 set 方法。

安装
Maven pom.xml:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
版本查询:https://mvnrepository.com/artifact/org.mybatis/mybatis
SqlSessionFactory
SqlSessionFactory 的实例是每个 MyBatis 应用的核心,通过 SqlSessionFactoryBuilder 创建,能基于 XML 配置,也能使用 Configuration 类。
基于 XML 配置:
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory =
new SqlSessionFactoryBuilder().build(inputStream);
实际项目中不会手动设置 XML 文件路径,而是直接读取 classpath 去找 XML。
使用 Configuration 类:
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 注解的一些限制以及某些 MyBatis 映射的复杂性,MyBatis 会优先选择 XML 配置。在上面的示例中,MyBatis 会根据 classpath 和 BlogMapper.class 去找 BlogMapper.xml。
SqlSession
SqlSessionFactory 能创建 SqlSession 实例,SqlSession 提供了在数据库执行 SQL 的所有方法。比如:
try (SqlSession session = sqlSessionFactory.openSession()) {
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
}
背后的 SQL 语句
隐藏在 mapper.selectBlog()方法背后的 SQL 语句是配置在 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>
environment 配置了数据源和连接池。
mapper 包含了 SQL 语句:
<?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>
mapper.selectBlog()方法映射到了 XML 里面的 id selectBlog。
值得注意的是,对于简单 SQL 来说,可以直接使用 Java 注解:
package org.mybatis.example;
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
但是对于复杂 SQL 还是写 XML 更方便。
作用域与生命周期
从前面几个小节我们知道了 SqlSessionFactoryBuilder→SqlSessionFactory→SqlSession→Mapper Instances 的实例对象产生链路,接下来看看它们各自的作用域与生命周期:
-
SqlSessionFactoryBuilder
作用域是 method,用完就释放,避免 XML 解析资源占用。
-
SqlSessionFactory
作用域是 application,只要创建就一直存在,可以通过单例模式来实现。
-
SqlSession
作用域是 request 或 method,每个线程独一份,每次收到 HTTP 请求,打开一个 SqlSession,返回响应后,就关闭它。以下代码能确保每次关闭:
try (SqlSession session = sqlSessionFactory.openSession()) { // do work } -
Mapper Instances
它是由 SqlSession 创建的,作用域类似,不过更建议放到 method,用完就释放,比如:
try (SqlSession session = sqlSessionFactory.openSession()) { BlogMapper mapper = session.getMapper(BlogMapper.class); // do work }
小结
本文首先介绍了 MyBatis 是什么,然后通过 SqlSessionFactoryBuilder→SqlSessionFactory→SqlSession→Mapper Instances 链路阐述了 MyBatis 是如何从数据库查询 SQL 映射到代码里面的,最后给出了这几个类实例的作用域的使用建议。
参考资料: