通过源代码分析Mybatis的功能

SQL解析

Mybatis在初始化的时候，会读取xml中的SQL，解析后会生成SqlSource对象，SqlSource对象分为两种。

• DynamicSqlSource，动态SQL，获取SQL(getBoundSQL方法中)的时候生成参数化SQL。

• RawSqlSource，原始SQL，创建对象时直接生成参数化SQL。

因为RawSqlSource不会重复去生成参数化SQL，调用的时候直接传入参数并执行，而DynamicSqlSource则是每次执行的时候参数化SQL，所以RawSqlSource是DynamicSqlSource的性能要好的。

解析的时候会先解析include标签和selectkey标签，然后判断是否是动态SQL，判断取决于以下两个条件：

• SQL中有动态拼接字符串，简单来说就是是否使用了${}表达式。注意这种方式存在SQL注入，谨慎使用。
• SQL中有trim、where、set、foreach、if、choose、when、otherwise、bind标签

相关代码如下：

protected MixedSqlNode parseDynamicTags(XNode node) {
    // 创建 SqlNode 数组
    List contents = new ArrayList<>();
    // 遍历 SQL 节点的所有子节点
    NodeList children = node.getNode().getChildNodes();
    for (int i = 0; i < children.getLength(); i++) {
        // 当前子节点
        XNode child = node.newXNode(children.item(i));
        // 如果类型是 Node.CDATA_SECTION_NODE 或者 Node.TEXT_NODE 时
        if (child.getNode().getNodeType() == Node.CDATA_SECTION_NODE || child.getNode().getNodeType() == Node.TEXT_NODE) {
            // 获得内容
            String data = child.getStringBody("");
            // 创建 TextSqlNode 对象
            TextSqlNode textSqlNode = new TextSqlNode(data);
            // 如果是动态的 TextSqlNode 对象(是否使用了${}表达式)
            if (textSqlNode.isDynamic()) {
                // 添加到 contents 中
                contents.add(textSqlNode);
                // 标记为动态 SQL
                isDynamic = true;
                // 如果是非动态的 TextSqlNode 对象
            } else {
                // 创建 StaticTextSqlNode 添加到 contents 中
                contents.add(new StaticTextSqlNode(data));
            }
            // 如果类型是 Node.ELEMENT_NODE，其实就是XMl中等那些动态标签
        } else if (child.getNode().getNodeType() == Node.ELEMENT_NODE) { // issue #628
            // 根据子节点的标签，获得对应的 NodeHandler 对象
            String nodeName = child.getNode().getNodeName();
            NodeHandler handler = nodeHandlerMap.get(nodeName);
            if (handler == null) { // 获得不到，说明是未知的标签，抛出 BuilderException 异常
                throw new BuilderException("Unknown element <" + nodeName + "> in SQL statement.");
            }
            // 执行 NodeHandler 处理
            handler.handleNode(child, contents);
            // 标记为动态 SQL
            isDynamic = true;
        }
    }
    // 创建 MixedSqlNode 对象
    return new MixedSqlNode(contents);
}

参数解析

Mybais中用于解析Mapper方法的参数的类是ParamNameResolver，它主要做了这些事情：

• 每个Mapper方法第一次运行时会去创建ParamNameResolver，之后会缓存

• 创建时会根据方法签名，解析出参数名，解析的规则顺序是

  1. 如果参数类型是RowBounds或者ResultHandler类型或者他们的子类，则不处理。

  2. 如果参数中有Param注解，则使用Param中的值作为参数名

  3. 如果配置项useActualParamName=true，argn(n>=0)标作为参数名，如果你是Java8以上并且开启了-parameters`，则是实际的参数名

     如果配置项useActualParamName=false，则使用n(n>=0)作为参数名

相关源代码：

public ParamNameResolver(Configuration config, Method method) {
    final Class[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap map = new TreeMap();
    int paramCount = paramAnnotations.length;
    // 获取方法中每个参数在SQL中的参数名
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
        // 跳过RowBounds、ResultHandler类型
        if (isSpecialParameter(paramTypes[paramIndex])) {
            continue;
        }
        String name = null;
        // 遍历参数上面的所有注解，如果有Param注解，使用它的值作为参数名
        for (Annotation annotation : paramAnnotations[paramIndex]) {
            if (annotation instanceof Param) {
                hasParamAnnotation = true;
                name = ((Param) annotation).value();
                break;
            }
        }
        // 如果没有指定注解
        if (name == null) {
            // 如果开启了useActualParamName配置，则参数名为argn(n>=0)，如果是Java8以上并且开启-parameters，则为实际的参数名
            if (config.isUseActualParamName()) {
                name = getActualParamName(method, paramIndex);
            }
            // 否则为下标
            if (name == null) {
                name = String.valueOf(map.size());
            }
        }
        map.put(paramIndex, name);
    }
    names = Collections.unmodifiableSortedMap(map);
}

而在使用这个names构建xml中参数对象和值的映射时，还进行了进一步的处理。

public Object getNamedParams(Object[] args) {
    final int paramCount = names.size();
    // 无参数，直接返回null
    if (args == null || paramCount == 0) {
        return null;
    } else if (!hasParamAnnotation && paramCount == 1) {
        // 一个参数，并且没有注解，直接返回这个对象
        return args[names.firstKey()];
    } else {
        // 其他情况则返回一个Map对象
        final Map param = new ParamMap