Mybatis源碼閱讀（三）：結果集映射3.3 —

*************************************優雅的分割線 **********************************

分享一波:程序員賺外快-必看的巔峰干貨

如果以上內容對你覺得有用,并想獲取更多的賺錢方式和免費的技術教程

請關注微信公眾號:HB荷包

一個能讓你學習技術和賺錢方法的公眾號,持續更新
*************************************優雅的分割線 **********************************
前言

在前面兩篇博客中，我們介紹了對于select語句的簡單映射和嵌套映射。mybatis中使用ResultHandler等一系列的類，將查詢結果封裝到實體類中，可以說是mybatis中最復雜的過程，而剩下的insert、update、delete語句的操作則顯得較為簡單，沒有復雜的映射邏輯。這里需要提的是在insert語句中，關于主鍵自增的問題。
KeyGenerator

在我們實際的開發中，自增主鍵還是使用比較多的。而mybatis在處理insert語句時，并不會將自增主鍵給返回，而是返回插入的條數。當我們有業務需求要獲取插入時產生的自增主鍵（或者其他類型不由程序生成的主鍵）時，則可以使用KeyGenerator。

KeyGenerator是個接口，定義了processBefore和processAfter兩個方法，分別在insert之前和之后執行，代碼如下。

/**

insert語句不會反回自動生成的主鍵
該接口用于在插入記錄時獲取自增主鍵
@author Clinton Begin
*/
public interface KeyGenerator {

/**
- 執行insert之前執行，設置屬性order=“BEFORE”
- @param executor
- @param ms
- @param stmt
- @param parameter
  */
  void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter);
/**
- 執行insert之后執行，設置屬性order=“AFTER”
- @param executor
- @param ms
- @param stmt
- @param parameter
  */
  void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter);

}

KeyGenerator有三個實現類

其中NoKeyGenerator的方法都是空實現，本文不再講解。
Jdbc3KeyGenerator

Jdbc3KeyGenerator用于取回數據庫生成的自增id，它對應于mybatis-config.xml配置的useGeneratedKeys，以及insert節點中配置的useGeneratedKeys屬性。

Jdbc3KeyGenerator的processBefore是空實現，只實現了processAfter方法，該方法會調用processBatch方法將SQL語句執行后生成的主鍵記錄到用戶傳遞的實參中，而不是直接返回。代碼如下。

/*** 核心方法，將sql語句生成的主鍵存放到參數中** @param ms* @param stmt* @param parameter*/
public void processBatch(MappedStatement ms, Statement stmt, Object parameter) {// 獲取sql節點配置的keyProperties，指定主鍵的字段final String[] keyProperties = ms.getKeyProperties();if (keyProperties == null || keyProperties.length == 0) {return;}// 獲取數據庫生成的主鍵。如果沒有生成主鍵則結果集為空try (ResultSet rs = stmt.getGeneratedKeys()) {// 獲取resultSet元信息final ResultSetMetaData rsmd = rs.getMetaData();// 獲取Configurationfinal Configuration configuration = ms.getConfiguration();// 查到的列數小于主鍵的列數，說明查詢有誤。mybatis不進行處理if (rsmd.getColumnCount() < keyProperties.length) {// Error?} else {assignKeys(configuration, rs, rsmd, keyProperties, parameter);}} catch (Exception e) {throw new ExecutorException("Error getting generated key or setting result to parameter object. Cause: " + e, e);}
}

在assignKeys方法中，處理對主鍵賦值的邏輯。該方法會判斷參數的類型，將Map、集合、對象三種情況分別進行處理。代碼如下。

