在使用低版本的Mybatis的時(shí)候，Mapper中的方法如果有多個(gè)參數(shù)時(shí)需要使用@param注解，才能在對(duì)應(yīng)xml的sql語句中使用參數(shù)名稱獲取傳入方法的參數(shù)值，否則就會(huì)報(bào)錯(cuò)。本文結(jié)合自身在真實(shí)開發(fā)環(huán)境中使用IDEA開發(fā)時(shí)遇到的問題來共同探討一下不使用@Param注解報(bào)錯(cuò)背后的原因以及解決方案。

問題描述

最近使用IDEA進(jìn)行開發(fā)，項(xiàng)目使用SpringBoot+Mybatis3.4.6，同樣的代碼檢出到本地IDEA后運(yùn)行，在一個(gè)業(yè)務(wù)查詢模塊報(bào)錯(cuò)，后臺(tái)打印日志如下：

mybatis出現(xiàn)該錯(cuò)誤的原因分析：我們正在調(diào)用一個(gè)具有多參數(shù)的mapper接口方法，對(duì)這個(gè)方法的調(diào)用其實(shí)是對(duì)mapper對(duì)應(yīng)的xml中的一個(gè)sql的調(diào)用，并且我們?cè)谶@個(gè)sql語句中使用#{方法參數(shù)名稱}的方式構(gòu)建動(dòng)態(tài)SQL，但是要想在sql語句中使用參數(shù)名稱獲取參數(shù)值那么需要對(duì)mapper接口對(duì)應(yīng)方法的每一個(gè)參數(shù)使用@Param注解，Param注解非常簡單，源代碼如下：

