碼上快樂

相關內容    簡體    繁體

ibatis源碼學習1_整體設計和核心流程

本文轉載自   查看原文   2016-07-22 10:15   1635    iBatis

背景
介紹ibatis實現之前，先來看一段jdbc代碼:

Java代碼   收藏代碼
  1. Class.forName("com.mysql.jdbc.Driver"); 
  2. String url = "jdbc:mysql://localhost:3306/learnworld"; 
  3. Connection con = DriverManager.getConnection(url, "root","learnworld");          
  4. String sql = "select * from test"; 
  5. PreparedStatement ps = con.prepareStatement(sql);            
  6. ResultSet rs = ps.executeQuery(); 
  7. while(rs.next()){ 
  8.     System.out.println("id=" + rs.getInt(1)+". score=" + rs.getInt(2)); 
  9. } 


上面這段代碼大家比較熟悉，這是一個典型的jdbc方式處理流程: 建立連接->傳遞參數->sql執行->處理結果->關閉連接。

問題
上面的代碼中包含了很多不穩定的因素，可能會經常發生修改:
1. 數據源和事務管理等
2. sql語句
3. 入參和結果處理
如果這些發生變化，我們需要直接修改代碼，重新編譯、打包、發布等。

DIY
下面從我們自己DIY的視角來考慮如何設計框架，應對這些問題。框架的核心思想是抽取共性，封裝可能出現的變化。
如何處理數據源變化？
將數據源連接等過程固定，將數據源中易變的信息封裝在一起(如driverClassName, url等)，放在配置文件中。

如何處理sql語句的變化？
將sql語句統一放在配置文件中，為每條sql語句設置標識，在代碼中使用標識進行調用。

如何應對入參和結果處理的變化？
將參數傳遞，結果映射到java bean等統一封裝在配置文件中。

結論: 將不變的流程固化到代碼中，將變化的信息封裝在配置文件中。


核心接口
ibatis抽取了以下幾個重要接口:

1. SqlMapExecutor
該接口是對SQL操作行為的抽象，提供了SQL單條執行和批處理涉及的所有操作方法。



2. SqlMapTransactionManager
該接口是對事務行為的抽象，提供了事務執行過程中的涉及的所有方法。


3. SqlMapClient
該接口定位是SQL執行客戶端，是線程安全的，用於處理多個線程的sql執行。它繼承了上面兩個接口，這意味着該接口具有SQL執行、批處理和事 務處理的能力，如果你擁有該接口的實現類，意味着執行任何SQL語句對你來說是小菜一碟。該接口的核心實現類是SqlMapClientImpl。

4. SqlMapSession
該接口在繼承關系上和SqlMapClient一致，但它的定位是保存單線程sql執行過程的session信息。該接口的核心實現類是SqlMapSessionImpl。

5. MappedStatement
該接口定位是單條SQL執行時的上下文環境信息，如SQL標識、SQL、參數信息、返回結果、操作行為等。

6. ParameterMap/ResultMap
該接口用於在SQL執行的前后提供參數准備和執行結果集的處理。

以上接口的類圖關系如下(部分):


這里必須要強調SqlMapExecutorDelegate這個類，他是一個執行代理類，在ibatis框架中地位非常重要，因為他耦合了用戶端的操作行為和執行環境，他持有執行操作的所需要的所有數據，同時管理着執行操作依賴的環境。

初始化過程
1. 讀取和解析sqlmap配置文件。
2. 注冊Statement對象。
3. 創建SqlMapClientImpl對象。

下面是一個Spring中sqlMapClient的bean配置:

Java代碼   收藏代碼
  1. <bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean"> 
  2.     <property name="dataSource" ref="dataSource" /> 
  3.     <property name="configLocation" value="classpath/sqlmap/sqlmap-ibatis.xml" /> 
  4. </bean> 


下面看一下SqlMapClientFactoryBean的初始化方法afterPropertiesSet()，用於構建sqlMapClient對象:

Java代碼   收藏代碼
  1. public void afterPropertiesSet()throws Exception { 
  2.     ... 
  3.  
  4.     this.sqlMapClient = buildSqlMapClient(this.configLocations,this.mappingLocations, this.sqlMapClientProperties);  //初始化核心方法，構建sqlMapClient對象 
  5.  
  6.     ... 
  7. } 


看一下buildSqlMapClient()的實現:

Java代碼   收藏代碼
  1. protected SqlMapClient buildSqlMapClient( 
  2.         Resource[] configLocations, Resource[] mappingLocations, Properties properties) 
  3.         throws IOException { 
  4.                ... 
  5.     SqlMapClient client = null; 
  6.     SqlMapConfigParser configParser = new SqlMapConfigParser(); 
  7.     for (int i =0; i < configLocations.length; i++) { 
  8.         InputStream is = configLocations[i].getInputStream(); 
  9.         try { 
  10.             client = configParser.parse(is, properties); //通過SqlMapConfigParser解析配置文件，生成SQLMapClientImpl對象 
  11.         } 
  12.         catch (RuntimeException ex) { 
  13.             throw new NestedIOException("Failed to parse config resource: " + configLocations[i], ex.getCause()); 
  14.         } 
  15.     } 
  16.     ... 
  17.     return client; 
  18. } 


初始化的核心是通過配置文件構建SQLMapClientImpl對象和其內部的各個屬性，這里就不詳述了，詳細構建過程將另文分析。

SQL執行過程
下面以一個select語句的執行過程，分析一下以上各ibatis核心接口相互如何配合。
1. dao調用SqlMapClientTemplate的query()方法：

Java代碼   收藏代碼
  1. public Object queryForObject(final String statementName,final Object parameterObject) 
  2.         throws DataAccessException { 
  3.  
  4.     return execute(new SqlMapClientCallback() { 
  5.         public Object doInSqlMapClient(SqlMapExecutor executor)throws SQLException { 
  6.             return executor.queryForObject(statementName, parameterObject); 
  7.         } 
  8.     }); 
  9. } 



2. execute()方法中展示了執行過程中的核心邏輯：獲取session -> 獲取connection -> 執行sql ->釋放connection -> 關閉session。
部分源碼如下：

