MyBatis的运行主要有两大部分:一是读取配置文件到Configuration,用来创建SqlSessionFactory,二是执行SqlSession。前者容易理解,后者的执行处理过程比较复杂,需要涉及到反射以及动态代理技术,接下来通过一个最基础的demo来分析一下mybatis的运行过程。(前方大量代码,引起极度不适者回避)
一、项目结构
项目结构如下:
pom文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wisdom</groupId>
<artifactId>mybatis-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<!--mysql连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--引入logback日志框架-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.0</version>
</dependency>
</dependencies>
</project>
MyBatis的开发核心有三部分:
- pojo类:User类
@Getter
@Setter
@ToString
public class User {
private String id;
private String username;
private String password;
}
- 映射器:UserMapper接口
public interface UserMapper {
/**
* 通过id获取User
*
* @param id 用户id
* @return user
*/
User getUserById(String id);
}
- 映射配置文件:UserMapper.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="com.wisdom.mappper.UserMapper">
<select id="getUserById" parameterType="string" resultType="user">
select id,username,password from user where id=#{id}
</select>
</mapper>
此外还有mybatis-config.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>
<!--引入外部数据库配置文件-->
<properties resource="db.properties"/>
<!--定义别名-->
<typeAliases>
<typeAlias type="com.wisdom.pojo.User" alias="user"/>
</typeAliases>
<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="mappers/UserMapper.xml"/>
</mappers>
</configuration>
SqlSessionFactoryUtil类用于获取sqlSession,主要任务到导入mybatis配置文件。代码如下:
public class SqlSessionFactoryUtil {
private static SqlSessionFactory sqlSessionFactory = null;
private SqlSessionFactoryUtil() {
}
/**
* 初始化SqlSessionFactory
*
* @return SqlSessionFactory
*/
private static SqlSessionFactory initSqlSessionFactory() {
String resource = "mybatis-config.xml";
InputStream inputStream = null;
try {
inputStream = Resources.getResourceAsStream(resource);
} catch (IOException e) {
e.printStackTrace();
}
synchronized (SqlSessionFactoryUtil.class) {
if (sqlSessionFactory == null) {
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}
}
return sqlSessionFactory;
}
public static SqlSession openSqlSession() {
if (sqlSessionFactory == null) {
initSqlSessionFactory();
}
return sqlSessionFactory.openSession();
}
}
Main类进行调用:
public class Main {
public static void main(String[] args) {
SqlSession sqlSession = null;
try {
sqlSession = SqlSessionFactoryUtil.openSqlSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.getUserById("1");
System.out.println(user);
sqlSession.commit();
} catch (Exception e) {
e.printStackTrace();
if (sqlSession != null) {
sqlSession.rollback();
}
} finally {
if (sqlSession != null) {
sqlSession.close();
}
}
}
}
运行main函数,输出:
15:04:36.316 [main] INFO com.wisdom.Main - user:User(id=1, username=wisdom, password=123456)
整个运行过程ok,配置细节不再详解,接下来通过一步步去查看mybatis内部具体是如何执行的。
二、mybatis内部运行原理解析
- SqlSessionFactory的创建
回顾SqlSessionFactoryUtil
的initSqlSessionFactory
方法,首先用InputStream
读取mybatis-config.xml
配置文件,然后通过SqlSessionFactoryBuilder
的build
方法构造。
进入build
方法,可以看到通过XMLConfigBuilder
解析inputStream中的配置参数,parser.parse()
将配置数据存入Configuration类中。
进入parse()
方法中查看,parseConfiguration(XNode root)
方法中包含了许多其他方法,每一个方法的作用都是将特定节点的数据存入到configuration
对象中。Congifutation
是一个很关键的类,mybatis中所有配置信息基本都存在于此。
最后再调用重载的build(Configuration config)方法,创建一个DefaultSqlSessionFactory,此类是SqlSessionFactory的一个实现类。
- 成功创建完SqlSessionFactory后,接下来就是获取sqlSession了,
SqlSession
也是一个非常重要的类,通过它去和数据库打交道。我们来看如何获取sqlSession,进入sqlSessionFactory.openSession()
方法。最终会来到如下方法。
可以看到,通过取出configuration对象中的数据源,创建一个执行器Executor
,最后通过new DefaultSqlSession(configuration, executor, autoCommit);
拿到SqlSession的实现。Executor执行器也是一个非常重要的接口,它真正地实现了与数据库的交互。
到此为止,获取到sqlSession对象后,说明已经与数据库真正建立了连接关系,接下来就是实际的交互,发送sql了。
在获取数据之前,我们再看一下源码中对SqlSession类的描述:
The primary Java interface for working with MyBatis.
Through this interface you can execute commands, get mappers and manage transactions.
SqlSession类是mybatis运行的最核心的java接口,通过这个接口可以执行命令、获取Mapper类、管理事务。
- 通过sqlSession拿到userMapper对象,接下来在执行
userMapper.getUserById("1")
这一行打断点。
进入方法内部,看到此处便使用了动态代理技术,这也是为什么mybatis只用接口便可以完成对数据库的操作。继续执行,程序来到mapperMethod.execute(sqlSession, args);
进入execute方法中,看到此处使用了一个switch语句来判断当前执行的sql是哪种执行类型,我们这里是select,程序继续执行,来到result = sqlSession.selectOne(command.getName(), param);
这一行,可以看到此处调用了sqlSession的selectOne方法,并且传入了方法名全路径和参数。
进入selectOne方法内部,下图断点标识的一行便是去数据库中查询,然后返回数据。接下来看看是如何进行查询的。
进入selectList(statement,parameter)方法内部,此时会调用一个重载方法,继续进入,最终会来到以下代码片段。可以看到最终还是通过executor来执行查询的。
接下来继续进入query方法,看一下boundSql里面是什么,里面包含了三个重要的属性,sql、parameterMappings、parameterObject。
继续进入query方法,可以看到此处会去查一遍缓存,如果命中缓存则直接返回,否则继续查询。
接下来限于冗余就不继续debug了,总之就是继续执行查询,封装结果集,里面会出现我们熟悉的原生调用数据库的代码,感兴趣的可以顺着继续往下调试。