2. 程式人生 > >mybatis 原始碼分析（一）框架結構概覽

mybatis 原始碼分析（一）框架結構概覽

阿新 • • 發佈：2019-08-15

本篇部落格將主要對 mybatis 整體介紹，包括 mybatis 的專案結構，執行的主要流程，初始化流程，API 等各模組進行簡單的串聯，讓你能夠對 mybatis 有一個整體的把握。另外在 mybatis 原始碼的閱讀過程中，如果不想寫 demo 可以直接使用專案中的單元測試；

一、mybatis 結構介紹

mybatis的主要功能和使用 demo，在網上已經有很多了我就不再囉嗦了，同時 官方文件 也非常的詳細；另外 mybatis 中使用了多種設計模式，包括建造者、動態代理、策略、裝飾器模式等，在檢視原始碼的時候，最好先對這些設計模式有一定的瞭解；

其中 mybatis 的模組結構如下：

mybatis 的執行流程如下：

  • 首先通過 Java API 或者 XML 配置完成初始化，最終所有的配置都在 Configuration 類中維護；
  • 然後通過 SqlSessionFactory 得到 SqlSession，這裡 SqlSession 就是 mybatis 的頂層 API 了，主要通過他完成資料庫的增刪改查等操作；
  • 然後 SqlSession 將具體的操作委託給 Executor 執行，Executor 就是 mybatis 的排程核心了，主要職責有 SQL 語句生成、一二級快取維護和事務的相關操作；
  • 然後 Executor 將資料庫相關的操作委託給 StatementHandler，StatementHandler 中完成了 mybatis 最核心的工作，包括引數繫結，指定 SQL 語句，結果集對映等；

具體過程如圖所示：

二、初始化

mybatis 中包含了很多的配置項，具體每一項的講解 官網 也很詳細，其結構大致如下：（另外正如上面說的 mybatis 的配置項最後都由 Configuration 類維護，這其實就是外觀模式）

configuration（配置）
  properties（屬性）
  settings（設定）
  typeAliases（類型別名）
  typeHandlers（型別處理器）
  objectFactory（物件工廠）
  plugins（外掛）
  environments（環境配置）
    environment（環境變數）
      transactionManager（事務管理器）
      dataSource（資料來源）
  mappers（對映器）

1. Java API 初始化

Java API 初始化的方式雖然不常用，但是相較於 XML 的方式可以更清楚的看到 Configuration 的構成，其示例如下：

PooledDataSource dataSource = new PooledDataSource();
dataSource.setDriver("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT");
dataSource.setUsername("root");
dataSource.setPassword("root");
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(UserMapper.class);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

2. XML 配置初始化

相交於 Java API 的方式，XML 配置初始化，必然會多出 XML 的解析部分；程式碼如下：

String resource = "org/apache/ibatis/builder/MapperConfig.xml";
Reader reader = Resources.getResourceAsReader(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
SqlSession sqlSession = sqlSessionFactory.openSession();

下面是一個相對完整的配置示例：

<?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="org/apache/ibatis/databases/blog/blog-derby.properties"/>
    
  <settings>
    <setting name="cacheEnabled" value="true"/>
    <setting name="lazyLoadingEnabled" value="false"/>
    ...
  </settings>
    
  <typeAliases>
    <typeAlias alias="Author" type="org.apache.ibatis.domain.blog.Author"/>
    <typeAlias alias="Blog" type="org.apache.ibatis.domain.blog.Blog"/>
    ...
  </typeAliases>

  <typeHandlers>
    <typeHandler javaType="String" jdbcType="VARCHAR" handler="org.apache.ibatis.builder.CustomStringTypeHandler"/>
  </typeHandlers>

  <objectFactory type="org.apache.ibatis.builder.ExampleObjectFactory">
    <property name="objectFactoryProperty" value="100"/>
  </objectFactory>

  <plugins>
    <plugin interceptor="org.apache.ibatis.builder.ExamplePlugin">
      <property name="pluginProperty" value="100"/>
    </plugin>
  </plugins>

  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC">
        <property name="" value=""/>
      </transactionManager>
      <!--<dataSource type="UNPOOLED">-->
      <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/apache/ibatis/builder/AuthorMapper.xml"/>
    <mapper resource="org/apache/ibatis/builder/BlogMapper.xml"/>
    ...
  </mappers>

</configuration>

其解析的流程如下：

主要程式碼如下：

public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
  try {
    XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
    return build(parser.parse());
  } catch (Exception e) {
    throw ExceptionFactory.wrapException("Error building SqlSession.", e);
  } finally {
    ErrorContext.instance().reset();
    try {
    inputStream.close();
    } catch (IOException e) { }
  }
}