Java代碼   收藏代碼
  1. public Object execute(SqlMapClientCallback action)throws DataAccessException { 
  2.                 ... 
  3.         SqlMapSession session = this.sqlMapClient.openSession();//獲取session信息 
  4.          
  5.         Connection ibatisCon = null;    //獲取Connection 
  6.  
  7.         try { 
  8.             Connection springCon = null; 
  9.             DataSource dataSource = getDataSource(); 
  10.             boolean transactionAware = (dataSourceinstanceof TransactionAwareDataSourceProxy); 
  11.  
  12.             try { 
  13.                 ibatisCon = session.getCurrentConnection(); 
  14.                 if (ibatisCon == null) { 
  15.                     springCon = (transactionAware ? 
  16.                             dataSource.getConnection() : DataSourceUtils.doGetConnection(dataSource)); 
  17.                     session.setUserConnection(springCon); 
  18.                 ... 
  19.                 } 
  20.             } 
  21.             ... 
  22.  
  23.             // Execute given callback... 
  24.             try { 
  25.                 return action.doInSqlMapClient(session);//執行SQL 
  26.             } 
  27.             ... 
  28.             finally { 
  29.                         // 關閉Connection 
  30.                 try { 
  31.                     if (springCon !=null) { 
  32.                         if (transactionAware) { 
  33.                             springCon.close();  
  34.                         } 
  35.                         else { 
  36.                             DataSourceUtils.doReleaseConnection(springCon, dataSource); 
  37.                         } 
  38.                     } 
  39.                 } 
  40.                  
  41.             if (ibatisCon == null) { 
  42.                 session.close(); //關閉session 
  43.             } 
  44.         } 



3. action.doInSqlMapClient(session)調用SqlMapSessionImpl().queryForObject()方法。 
注意: 這里調用對象主體為SqlMapSessionImpl，表示在線程session中執行sql(session是ThreadLocal的)，而不在負責整體協調的SqlMapClientImpl中執行sql語句。
源碼如下：

Java代碼   收藏代碼
  1. public Object queryForObject(final String statementName,final Object parameterObject) 
  2.         throws DataAccessException { 
  3.  
  4.     return execute(new SqlMapClientCallback() { 
  5.        //這里的SqlMapExecutor對象類型為SqlMapSessionImpl 
  6.         public Object doInSqlMapClient(SqlMapExecutor executor)throws SQLException { 
  7.             return executor.queryForObject(statementName, parameterObject); 
  8.         } 
  9.     }); 
  10. } 



4. SqlMapSessionImpl().queryForObject()的方法很簡單，直接交給代理對象SqlMapExecutorDelegate處理:

Java代碼   收藏代碼
  1. public Object queryForObject(String id, Object paramObject)throws SQLException { 
  2.   return delegate.queryForObject(session, id, paramObject); 
  3. } 



5. SqlMapExecutorDelegate的queryForObject()方法代碼如下:

Java代碼   收藏代碼
  1. public Object queryForObject(SessionScope session, String id, Object paramObject, Object resultObject)throws SQLException { 
  2.   Object object = null; 
  3.  
  4.   MappedStatement ms = getMappedStatement(id); //MappedStatement對象集是上文中提及的初始化方法SqlMapClientFactoryBean.afterPropertiesSet()中，由配置文件構建而成 
  5.   Transaction trans = getTransaction(session); // 用於事務執行 
  6.   boolean autoStart = trans == null; 
  7.  
  8.   try { 
  9.     trans = autoStartTransaction(session, autoStart, trans); 
  10.  
  11.     RequestScope request = popRequest(session, ms);  // 從RequestScope池中獲取該次sql執行中的上下文環境RequestScope  
  12.     try { 
  13.       object = ms.executeQueryForObject(request, trans, paramObject, resultObject);  // 執行sql 
  14.     } finally { 
  15.       pushRequest(request);  //歸還RequestScope 
  16.     } 
  17.  
  18.     autoCommitTransaction(session, autoStart); 
  19.   } finally { 
  20.     autoEndTransaction(session, autoStart); 
  21.   } 
  22.  
  23.   return object; 
  24. } 



6. MappedStatement攜帶了SQL語句和執行過程中的相關信息，MappedStatement.executeQueryForObject()方法部分源碼如下:

Java代碼   收藏代碼
  1. public Object executeQueryForObject(RequestScope request, Transaction trans, Object parameterObject, Object resultObject) 
  2.     throws SQLException { 
  3.   try { 
  4.     Object object = null; 
  5.  
  6.     DefaultRowHandler rowHandler = new DefaultRowHandler(); 
  7.     executeQueryWithCallback(request, trans.getConnection(), parameterObject, resultObject, rowHandler, SqlExecutor.NO_SKIPPED_RESULTS, SqlExecutor.NO_MAXIMUM_RESULTS);//執行sql語句 
  8.      
  9.     //結果處理，返回結果 
  10.     List list = rowHandler.getList();  
  11.     if (list.size() > 1) { 
  12.       throw new SQLException("Error: executeQueryForObject returned too many results."); 
  13.     } else if (list.size() >0) { 
  14.       object = list.get(0); 
  15.     } 
  16.  
  17.     return object; 
  18.   }  
  19.   .... 
  20. } 



7. MappedStatement.executeQueryWithCallback()方法包含了參數值映射、sql准備和sql執行等關鍵過程，部分源碼如下:

Java代碼   收藏代碼
  1. protected void executeQueryWithCallback(RequestScope request, Connection conn, Object parameterObject, Object resultObject, RowHandler rowHandler,int skipResults, int maxResults) 
  2.     throws SQLException { 
  3.     ... 
  4.   try { 
  5.     parameterObject = validateParameter(parameterObject);  //驗證入參 
  6.  
  7.     Sql sql = getSql();  //獲取SQL對象 
  8.  
  9.     errorContext.setMoreInfo("Check the parameter map."); 
  10.     ParameterMap parameterMap = sql.getParameterMap(request, parameterObject);// 入參映射 
  11.  
  12.     errorContext.setMoreInfo("Check the result map."); 
  13.     ResultMap resultMap = sql.getResultMap(request, parameterObject); //結果映射 
  14.  
  15.     request.setResultMap(resultMap); 
  16.     request.setParameterMap(parameterMap); 
  17.  
  18.     errorContext.setMoreInfo("Check the parameter map."); 
  19.     Object[] parameters = parameterMap.getParameterObjectValues(request, parameterObject); //獲取參數值 
  20.  
  21.     errorContext.setMoreInfo("Check the SQL statement."); 
  22.     String sqlString = sql.getSql(request, parameterObject);  //獲取拼裝后的sql語句 
  23.  
  24.     errorContext.setActivity("executing mapped statement"); 
  25.     errorContext.setMoreInfo("Check the SQL statement or the result map."); 
  26.     RowHandlerCallback callback = new RowHandlerCallback(resultMap, resultObject, rowHandler); 
  27.     sqlExecuteQuery(request, conn, sqlString, parameters, skipResults, maxResults, callback); //sql執行 
  28.  
  29.     errorContext.setMoreInfo("Check the output parameters."); 
  30.     if (parameterObject != null) { 
  31.       postProcessParameterObject(request, parameterObject, parameters); 
  32.     } 
  33.  
  34.     errorContext.reset(); 
  35.     sql.cleanup(request); 
  36.     notifyListeners(); 
  37.     .... 
  38. } 



8. 到了執行中最核心的一步，也是最后一步: MappedStatement.sqlExecuteQuery()方法，它負責sql的最后執行，內部調用了SqlExecutor.executeQuery()方法，部分源碼如下:

Java代碼   收藏代碼
  1. public void executeQuery(RequestScope request, Connection conn, String sql, Object[] parameters,int skipResults, intmaxResults, RowHandlerCallback callback)throws SQLException { 
  2.   ... 
  3.   PreparedStatement ps = null; 
  4.   ResultSet rs = null; 
  5.   setupResultObjectFactory(request); 
  6.   try { 
  7.     errorContext.setMoreInfo("Check the SQL Statement (preparation failed)."); 
  8.     Integer rsType = request.getStatement().getResultSetType(); 
  9.     //初始化PreparedStatement，設置sql、參數值等 
  10.     if (rsType != null) { 
  11.       ps = prepareStatement(request.getSession(), conn, sql, rsType); 
  12.     } else { 
  13.       ps = prepareStatement(request.getSession(), conn, sql); 
  14.     } 
  15.     setStatementTimeout(request.getStatement(), ps); 
  16.     Integer fetchSize = request.getStatement().getFetchSize(); 
  17.     if (fetchSize != null) { 
  18.       ps.setFetchSize(fetchSize.intValue()); 
  19.     } 
  20.     errorContext.setMoreInfo("Check the parameters (set parameters failed)."); 
  21.     request.getParameterMap().setParameters(request, ps, parameters); 
  22.     errorContext.setMoreInfo("Check the statement (query failed)."); 
  23.     ps.execute(); //執行 
  24.     errorContext.setMoreInfo("Check the results (failed to retrieve results)."); 
  25.  
  26.     // ResultSet處理 
  27.     rs = handleMultipleResults(ps, request, skipResults, maxResults, callback); 
  28.   } finally { 
  29.     try { 
  30.       closeResultSet(rs); 
  31.     } finally { 
  32.       closeStatement(request.getSession(), ps); 
  33.     } 
  34.   } 
  35.  
  36. } 


上面這段代碼大家會非常熟悉，和本文開始處的代碼很相似，ibatis歸根到底，是對JDBC操作一定程度上的封裝而已。

下面在總體上概括sql的一般執行過程:
SqlMapClientImpl接到請求后，創建SqlMapSessionImpl對象(ThreadLocal，保證線程安 全)，SqlMapSessionImpl交由內部的代理類SqlMapExecutorDelegate執行，代理類獲取相應的MappedStatement，交由MappedStatement對象執行，MappedStatement交由SqlExecutor執行，最終使 用JDBC方式執行sql。

小結
ibatis源碼規模較小，整體設計思路清晰，閱讀ibatis源碼可以按以下思路進行:
1. 了解ibatis框架的整體目標，用於解決哪些問題。
2. ibatis如何解決這些問題，帶着問題去學習。
3. 了解ibatis框架的核心接口和整體設計思路。
4. 抓住ibatis核心流程: 初始化和請求處理流程。
5. 詳細ibatis框架的關鍵細節實現，如ibatis中的配置文件解析，參數和結果映射等。


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 vue源碼實現的整體流程解析 Airtest源碼分析--圖像識別整體流程 node源碼詳解（二 ）—— 運行機制 、整體流程 linux內存源碼分析 - 內存回收(整體流程) 104 - kube-scheduler源碼分析 - predicate整體流程 Spring 源碼（1）Spring IOC Bean 創建的整體流程 Ionic學習筆記1_基本布局 arm cortex-m0plus源碼學習（一）整體框架 Alink漫談(十二) ：在線學習算法FTRL 之 整體設計 kafka學習（六）kafka核心設計原理
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM