Mybatis：解決調用帶有集合類型形參的mapper方法時，集合參數為空或null的問題

此文章有問題，待修改！

使用Mybatis時，有時需要批量增刪改查，這時就要向mapper方法中傳入集合類型（List或Set）參數，下面是一個示例。

// 該文件不完整，只展現關鍵部分
@Mapper
public class UserMapper {
    List<User> selectByBatchIds(List<Long> ids);
}

<!-- 省略不重要代碼，只保留與selectByBatchIds()方法對應的部分 -->
  <select id="selectByBatchIds" parameterType="long" resultMap="user">
    select * from `user` 
      where id in <foreach item="id" collection="ids" open="(" separator="," close=")">#{id}</foreach>;
  </select>

但是如果傳入的集合類型參數為null或空集合會怎樣呢？如果集合類型參數為null，程序調用方法時拋出NullPointerException；如果集合類型參數為空集合，渲染出來的sql語句將會是"select * from `user` where id in ;"，執行sql時也會報錯。

這類問題經典的解決辦法有兩種。第一種方法，在調用mapper方法前，檢查方法實參是否為null或空集合；第二種方法：在XXMapper.xml的CRUD元素中使用<if>標簽或<choose>標簽進行判斷，下面是一個改進的XXMapper.xml的示例。

<!-- 省略不重要代碼，只保留與selectByBatchIds()方法相關的片段 -->
  <select id="selectByBatchIds" parameterType="long" resultMap="user">
    <choose>
      <when test="ids != null and ids.size() != 0">
        select * from `user` 
          where id in <foreach item="id" collection="ids" open="(" separator="," close=")">#{id}</foreach>
      </when>
      <otherwise>select * from `user` where false</otherwise>
    </choose>;
  </select>

上面的兩種方法都需要在許多地方增加檢查代碼，顯得不夠優雅，有沒有比較優雅的方法呢？有，使用Mybatis攔截器。攔截器可以攔截mapper方法的執行，根據條件決定mapper方法如何執行，如果傳入的參數為空集合，則返回默認值（空集合、0或null）。下面是一個示例。

package demo.persistence.mybatis.interceptor;

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentSkipListSet;

import static org.springframework.util.StringUtils.quote;
import static demo.consts.IntegerType.isIntegerType;
import static demo.consts.RegularExpression.CLASS_METHOD_DELIMITER;

/**
 * 此Mybatis攔截器處理mapper方法中集合類型參數為null或為空的情況。如果集合參數為null或為空，則mapper方法的返回值
 * 為空集合、0或null，具體返回值視方法本身的返回值而定。<br />
 * 注意：① 有的mapper方法將其所需參數放入Map中，此攔截器不處理此類情況；
 * ② 有時，向mapper方法傳遞null參數被視為錯誤，但此攔截器將其當做正常情況處理
 */
// Interceptors注解中寫要攔截的的方法簽名，但是此處要攔截的方法不是mapper類中的方法，而是Executor類中的方法。
// 可能Mybatis在執行mapper方法時是通過Executor類中的方法來執行的吧。
@Intercepts({
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class,
                RowBounds.class, ResultHandler.class}),
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class,
                RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
        @Signature(type = Executor.class, method = "update", args = {MappedStatement.class,Object.class})})
public class EmptyCollectionArgsInterceptor implements Interceptor {

    // 緩存具有集合參數的mapper方法名字以及集合參數的名字，執行這些方法時需要檢查它的方法參數是否為null或為空
    private final static Map<String, Set<String>> REQUIRE_CHECK = new ConcurrentHashMap<>();
    // 緩存沒有集合參數的mapper方法名字，執行這些方法時不需要檢查它的方法參數
    private final static Set<String> NOT_CHECK = new ConcurrentSkipListSet<>();

    @Override
    public Object intercept(@NotNull Invocation invocation) throws Throwable {
        // 獲得Executor方法的實參數組，第一個參數是MappedStatement對象，第二個參數是mapper方法的參數
        final Object[] executorMethodArgs = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) executorMethodArgs[0];
        // 關於mapperMethodArgs變量的說明：
        // (1) 如果mapper方法只有一個參數
        // ① 如果該參數實際為null，則mapperMethodArgs值為null；
        // ② 如果該參數為Map類型且不為null，則mapperMethodArgs的值就是該Map參數的值
        // ③ 如果該參數為List類型且不為null，則mapperMethodArgs的類型為MapperMethod.ParamMap（繼承於HashMap），
        //    Map中有三對鍵值，它們的值都是該List類型實參，鍵則分別為"collection"、"list"和List形參的名字
        // ④ 如果該參數為Set類型且不為null，則mapperMethodArgs的類型為MapperMethod.ParamMap（繼承於HashMap），
        //    Map中有兩對鍵值對，它們的值都是該List類型實參，鍵則分別為"collection"和Set形參的名字
        // (2) 如果mapper方法有多個參數，無論實參是否為null，mapperMethodArgs的類型始終為MapperMethod.ParamMap，
        //     Map中的鍵值對就是mapper方法的形參名字與實參值的對，此時集合類型參數沒有別名
        Object mapperMethodArgs = executorMethodArgs[1];
        // mapper方法id，就是在XXMapper.xml的CRUD元素中寫的id，而且在該id前加上了對應mapper接口的全限定類名
        final String mapperMethodId = mappedStatement.getId();

