Mybatis中的設計模式運用

時間  2019-11-06
標籤 mybatis 設計 模式 運用 欄目 MyBatis 简体版
原文   原文鏈接

Mybatis是一種使用方便，查詢靈活的ORM框架，支持定製化 SQL、存儲過程以及高級映射，支持多種主流數據庫（mysql、oracle、PostgreSQL）。本文以mysql爲例，使用jdk8，mysql5.7，mybatis3.4。給你們講解它的源碼中設計模式的運用。


1. SqlSession的建立

Mybatis的啓動方式有兩種，交給Spring來啓動和編碼方式啓動。第一種方式:若是項目中用到了mybatis-spring.jar，那大可能是經過Spring來啓動。咱們重點介紹一下第二種方式：編碼啓動,獲取sqlsession的依賴關係圖以下:mysql

Reader reader = Resources.getResourceAsReader("Mybatis配置文件路徑");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
SqlSession sqlSession = sqlSessionFactory.openSession();複製代碼
能夠看到，編碼方式啓動是經過調用SqlSessionFactoryBuilder類的build()方法來獲取SqlSessionFactory對象的，而後經過SqlSessionFactory獲得咱們想要的SqlSession。

其中SqlSession和SqlSessionFactory這兩個接口，及DefaultSqlSession和DefaultSqlSessionFactory這兩個默認實現類，就是典型的工廠方法模式的實現。一個基礎接口（SqlSession）定義了功能，每一個實現接口的子類（DefaultSqlSession）就是產品，而後定義一個工廠接口（SqlSessionFactory），實現了工廠接口的就是工廠（DefaultSqlSessionFactory），採用工廠方法模式的優勢是：一旦須要增長新的sqlsession實現類，直接增長新的SqlSessionFactory的實現類，不須要修改以前的代碼，更好的知足了開閉原則。spring

其中用到的SqlSessionFactoryBuilder採用了 建造者（Builder）模式 。正常一個對象的建立是使用new關鍵字完成，可是若是建立對象須要的構造參數不少，且不能保證每一個參數都是正確的或者不能一次性獲得構建所需的全部參數，就須要將構建邏輯從對象自己抽離出來，讓對象只關注功能，把構建交給構建類，這樣能夠簡化對象的構建，也能夠 達到分步構建對象的目的。

在SqlSessionFactoryBuilder中構建SqlSessionFactory分爲了兩步：sql

  • 第一步，經過XMLConfigBuilder解析XML配置文件，讀取配置參數，並將讀取的數據存入Configuration類中。
  • 第二步，經過build方法，生成DefaultSqlSessionFactory對象：

public SqlSessionFactory build(InputStream inputStream,String environment,Properties properties) {
...
    XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
    return build(parser.parse());
...
}
  
public SqlSessionFactory build(Configuration config) {
  return new DefaultSqlSessionFactory(config);
}複製代碼
上述兩步都是在SqlSessionFactoryBuilder類中進行，SqlSessionFactoryBuilder類至關於一個操控臺，將各方面的資源拿過來合成目標對象，Configuration類屬於建立過程當中一個重要的中間介質，最終分步構建出SqlSessionFactory 。


2. 建立數據源DataSource對象

建立datasource對象也有兩種方式，交給Spring來建立和讀取mybatis配置文件建立。數據庫

  • 第一種方式：由spring讀取配置文件，在org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration使用datasource建立SqlSessionFactory。
  • 第二種方式：Mybatis中的處理。

Mybatis把數據源分爲三種：

  • Jndi: 使用jndi實現的數據源, 經過JNDI上下文中取值apache

  • Pooled：使用鏈接池的數據源設計模式

  • Unpooled：不使用鏈接池的數據源數組


Mybatis配置文件中關於數據庫的配置： 

<environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driverClassName}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
複製代碼
MyBatis是經過工廠方法模式來建立數據源DataSource對象的，根據配置文件中type的類型實例化具體的DataSourceFactory。這裏是POOLED因此實例化的是PooledDataSourceFactory。經過其getDataSource()方法返回數據源DataSource。工廠方法模式在上面已經詳細介紹，在這就再也不贅述。


3. Executor（執行器）的實現

Executor是MyBatis執行器，負責SQL語句的生成和查詢緩存的維護。Executor的功能和做用是：緩存

  1. 根據傳遞的參數，完成SQL語句的動態解析，生成BoundSql對象，供StatementHandler使用；
  2. 爲查詢建立緩存，以提升性能；
  3. 建立JDBC的Statement鏈接對象，傳遞給StatementHandler對象，返回List查詢結果。