public SqlSessionFactory build(Configuration config) {
  return new DefaultSqlSessionFactory(config);
}

從上面的程式碼和流程圖中可以看到，XML 初始化的主要流程被封裝到了 XMLConfigBuilder 當中；主要的程式碼邏輯如下：

public Configuration parse() {
  if (parsed) { throw new BuilderException("Each XMLConfigBuilder can only be used once."); }
  parsed = true;
  parseConfiguration(parser.evalNode("/configuration"));
  return configuration;
}

private void parseConfiguration(XNode root) {
  try {
    //issue #117 read properties first
    propertiesElement(root.evalNode("properties"));
    Properties settings = settingsAsProperties(root.evalNode("settings"));
    loadCustomVfs(settings);
    loadCustomLogImpl(settings);
    typeAliasesElement(root.evalNode("typeAliases"));
    pluginElement(root.evalNode("plugins"));
    objectFactoryElement(root.evalNode("objectFactory"));
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
    reflectorFactoryElement(root.evalNode("reflectorFactory"));
    settingsElement(settings);
    // read it after objectFactory and objectWrapperFactory issue #631
    environmentsElement(root.evalNode("environments"));
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));
    typeHandlerElement(root.evalNode("typeHandlers"));
    mapperElement(root.evalNode("mappers"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
  }
}

三、SqlSession 使用方式

1. 直接指定 MappedStatement

try (SqlSession session = sqlMapper.openSession()) {
  Author author = session.selectOne("org.apache.ibatis.domain.blog.mappers.AuthorMapper.selectAuthor", new Author(101));
}

這種方式通過 namespace + sqlId 的方式直接指定 MappedStatement；這種方式因為直接編寫字串和強型別轉換，既不安全也稍顯麻煩，所以現在已經不推薦使用了；

@Override
public <T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds) {
  try {
    MappedStatement ms = configuration.getMappedStatement(statement);
    Cursor<T> cursor = executor.queryCursor(ms, wrapCollection(parameter), rowBounds);
    registerCursor(cursor);
    return cursor;
  } catch (Exception e) {
    throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);
  } finally {
    ErrorContext.instance().reset();
  }
}

2. 動態代理 Mapper 的方式

try (SqlSession session = sqlMapper.openSession()) {
  AuthorMapper mapper = session.getMapper(AuthorMapper.class);
  Author author = mapper.selectAuthor(500);
}

這種方式不經避免了以上的問題，同時也能夠使用註解的方式編寫 sql，而且可以使用 IDE 提示；現在一般都推薦使用這種方式；但是其最終也是呼叫了上面的介面；

首先在初始化的時候通過 bindMapperForNamespace，註冊對應的 Mapper（要求namespace和Mapper的全限定名保持一致）；

// XMLMapperBuilder
private void bindMapperForNamespace() {
  String namespace = builderAssistant.getCurrentNamespace();
  if (namespace != null) {
    Class<?> boundType = null;
    try {
      boundType = Resources.classForName(namespace);
    } catch (ClassNotFoundException e) { //ignore, bound type is not required }
    if (boundType != null) {
      if (!configuration.hasMapper(boundType)) {
        configuration.addLoadedResource("namespace:" + namespace);
        configuration.addMapper(boundType);
      }
    }
  }
}

// MapperRegistry
public <T> void addMapper(Class<T> type) {
  if (type.isInterface()) {
    if (hasMapper(type)) { throw new BindingException("Type " + type + " is already known to the MapperRegistry."); }
    boolean loadCompleted = false;
    try {
      knownMappers.put(type, new MapperProxyFactory<>(type));  // 新增代理工廠
      MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
      parser.parse();
      loadCompleted = true;
    } finally {
      if (!loadCompleted) {
        knownMappers.remove(type);
      }
    }
  }
}

使用的時候，通過 class 類名獲取 MapperProxyFactory 代理工廠，製造一個新的 Mapper 代理（注意這裡時每次都要生成一個代理類，因為其中包含了 SqlSession，而 SqlSession 是執行緒不安全的所以不能快取，但是我覺得這裡任然是可以優化的，有興趣你可以自己嘗試一下）；

try (SqlSession session = sqlMapper.openSession()) {
  AuthorMapper mapper = session.getMapper(AuthorMapper.class);  // 代理類
}

// MapperRegistry
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
  final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
  if (mapperProxyFactory == null) { throw new BindingException("Type " + type + " is not known to the MapperRegistry."); }
  try {
    return mapperProxyFactory.newInstance(sqlSession);  // 建立代理物件
  } catch (Exception e) {
    throw new BindingException("Error getting mapper instance. Cause: " + e, e);
  }
}

// MapperProxyFactory
public T newInstance(SqlSession sqlSession) {
  final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
  return newInstance(mapperProxy);
}

// MapperProxy
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  try {
    if (Object.class.equals(method.getDeclaringClass())) {  // 從Object中繼承的方法
      return method.invoke(this, args);
    } else if (method.isDefault()) {  // 有預設實現的介面方法
      return invokeDefaultMethod(proxy, method, args);
    }
  } catch (Throwable t) {
    throw ExceptionUtil.unwrapThrowable(t);
  }
  final MapperMethod mapperMethod = cachedMapperMethod(method);
  return mapperMethod.execute(sqlSession, args);  // 然後由 MapperMethod 執行，這裡使用策略模式，後面還會詳細講解
}

總結

  • SqlSession 是執行緒不安全的，所以在示例程式碼中每次使用都會將其關閉？

    在 mybatis 中還有一個類 SqlSessionManager 裡面有一個 ThreadLocal 用來管理 SqlSession，在 Spring 中也同樣是用 SqlSessionHolder 來管理的，所以並不會每次都建立一個新的 SqlSession；

  • 以上內容只是大致將了 mybatis 的主要結構，後面的章節還會分模組進行講解；

另外本文主要參考了《MyBatis技術內幕》，有興趣的可以自行檢視

相關推薦

mybatis 原始碼分析（一）框架結構概覽

本篇部落格將主要對 mybatis 整體介紹，包括 mybatis 的專案結構，執行的主要流程，初始化流程，API 等各模組進行簡單的串聯，讓你能夠對 mybatis 有一個整體的把握。另外在 mybatis 原始碼的閱讀過程中，如果不想寫 demo 可以直接使用專案中的單元測試； 一、mybatis 結構介

libev原始碼分析（一）----基礎結構體

本篇文章主要分析libev中常用到且十分重要的結構。libev的程式碼很簡練，除了對高效I/O模型等的封裝檔案，核心檔案就兩個：ev.h和ev.c，其中ev.c大概4000行左右。程式碼大量用到了巨集，並且巨集還嵌套了巨集，為了便於理解libev的程式碼，這裡對巨集進行了還原

jquery原始碼分析（1）---框架結構

jq原始碼分析 （version2.2.3） 定義變數和函式然後掛載到了window上：通過自執行匿名函式的方式實現. 區域性作用域。然後函式內部將方法掛載到window上面方便外部呼叫的同時，不汙染全域性作用域。ex (function(){

laravel框架原始碼分析（一）自動載入

一、前言 　　使用php已有好幾年，laravel的使用也是有好長時間，但是一直對於框架原始碼的理解不深，原因很多，歸根到底還是php基礎不紮實，所以原始碼看起來也比較吃力。最近有時間，所以開啟第5、6遍的框架原始碼探索之旅，前面幾次都是看了一些就放棄，希望這次能夠看完。每一次看原始碼都會有新的收穫，因為框

新手解讀：laravel 框架原始碼分析（一）

眾所周知，php的框架數不勝數，近幾年，一個以優雅著稱的框架，漸漸被國內phper所知道，並且開始使用，但是larave有一個很明顯的缺點就是，他的文件內容少的可憐。而且國內的社群也不是很活躍。所以對使用這款框架的新書造成了很大困難。 作者作為一個入門也沒多久的新手，

MyBatis全版教程+原始碼分析（一）

一.什麼是 MyBatis MyBatis 是一款優秀的持久層框架，它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集。MyBatis 可以使用簡單的 XML 或註解來配置和對映原生資訊，將介面和 J

物件池commons-pool框架的研究以及原始碼分析（一）

    物件池是一個物件集合，用於將建立好的物件存在該集合中，當需要使用池中的物件時，再從池中取出，恰當地使用物件池可以有效減少物件生成和初始化時的消耗，提高系統的執行效率。另外，利用物件池還可以對物件的狀態做一定的維護，確保物件是可用的，提高程式的健壯性。注意：物件池技術

Executor執行框架原始碼分析（一）——executor、threadFactory、ThreadPoolExecutor 、Future元件的關係及作用

       executor執行框架是JDK1.5新增的，用於專注於任務執行的框架。其最大的特點就是將任務的建立和任務的執行分離，鬆耦合，已達到最大限度的利用計算機資源（執行緒和記憶體等）。在併發程式設計中，executor是一個必備的工具。     在分析原始碼之前，首先

mosquitto 原始碼分析 （一）核心資料結構

mosquitto 原始碼中核心資料結構分析 一、struct mosquitto （在mosquitto_internel.h中定義）     struct mosquitto 這個結構體用來儲存一個客戶端連線的所有資訊     這個結構體包含了很多成員，我們選取一些重要

Weka演算法Classifier-tree-J48原始碼分析（一）演算法和基本資料結構

大概一年沒打理部落格了，重新拿起筆不知道該從哪裡寫起，想來想去就從最近手頭用的Weka寫起吧。 Weka為一個Java基礎上的機器學習工具，上手簡單，並提供圖形化介面，提供如分類、聚類、頻繁項挖掘等工具，本篇文章主要寫一下分類器演算法中的J48演算法及其實現。 一、演算

AFNetworking3.1.0原始碼分析（一）整體框架和功能模組

簡介 1:基於系統NSURLSession類族封裝完成HPPT/HPPTS(GET,PUT,PSOT,DELEATE,HEAD)網路請求 2:擴充套件部分UIKit控制元件，比如擴充套件UIIMag

Apache Arrow原始碼分析（一）——簡介和框架

背景 列儲存在資料庫領域中早已被提出，列儲存資料結構在分析型事務上表現優異，大資料分析引擎，諸如Spark-SQL，Impala 均採用列儲存作為其中間資料表示形式，那麼Apache Arrow就是這樣一種記憶體列式資料結構。 在眾多分散式系統中，每

深度 Mybatis 3 原始碼分析（一）SqlSessionFactoryBuilder原始碼分析

MyBatis消除了幾乎所有的JDBC程式碼和引數的手工設定以及對結果集的檢索封裝。MyBatis可以使用簡單的XML或註解用於配置和原始對映，將介面和Java的POJO（Plain Old Java Objects，普通的Java物件）對映成資料庫中的記錄。 Mybatis環境快速入門 Maven依賴資

mybatis 原始碼分析（六）StatementHandler 主體結構分析

分析到這裡的時候，mybatis 初始化、介面、事務、快取等主要功能都已經講完了，現在就還剩下 StatementHandler 這個真正幹活的傢伙沒有分析了；所以接下來的部落格內容主要和資料庫的關係比較密切，而 StatementHandler 的主要流程也基本是和 JDBC 的流程是一一對應的； 一、St

Mybatis 原始碼分析（2）—— 引數處理

Mybatis對引數的處理是值得推敲的，不然在使用的過程中對發生的一系列錯誤直接懵逼了。 以前遇到引數繫結相關的錯誤我就是直接給加@param註解，也稀裡糊塗地解決了，但是後來遇到了一些問題推翻了我的假設：單個引數不需要使用 @param 。由此產生了一個疑問，Mybatis到底是怎

Mybatis 原始碼分析（9）—— 事物管理

Mybatis 提供了事物的頂層介面： public interface Transaction { /** * Retrieve inner database connection * @return DataBase connection * @throw

Mybatis 原始碼分析（8）—— 一二級快取

一級快取 其實關於 Mybatis 的一級快取是比較抽象的，並沒有什麼特別的配置，都是在程式碼中體現出來的。 當呼叫 Configuration 的 newExecutor 方法來建立 executor： public Executor newExecutor(Transac

Mybatis原始碼分析（7）—— 結果集處理

解析封裝 ResultMap 是和結果集相關的東西，最初在解析 XML 的時候，於 parseStatementNode 方法中，針對每一個 select 節點進行解析，轉換為 MappedStatement（類似 Spring 的 bean 配置和 BeanDefinition 的

Mybatis原始碼分析（6）—— 從JDBC看Mybatis的設計

Java資料庫連線，（Java Database Connectivity，簡稱JDBC）是Java語言中用來規範客戶端程式如何來訪問資料庫的應用程式介面，提供了諸如查詢和更新資料庫中資料的方法。 六步流程: 載入驅動（5.x驅動包不需要這步了） 建立

Mybatis原始碼分析（5）—— 外掛的原理

MyBatis 允許你在已對映語句執行過程中的某一點進行攔截呼叫。 預設情況下，可以使用外掛來攔截的方法呼叫包括： Executor (update, query, flushStatements, commit, rollback, getTransaction, cl