理解 MyBatis 是如何在 Spring 容器中初始化的

mybatis 初始化过程就是生成一些必须的对象放到 spring 容器中。问题是这个过程到底生成了哪些对象？当遇到 mybatis 初始化失败时，如何正确的找到分析问题的切入点？本文将针对这些问题进行介绍。

本文基于 mybatis 3 和 spring，假设读者已经知道如何使用 maven 和 mybatis，以及了解 spring 的容器机制。

一、mybatis 三件套

我们知道 mybatis 的主要功能是由 sqlsessionfactory 和 mapper 两者提供的，初始化 mybatis 就是初始化这两类对象。除此之外 datasource 作为数据库访问对象也是必不可少。因此首先我们应该记住 mybatis 初始化的核心三件套：

• datasource：它是访问数据库所必须的数据源对象，这个初始化失败就无法直接访问数据库。
• sqlsessionfactorybean：这是在 spring 容器中对 sqlsessionfactory 初始化过程的封装。
• mapperscannerconfigurer：这是在 spring 容器中对 mapper 初始化过程的封装。

具体来说，一个简单的初始化过程就是下面这样：

@configuration
public class springmybatisapplication {
  public static void main(string[] args) {
    new annotationconfigapplicationcontext(springmybatisapplication.class);
  }
  @bean
  public datasource datasource() {
    return ...;
  }
  @bean
  public sqlsessionfactorybean sqlsessionfactorybean(datasource datasource) {
    return ...;
  }
  @bean
  public mapperscannerconfigurer mapperscannerconfigurer() {
    return ...;
  }
}

接下来介绍三件套各自如何初始化，下面的内容是可以实际操作的，不妨动手试试。

1. datasource 初始化

首先我们创建一个空的 maven 项目，在 pom.xml 中加入下面的依赖关系：

<!-- spring -->
<dependency>
 <groupid>org.springframework</groupid>
 <artifactid>spring-beans</artifactid>
 <version>5.2.0.release</version>
</dependency>
<dependency>
 <groupid>org.springframework</groupid>
 <artifactid>spring-context-support</artifactid>
 <version>5.2.0.release</version>
</dependency>
<dependency>
 <groupid>org.springframework</groupid>
 <artifactid>spring-jdbc</artifactid>
 <version>5.2.0.release</version>
</dependency>
<dependency>
 <groupid>org.springframework</groupid>
 <artifactid>spring-tx</artifactid>
 <version>5.2.0.release</version>
</dependency>

<!-- 数据库 -->
<dependency>
 <groupid>org.apache.commons</groupid>
 <artifactid>commons-dbcp2</artifactid>
 <version>2.7.0</version>
</dependency>
<dependency>
 <groupid>com.h2database</groupid>
 <artifactid>h2</artifactid>
 <version>1.4.199</version>
</dependency>

本文重在演示 mybatis 的初始化过程，所以没有复杂的 sql，数据库用的是嵌入式数据库 h2。

然后我们在 com.hyd.mybatis3test 包下面创建一个 springmybatisapplication 类，代码在前面给过了。

对应的 datasource 初始化实现如下：

@bean
public datasource datasource() {
  basicdatasource datasource = new basicdatasource();
  datasource.setdriverclassname("org.h2.driver");
  datasource.seturl("jdbc:h2:mem:test");
  return datasource;
}

2. sqlsessionfactorybean 初始化

sqlsessionfactorybean 是对 sqlsessionfactory 初始化过程的封装，spring 会在适当的时候执行这个初始化过程，得到最终的 sqlsessionfactory 对象。

sqlsessionfactorybean 的创建过程如下（注意方法签名在前面的基础上有变动）：

@bean
public sqlsessionfactorybean sqlsessionfactory(
    datasource datasource,
    resourcepatternresolver resolver
) throws exception {
  sqlsessionfactorybean bean = new sqlsessionfactorybean();
  bean.setdatasource(datasource);
  bean.setmapperlocations(resolver.getresources("classpath*:mappers/*.xml"));
  return bean;
}

其中：

• 第一个参数 datasource 就是前面生成的数据源对象；
• 第二个参数 resolver 是 spring 自动提供的，用于搜索指定路径下的所有 xml 文件。本文不会包含 xml 文件，所以这个配置是无效的，这行可以不写，不过写了也不影响程序运行。

3. mapperscannerconfigurer 初始化

mapperscannerconfigurer 的职责是在指定路径下搜索所有的 mapper 接口类（参考它的 postprocessbeandefinitionregistry() 方法），并通过 mapperfactorybean 将其注册到 mapperregistry 中。

@bean
public mapperscannerconfigurer mapperscannerconfigurer() {
  mapperscannerconfigurer configurer = new mapperscannerconfigurer();
  configurer.setbasepackage("com.hyd.mybatis3test");
  return configurer;
}

4. 验证初始化过程成功

为了验证上面的初始化过程完成了，我们在 com.hyd.mybatis3test 包下面创建一个 mapper 类：

@mapper
public interface samplemapper {
  @update("create table if not exists user(id int)")
  void createusertable();
}

以及一个 service 类：

@service
public static class sampleservice {
  @autowired
  private samplemapper samplemapper;
  @postconstruct
  public void init() {
    samplemapper.createusertable();
  }
}

然后别忘了在 springmybatisapplication 顶上添加一个 @componentscan("com.hyd.mybatis3test") 注解，否则 spring 会找不到 sampleservice。

运行 springmybatisapplication.main() 方法，我们就能在输出中找到这样的内容：

...
samplemapper.createusertable - ==>  preparing: create table if not exists user(id int)
samplemapper.createusertable - ==> parameters:
samplemapper.createusertable - <==    updates: 0
...

这说明这条创建表格的 sql 语句成功执行了。

在前面三件套的基础上，mybatis 也提供了更多的封装。有了本文上面的铺垫，相信读者对这些封装方式理解起来也会轻松很多。

二、@mapperscan 注解

@mapperscan 注解只不过是 mapperscannerconfigurer 的启动器而已，使用这个注解，可以代替前面的 mapperscannerconfigurer 初始化。

三、springboot 自动初始化

mybatis 提供 mybatis-spring-boot-starter 库用于在 spring boot 项目中自动初始化：

<dependency>
 <groupid>org.mybatis.spring.boot</groupid>
 <artifactid>mybatis-spring-boot-starter</artifactid>
 <version>2.1.3</version>
</dependency>

这个所谓的自动初始化实际上就是初始化 sqlsessionfactory 对象。初始化的过程由 org.mybatis.spring.boot.autoconfigure.mybatisautoconfiguration 完成，所需的配置都从 "mybatis-" 前缀的配置属性中获取，具体可以参考 org.mybatis.spring.boot.autoconfigure.mybatisproperties 类。

总结

总之，mybatis 的初始化核心过程就是三件套的初始化。而在 spring boot 应用中，结合自动初始化和 @mapperscan 注解，我们无需手工初始化上这三件套，就能直接从容器中得到 mapper 对象。

到此这篇关于理解 mybatis 是如何在 spring 容器中初始化的的文章就介绍到这了,更多相关mybatis在spring中的初始化内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！