private void assignKeys(Configuration configuration, ResultSet rs, ResultSetMetaData rsmd, String[] keyProperties,Object parameter) throws SQLException {if (parameter instanceof ParamMap || parameter instanceof StrictMap) {// 參數是mapassignKeysToParamMap(configuration, rs, rsmd, keyProperties, (Map<String, ?>) parameter);} else if (parameter instanceof ArrayList && !((ArrayList<?>) parameter).isEmpty()&& ((ArrayList<?>) parameter).get(0) instanceof ParamMap) {// 參數是集合assignKeysToParamMapList(configuration, rs, rsmd, keyProperties, ((ArrayList<ParamMap<?>>) parameter));} else {// 參數是對象assignKeysToParam(configuration, rs, rsmd, keyProperties, parameter);}
}

三個方法邏輯類似，這里只對assignKeysToParam方法進行分析，。

該方法會在進入方法時，將參數轉為集合，并遍歷集合去給主鍵進行賦值，代碼如下。

/*** 當參數是對象時的處理邏輯** @param configuration* @param rs* @param rsmd* @param keyProperties* @param parameter* @throws SQLException*/
private void assignKeysToParam(Configuration configuration, ResultSet rs, ResultSetMetaData rsmd,String[] keyProperties, Object parameter) throws SQLException {// 將參數轉為集合，此時這個集合最多只有一個對象Collection<?> params = collectionize(parameter);if (params.isEmpty()) {return;}// 存放主鍵屬性的信息List<KeyAssigner> assignerList = new ArrayList<>();for (int i = 0; i < keyProperties.length; i++) {assignerList.add(new KeyAssigner(configuration, rsmd, i + 1, null, keyProperties[i]));}Iterator<?> iterator = params.iterator();while (rs.next()) {if (!iterator.hasNext()) {throw new ExecutorException(String.format(MSG_TOO_MANY_KEYS, params.size()));}Object param = iterator.next();assignerList.forEach(x -> x.assign(rs, param));}
}

SelectKeyGenerator

MySql、PostgreSql等數據庫支持自增主鍵，在執行insert時可以不指定主鍵，插入的過程中由數據庫去生成自增主鍵。而像Oracle、DB2等數據庫產品則需要使用sequence實現自增id，因此在insert之前必須明確指定主鍵的值。SelectKeyGenerator就用來處理不支持自增主鍵的數據庫。

SelectKeyGenerator主要用于生成主鍵，它會執行映射配置文件中定義的selectKey節點的sql，該語句會獲取insert語句所需要的主鍵。

SelectKeyGenerator中有兩個核心字段，keyStatement用于存放解析后的selectKey節點，executeBefore用于標識該節點是在insert之前還是之后執行。

/*** 標識selectKey是在insert之前還是之后執行* true為之前，false為之后*/
private final boolean executeBefore;
/*** 存放selectKey節點，用于獲取insert語句使用的主鍵*/
private final MappedStatement keyStatement;

SelectKeyGenerator的processBefore和processAfter都是執行processGeneratorKeys方法，根據executeBefore字段的值決定是在insert之前還是之后執行。

@Override
public void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {if (executeBefore) {processGeneratedKeys(executor, ms, parameter);}
}@Override
public void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {if (!executeBefore) {processGeneratedKeys(executor, ms, parameter);}
}

processGeneratorKeys方法是處理主鍵的核心代碼。該方法會先獲取selectKey節點的keyProperties配置的屬性名稱，該屬性對應著主鍵。接著，創建Executor執行器，執行selectKey節點中的sql，查詢主鍵。Executor是mybatis的核心執行器，后面的博客會對其進行介紹。

selectKey執行完畢后，會判斷查詢結果是否合法。主鍵的查詢結果肯定只會返回一條，因此查詢結果條數不為1的全部視為非法查詢。該方法代碼如下。

private void processGeneratedKeys(Executor executor, MappedStatement ms, Object parameter) {try {if (parameter != null && keyStatement != null && keyStatement.getKeyProperties() != null) {// 獲取selectKey節點的keyProperties配置的屬性名稱，表示主鍵對應的屬性String[] keyProperties = keyStatement.getKeyProperties();final Configuration configuration = ms.getConfiguration();// 創建用戶傳入的實參對應的MetaObject對象final MetaObject metaParam = configuration.newMetaObject(parameter);// 創建Executor對象，執行keyStatement記錄的sql。Executor是mybatis中的執行器，后面會講Executor keyExecutor = configuration.newExecutor(executor.getTransaction(), ExecutorType.SIMPLE);// 執行selectKey節點的sql，查詢主鍵List<Object> values = keyExecutor.query(keyStatement, parameter, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);if (values.size() == 0) {throw new ExecutorException("SelectKey returned no data.");} else if (values.size() > 1) {throw new ExecutorException("SelectKey returned more than one value.");} else {// 主鍵查詢出來肯定只有一條，因此values的size不等于1的情況都是錯誤的// 創建主鍵對象對應的MetaObjectMetaObject metaResult = configuration.newMetaObject(values.get(0));if (keyProperties.length == 1) {if (metaResult.hasGetter(keyProperties[0])) {// 取出主鍵的值，設置到用戶參數對應的屬性中setValue(metaParam, keyProperties[0], metaResult.getValue(keyProperties[0]));} else {// 如果主鍵對象不包含get方法，就可能是基本類型或者String，直接復制setValue(metaParam, keyProperties[0], values.get(0));}} else {// 處理主鍵有多列的情況handleMultipleProperties(keyProperties, metaParam, metaResult);}}}} catch (ExecutorException e) {throw e;} catch (Exception e) {throw new ExecutorException("Error selecting key or setting result to parameter object. Cause: " + e, e);}
}

該方法中有一個handleMultipleProperties方法，用于處理一張表多個主鍵的情況。由于復合主鍵耦合性高、影響性能，并且操作起來較為繁瑣，因此不推薦數據庫中給一張表設置多個主鍵，這里也就不對該方法進行介紹。
結語

KeyGenerator的代碼較為簡單，閱讀起來也不會吃力。本周我公司已經開始了上班，因此博客也需要開始寫了，mybatis的源碼已經閱讀了一大半，爭取在7月份之前把剩下代碼的博客全部編寫完畢
*************************************優雅的分割線 **********************************