/**
 * @author Clinton Begin
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface Param {
  String value();
}

它只有一個(gè)value屬性，這里的value就等于mapper對(duì)應(yīng)的xml文件中獲取參數(shù)值時(shí)要使用的key。于是我找到了對(duì)應(yīng)報(bào)錯(cuò)的代碼發(fā)現(xiàn)正是因?yàn)槎鄥?shù)方法沒有使用@Param注解，在我加上該注解后便沒有錯(cuò)誤了。        

到這里事情看上去好像已經(jīng)解決了,但是并沒有這么簡單，我查看了很多mapper發(fā)現(xiàn)，有很多具有多個(gè)參數(shù)的mapper方法都沒有使用這個(gè)注解，按照這種修改方式，我豈不是要把幾乎所有的mapper都修改一遍，并且我是剛剛檢出的最新代碼，代碼不應(yīng)該有問題才對(duì)，于是詢問同事發(fā)現(xiàn)他們?cè)谧约旱腎DEA運(yùn)行時(shí)并沒有我這個(gè)錯(cuò)誤，所以說并不是@Param注解的問題。

尋求解決方案

同樣的代碼，在不同的機(jī)器上運(yùn)行出現(xiàn)了不同的結(jié)果，那么肯定有什么不一樣的地方，首先JDK都一樣，系統(tǒng)環(huán)境也一樣，運(yùn)行方式也一樣，下來就是運(yùn)行環(huán)境IDEA，那么IDEA是否有區(qū)別呢？

詢問同事發(fā)現(xiàn)他們用的是比較新的版本2019.2.3，而我用的是2018.2.2版本，所以初步懷疑是IDEA的版本問題，但是好像按理來說不應(yīng)該是IDEA的問題，真正運(yùn)行JAVA字節(jié)碼的是本地的JRE環(huán)境，貌似和IDEA關(guān)系不大，但是這是目前唯一的線索，無論如何都要試一下。

于是我下載了最新版本的IDEA，然后導(dǎo)入代碼，運(yùn)行，結(jié)果發(fā)現(xiàn)竟然真的沒有報(bào)錯(cuò)！這時(shí)候問題雖然解決了，但是為什么會(huì)這樣，背后的原因是什么，和IDEA版本有什么關(guān)系呢？這些問題如鯁在喉，讓我茶不思，飯不想…

尋找原因

當(dāng)一個(gè)問題無法知道背后的真正原因時(shí)，那么就算解決了也只是暫時(shí)的。為了尋求真正的答案，我決定使用調(diào)試代碼的方式看一下mybatis執(zhí)行查詢過程中是如何處理mapper接口方法的參數(shù)名稱的，最終找到了org.apache.ibatis.reflection.ParamNameResolver這個(gè)類，看類名就可以知道這是處理參數(shù)名稱的類，主要邏輯集中在它的構(gòu)造方法：

  public ParamNameResolver(Configuration config, Method method) {
    final Class<?>[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap<Integer, String> map = new TreeMap<Integer, String>();
    int paramCount = paramAnnotations.length;
    // get names from @Param annotations
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
      if (isSpecialParameter(paramTypes[paramIndex])) {
        // skip special parameters
        continue;
      }
      String name = null;
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }
      if (name == null) {
        // @Param was not specified.
        if (config.isUseActualParamName()) {
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
          // use the parameter index as the name ("0", "1", ...)
          // gcode issue #71
          name = String.valueOf(map.size());
        }
      }
      map.put(paramIndex, name);
    }
    names = Collections.unmodifiableSortedMap(map);
  }

接下來分析一下主要邏輯，首先看到的是需要獲取Param注解中的Value值：

String name = null;
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }

這里的name變量就是后面構(gòu)造動(dòng)態(tài)sql時(shí)，用于獲取方法參數(shù)值的key，也就是你在xml文件中通過#{ }的方式獲取動(dòng)態(tài)參數(shù)時(shí)的參數(shù)key。接下來看到的代碼是：

      if (name == null) {
        // @Param was not specified.
        if (config.isUseActualParamName()) {
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
          // use the parameter index as the name ("0", "1", ...)
          // gcode issue #71
          name = String.valueOf(map.size());
        }
      }

這里可以看到再次判斷name是否為null，如果為null則判斷config.isUseActualParamName()是否為true，如果是true則通過getActualParamName(method, paramIndex)方法獲取name，這些都執(zhí)行完成如果name還是null，那么就是最后的邏輯： name = String.valueOf(map.size())；也就是說name等于當(dāng)前方法參數(shù)的位置（“0”, “1”, …），源碼的注釋也說明了這一點(diǎn)：

use the parameter index as the name (“0”, “1”, …)

那么getActualParamName(method, paramIndex)方法獲取name是什么邏輯呢？接下來繼續(xù)看：

首先要進(jìn)入這個(gè)方法的前提是config.isUseActualParamName()為true：

public boolean isUseActualParamName() {
    return useActualParamName;
  }

config其實(shí)是mybatis的配置對(duì)象，這里面的配置項(xiàng)目可以影響mybatis的行為，具體配置項(xiàng)目可以從mybatis官方文檔查詢，這里我們就看一下useActualParamName參數(shù)的含義，官方文檔 是這樣描述的：

所以說這個(gè)屬性其實(shí)就是允許我們使用mapper接口方法的參數(shù)名稱當(dāng)作sql語句的參數(shù)名稱，而且也不需要@Param注解，這個(gè)屬性默認(rèn)是開啟的，使用這個(gè)特性還有以下幾個(gè)要求：

①采用 Java 8 編譯。

②編譯時(shí)加上-parameters 選項(xiàng)。

③mybatis在3.4.1以上

到這里基本上可以確定真正的原因了，首先我和同事的JDK都是1.8，Mybatis的版本在文章開頭也說過了是3.4.6，所以只剩下-parameters選項(xiàng)，所以我懷疑是低版本的IDEA沒有這個(gè)選項(xiàng)，高版本的IDEA在編譯時(shí)可能默認(rèn)加了這個(gè)選項(xiàng)。于是對(duì)比兩個(gè)版本的編譯設(shè)置如下：

①老版本(2018.2.2)：

②新版本(2019.2.3)：

果然如我們所料，新版本的IDEA編譯設(shè)置里面默認(rèn)添加了-parameters選項(xiàng)，所以在mybatis的配置項(xiàng)useActualParamName為true的時(shí)候，對(duì)于多參數(shù)的mapper接口方法，可以不使用@Param注解，而在低版本的IDEA時(shí)并沒有添加這個(gè)選項(xiàng)，所以會(huì)出錯(cuò)。

拓展延伸

在Java8之前，JAVA代碼編譯為class文件后，方法參數(shù)的類型固定，但是參數(shù)名稱會(huì)丟失，所以當(dāng)通過反射去獲取方法參數(shù)名稱的時(shí)候是不能夠得到原本源代碼中的參數(shù)名稱的，Java編譯器會(huì)丟掉這部分信息。從JDK1.8開始可以通過在編譯時(shí)添加-parameters這個(gè)選項(xiàng)來明確告訴編譯器我們需要保留方法參數(shù)的原本名稱。

那么為什么不默認(rèn)開啟這個(gè)選項(xiàng)呢？可能是為了避免因?yàn)楸Ａ魠?shù)名而導(dǎo)致class文件過大或者占用更多的內(nèi)存，又或者是有些參數(shù)可能會(huì)泄露安全信息吧。

最后我們親自來寫一段代碼驗(yàn)證一下-parameters這個(gè)選項(xiàng)的作用：

public class Main {
    public static void main(String[] args) {
        Method[] methods = Main.class.getMethods();
        for (Method method:methods) {
            if ("parameterMethodTest".equals(method.getName())){
                Parameter[] parameters = method.getParameters();
                for (Parameter parameter:parameters) {
                    System.out.println(parameter.getName());
                }
            }
        }
    }
    public static void parameterMethodTest(int parameterOne,String parameterTwo,Object parameterThree){
        System.out.println("Hello World!");
    }
}

在以上這段代碼中，通過反射獲取parameterMethodTest的三個(gè)參數(shù)名稱并打印出來，首先我們?cè)贗DEA的編譯設(shè)置中去掉-parameters選項(xiàng)，運(yùn)行結(jié)果如下：

可以看到這個(gè)時(shí)候參數(shù)名稱變成了arg0,arg1…

加上-parameters選項(xiàng)后，再運(yùn)行結(jié)果如下：

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論