最底層的接口是Executor，有兩個實現類：BaseExecutor和CachingExecutor，CachingExecutor用於二級緩存，而BaseExecutor則用於一級緩存及基礎的操做。而且因爲BaseExecutor是一個抽象類，採用 模板方法設計模式，提供了三個實現：SimpleExecutor，BatchExecutor，ReuseExecutor，而具體使用哪個Executor則是能夠在mybatis-config.xml中進行配置的。
  1. SimpleExecutor是最簡單的執行器，根據對應的sql直接執行便可，不會作一些額外的操做。
  2. BatchExecutor執行器，顧名思義，經過批量操做來優化性能。一般須要注意的是批量更新操做，因爲內部有緩存的實現，使用完成後記得調用flushStatements來清除緩存。
  3. ReuseExecutor 可重用的執行器，重用的對象是Statement，也就是說該執行器會緩存同一個sql的Statement，省去Statement的從新建立，優化性能。內部的實現是經過一個HashMap來維護Statement對象的。因爲當前Map只在該session中有效，因此使用完成後記得調用flushStatements來清除Map。
  4. 這幾個Executor的生命週期都是侷限於SqlSession範圍內。
以update操做爲例，在BaseExcutor中是這麼實現的： 

@Override
public int update(MappedStatement ms, Object parameter) throws SQLException {
  ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());
  if (closed) {
    throw new ExecutorException("Executor was closed.");
  }
  clearLocalCache();
  return doUpdate(ms, parameter);
}複製代碼
當調用到這個方法時，會根據是哪一個子類的對象，調用子類的doUpdate方法。像doFlushStatements，doQuery,doQueryCursor也是這樣調用的。

這樣實現的優勢是：一、封裝不變部分，擴展可變部分。二、提取公共代碼，便於維護。三、行爲由父類控制，子類實現。bash


4. interceptor（攔截器）的實現

MyBatis 容許在sql語句執行過程當中的某一點進行攔截調用，具體實現是經過對Executor、StatementHandler、PameterHandler和ResultSetHandler進行攔截代理。其中的業務含義以下介紹：session

  • ParameterHandler：攔截參數的處理
  • ResultSetHandler：攔截結果集的處理
  • StatementHandler：攔截Sql語法構建的處理
  • Executor：攔截執行器的方法。

經過查看Configuration類的源代碼咱們能夠看到，每次都對目標對象進行代理鏈的生成。

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
    parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
    return parameterHandler;
  }
  public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler, 
     ResultHandler resultHandler, BoundSql boundSql) {
    ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
    resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
    return resultSetHandler;
  }
  public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
    statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
    return statementHandler;
  }

public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  executorType = executorType == null ? defaultExecutorType : executorType;
  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  Executor executor;
  if (ExecutorType.BATCH == executorType) {
    executor = new BatchExecutor(this, transaction);
  } else if (ExecutorType.REUSE == executorType) {
    executor = new ReuseExecutor(this, transaction);
  } else {
    executor = new SimpleExecutor(this, transaction);
  }
  if (cacheEnabled) {
    executor = new CachingExecutor(executor);
  }
  executor = (Executor) interceptorChain.pluginAll(executor);
  return executor;
}複製代碼
InterceptorChain裏保存了全部的攔截器，它在mybatis初始化的時候建立。上面interceptorChain.pluginAll(executor)的含義是調用攔截器鏈裏的每一個攔截器依次對executor進行plugin（插入攔截），這種邏輯的向下傳遞，就是 責任鏈模式。plugin方法用於封裝目標對象，經過該方法咱們能夠返回目標對象自己，或者返回一個它的代理。當返回的是代理時，執行方法前會調用攔截器的intercept方法對其進行插入攔截。 在intercept方法中能夠改變Mybatis的默認行爲（諸如SQL重寫之類的）。

以常見的PageInterceptor（給查詢語句增長分頁）爲例（mybatis 攔截器只能使用註解實現）：

@Intercepts({
    @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class,RowBounds.class, ResultHandler.class})
})
@Slf4j
public class PageInterceptor implements Interceptor {
...
/**
 * 執行攔截邏輯的方法
 */
@Override
public Object intercept(Invocation invocation) throws Throwable {
...
}
@Override
public Object plugin(Object target) {
  return Plugin.wrap(target, this);
}
...
}
複製代碼
上面這個例子中，攔截器的註解描述代表：該攔截器只攔截Executor的直接查庫（不查詢緩存）的query方法，也就是說只針對這種查詢作出分頁的加強處理。PageInterceptor實現的plugin方法中只有一句代碼：Plugin.wrap(target, this)，經過該方法返回的對象是目標對象仍是對應的代理，決定是否觸發intercept()方法。

