MyBatis @Param注解怎么实现

本文小编为大家详细介绍"MyBatis @Param注解怎么实现"，内容详细，步骤清晰，细节处理妥当，希望这篇"MyBatis @Param注解怎么实现"文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。

先说结论：

当输入参数只有一个且没有使用@Param注解时，MyBatis会直接传递这个参数；当输入参数多于一个，或者使用了@Param注解时，MyBatis会将参数封装在Map中传递，这时的Map的key分为以下几种可能：

• Map中会有param1, param2这样的key，其顺序对应输入参数的顺序。无论是否有@Param注解。

• 对于@Param注解的参数，Map中会保存注解中给定的名字作为key

• 对于没有用@Param注解的参数，Map中会用1、2、3 ..这样的数字作为key，按顺序保存输入参数。

下面来看一下源码。

首先，判断一个方法中是否有用@Param注解的参数：

    private boolean hasNamedParams(Method method) {      final Object[][] paramAnnos = method.getParameterAnnotations();      for (Object[] paramAnno : paramAnnos) {        for (Object aParamAnno : paramAnno) {          if (aParamAnno instanceof Param) {            return true;          }        }      }      return false;    }

如果有用@Param注解的参数，取出注解中给出的参数名:

    private String getParamNameFromAnnotation(Method method, int i, String paramName) {      final Object[] paramAnnos = method.getParameterAnnotations()[i];    // 获取第i个参数的注解      for (Object paramAnno : paramAnnos) {        if (paramAnno instanceof Param) {          paramName = ((Param) paramAnno).value();          break;        }      }      return paramName;    }

注意方法的输入参数，method表示是哪个方法上，i 表示第几个参数, paramName是传进来的参数名，如果该参数没有用@Param注解，则返回传进来的paramName。

下面这个方法返回一个TreeMap(有序)，其key表示参数的顺序，比如key=0代表第0个参数；value表示参数的名字，如果有用@Param注解标注，则为标注的参数名，否则和key相等，即用参数的序号作为参数的名字。

    private SortedMap getParams(Method method, boolean hasNamedParameters) {      final SortedMap params = new TreeMap();      final Class[] argTypes = method.getParameterTypes();      for (int i = 0; i < argTypes.length; i++) {        if (!RowBounds.class.isAssignableFrom(argTypes[i]) && !ResultHandler.class.isAssignableFrom(argTypes[i])) {          String paramName = String.valueOf(params.size());    // 参数名，默认为参数的序号          if (hasNamedParameters) {    //如果有使用@Param注解，则获取注解标注的参数名            paramName = getParamNameFromAnnotation(method, i, paramName);    // 这里paramName作为参数传进来，表示默认值          }          params.put(i, paramName);        }      }      return params;    }

其中hasNamedParameters只是从整个方法的维度，给出该方法是否有使用@Param注解的参数；即使其值为true，具体到某一个参数上面，可能没有使用@Param注解，因此调用getParamNameFromAnnotation传入的paramName就作为默认值返回，即参数的序号。

最后将调用方法的参数转换为MyBatis内部使用的参数：

 public Object convertArgsToSqlCommandParam(Object[] args) {      final int paramCount = params.size();      if (args == null || paramCount == 0) {        return null;      } else if (!hasNamedParameters && paramCount == 1) {        return args[params.keySet().iterator().next().intValue()];      } else {        final Map param = new ParamMap