        // 通過mapperMethodId判斷該mapper方法是否有集合參數。如果mapperMethodId尚未緩存，requireCheck()方法會將其緩存。
        if (requireCheck(mapperMethodId)) {
            // 如果該mapper方法有集合參數
            // 而mapperMethodArgs為null，顯然傳入該mapper方法的實參為null，這時應該返回默認值
            if (mapperMethodArgs == null) {
                return getDefaultReturnValue(invocation);
            }
            // 如果mapperMethodArgs不為null，那么它一定是Map類型的參數
            Map<String, ?> argMap = (Map<String, ?>) mapperMethodArgs;
            final Set<String> requiredNotEmptyArgs = REQUIRE_CHECK.get(mapperMethodId);
            for (String requiredNotEmptyArg : requiredNotEmptyArgs) {
                // 從argMap取出所有集合類型的實參，檢查它是否為null或是否為空。如果是，則返回默認值
                final Object arg = argMap.get(requiredNotEmptyArg);
                if (arg == null || ((Collection<?>) arg).isEmpty()) {
                    return getDefaultReturnValue(invocation);
                }
            }
        }

        // 如果上述檢查沒有問題，則讓mapper方法正常執行
        return invocation.proceed();
    }

    /**
     * 當mapper方法出錯時返回的默認值。
     * @return 如果Executor方法返回List類型對象，則此方法返回空List；如果Executor方法返回數字，則此方法返回0；其余情況返回null。
     */
    private @Nullable Object getDefaultReturnValue(@NotNull Invocation invocation) {
        Class<?> returnType = invocation.getMethod().getReturnType();
        if (returnType.equals(List.class)) {
            return Collections.emptyList();
            // isIntegerType()方法判斷Class對象是不是整數Class，自己寫
        } else if (isIntegerType(returnType)) {
            return 0;
        }
        return null;
    }

    /**
     * 檢查mapper方法是否有集合類型參數。<br />
     * 注意：此方法有副作用。
     * @param mapperMethodId mapper方法。由mapper類的全限定名和方法名字組成。可由MappedStatement.getId()方法獲取。
     * @throws ClassNotFoundException 如果未能找到指定的mapper方法的類
     * @throws NoSuchMethodException 如果未能找到指定的mapper方法
     */
    private static boolean requireCheck(String mapperMethodId) throws ClassNotFoundException, NoSuchMethodException {
        // 如果該方法名字存在於無需檢查方法集合中，說明該方法無需檢查，返回false
        if (NOT_CHECK.contains(mapperMethodId)) {
            return false;
        }
        // 如果該方法名字存在於需要檢查方法Map中，說明該方法需要檢查，返回true
        if (REQUIRE_CHECK.containsKey(mapperMethodId)) {
            return true;
        }

        // 如果方法名字不在緩存中，則進行以下操作：
        // 從完整方法名中分割出全限定類名和方法名
        // CLASS_METHOD_DELIMITER是類和方法分隔符，自己寫吧
        final String[] fullClassAndMethod = mapperMethodId.split(CLASS_METHOD_DELIMITER, 2);
        final String fullQualifiedName = fullClassAndMethod[0];
        final String methodName = fullClassAndMethod[1];
        Method targetMethod = null;
        int paramCount = -1;
        // 遍歷指定對應類的全部方法，以找到目標方法
        for (Method method : Class.forName(fullQualifiedName).getMethods()) {
            // 個人習慣是在mapper接口中定義幾個重載的默認方法，這些默認方法的參數數量比同名的非默認方法的參數數量少，
            // 所以參數數量最多的方法就是要攔截並檢查的方法
            if (method.getName().equals(methodName) && method.getParameterCount() > paramCount) {
                targetMethod = method;
                paramCount = method.getParameterCount();
            }
        }

        if (targetMethod == null) {
            throw new NoSuchMethodException("Can't find method " + quote(mapperMethodId));
        }
        // 檢查目標方法是否有集合參數。如果有，則將該集合參數的名字放入collectionArgNames中。
        Set<String> collectionArgNames = new HashSet<>();
        for (Parameter parameter : targetMethod.getParameters()) {
            if (Collection.class.isAssignableFrom(parameter.getType())) {
                collectionArgNames.add(parameter.getName());
            }
        }
        if (collectionArgNames.isEmpty()) {
            // 如果collectionArgNames為空，說明該方法沒有集合參數，不需要檢查，返回false
            // 同時將該方法名字存入無需檢查方法集合中
            NOT_CHECK.add(mapperMethodId);
            return false;
        } else {
            // 如果該collectionArgNames不為空，說明該方法有集合參數，需要檢查，返回true
            // 同時將該方法名字存入需要檢查方法Map中
            REQUIRE_CHECK.put(mapperMethodId, collectionArgNames);
            return true;
        }
    }

}

要使該攔截器生效，需要在mybatis-config.xml中配置該攔截器，在mybatis-config.xml中添加如下內容即可：

    <plugins>
        <plugin interceptor="demo.persistence.mybatis.interceptor.EmptyCollectionArgsInterceptor" />
    </plugins>