Plugin類的源碼以下：

/**
 * 繼承了InvocationHandler
 */public class Plugin implements InvocationHandler {
  //目標對象
  private final Object target;
  // 攔截器
  private final Interceptor interceptor;
  private final Map<Class<?>, Set<Method>> signatureMap;
  private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
    this.target = target;
    this.interceptor = interceptor;
    this.signatureMap = signatureMap;
  }

  //對一個目標對象進行包裝，生成代理類。
  public static Object wrap(Object target, Interceptor interceptor) {
    //首先根據interceptor上面定義的註解 獲取須要攔截的信息
    Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
    //目標對象的Class
    Class<?> type = target.getClass();
    //返回須要攔截的接口信息
    Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
    //若是長度爲>0 則返回代理類 不然不作處理
    if (interfaces.length > 0) {
      return Proxy.newProxyInstance(
          type.getClassLoader(),
          interfaces,
          new Plugin(target, interceptor, signatureMap));
    }
    return target;
  }

  //代理對象每次調用的方法
  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      //經過method參數定義的類 去signatureMap當中查詢須要攔截的方法集合
      Set<Method> methods = signatureMap.get(method.getDeclaringClass());
      //判斷是否須要攔截
      if (methods != null && methods.contains(method)) {
        //執行攔截器的攔截方法
        return interceptor.intercept(new Invocation(target, method, args));
      }
      //不攔截 直接經過目標對象調用方法
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }
  //根據攔截器接口（Interceptor）實現類上面的註解獲取相關信息
  private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    //獲取註解信息@Intercepts
    Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    if (interceptsAnnotation == null) {//爲空則拋出異常
      throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
    }
    //得到Signature註解信息  是一個數組
    Signature[] sigs = interceptsAnnotation.value();
    Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
    //循環註解信息
    for (Signature sig : sigs) {
      //根據Signature註解定義的type信息去signatureMap當中查詢須要攔截方法的集合
      Set<Method> methods = signatureMap.get(sig.type());
      if (methods == null) { //第一次確定爲null 就建立一個並放入signatureMap
        methods = new HashSet<Method>();
        signatureMap.put(sig.type(), methods);
      }
      try {
        //找到sig.type當中定義的方法 並加入到集合
        Method method = sig.type().getMethod(sig.method(), sig.args());
        methods.add(method);
      } catch (NoSuchMethodException e) {
        throw new PluginException("Could not find method > } } return signatureMap; } //根據對象類型與signatureMap獲取接口信息 private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) { Set<Class<?>> interfaces = new HashSet<Class<?>>(); //循環type類型的接口信息 若是該類型存在與signatureMap當中則加入到set當中去 while (type != null) { for (Class<?> c : type.getInterfaces()) { if (signatureMap.containsKey(c)) { interfaces.add(c); } } type = type.getSuperclass(); } //轉換爲數組返回 return interfaces.toArray(new Class<?>[interfaces.size()]); } } 複製代碼
PageInterceptor生效的時序圖以下：其中Plugin.wrap的target是Executor，this就是當前的interceptor。最後執行PageInterceptor中intercept方法。


其中第二步org.apache.ibatis.plugin.Plugin的wrap方法生成代理類用到了jdk動態代理，屬於設計模式中的 代理模式。

代理模式的設計意圖是爲一個對象提供一個替身或者佔位符以控制對這個對象的訪問，它給目標對象提供一個代理對象，由代理對象控制對目標對象的訪問。

JAVA動態代理與靜態代理相對，靜態代理是在編譯期就已經肯定代理類和真實類的關係，而且生成代理類的。而動態代理是在運行期利用JVM的反射機制生成代理類,這裏是直接生成類的字節碼，而後經過類加載器載入JAVA虛擬機執行。JDK動態代理的實現是在運行時，根據一組接口定義，使用Proxy、InvocationHandler等工具類去生成一個代理類和代理類實例。

在Plugin的wrap方法中jdk動態代理解決的問題是（以Executor爲例）：在不知道被代理Executor的實現類是哪一種（BatchExecutor or ReuseExecutor or SimpleExecutor or CachingExecutor）的狀況下依然可以使用代理模式調用實現類的query方法或者是其它方法。這麼作的好處就是擴展性高，職責清晰。

Mybatis中用到的設計模式還有不少，但願本文能起到一個引導的做用，讓你們多看源碼，關注設計模式，共同窗習，共同進步。


做者簡介

章茂瑜，民生科技有限公司，用戶體驗技術部，移動金融開發平臺開發工程師。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程