别再问我 MyBatis 了，Mapper 的解析与加载底层原理我都能讲清楚~ - 哈喽比特

596次阅读 | 发布于4年以前

大家都知道，利用 Spring 整合 MyBatis，我们可以直接利用 @MapperScan 注解或者 @Mapper 注解，让 Spring 可以扫描全部的 Mapper 接口，解析然后加载。那么如果抛开 Spring，你们可知道 MyBatis 是如何解析和加载 Mapper 接口的？

如果不知道的话，可以跟着我这篇文章，一步一步地深入和解读源码，带你从底层来看通 MyBatis 解析加载 Mapper 的实现原理。

一、MyBatis 核心组件：

在解读源码之前，我们很有必要先了解 MyBatis 几大核心组件，知道他们都是做什么用的。

核心组件有：Configuration、SqlSession、Executor、StatementHandler、ParameterHandler、ResultSethandler。

下面简单介绍一下他们：

Configuration：用于描述 MyBatis 主配置文件信息，MyBatis 框架在启动时会加载主配置文件，将配置信息转换为 Configuration 对象。
SqlSession：面向用户的 API，是 MyBatis 与数据库交互的接口。
Executor：SQL 执行器，用于和数据库交互。SqlSession 可以理解为 Executor 组件的外观（外观模式），真正执行 SQL 的是 Executor 组件。
MappedStatement：用于描述 SQL 配置信息，MyBatis 框架启动时，XML 文件或者注解配置的 SQL 信息会被转换为 MappedStatement 对象注册到 Configuration 组件中。
StatementHandler：封装了对 JDBC 中 Statement 对象的操作，包括为 Statement 参数占位符设置值，通过 Statement 对象执行 SQL 语句。
TypeHandler：类型处理器，用于 Java 类型与 JDBC 类型之间的转换。
ParameterHandler：用于处理 SQL 中的参数占位符，为参数占位符设置值。
ResultSetHandler：封装了对 ResultSet 对象的处理逻辑，将结果集转换为 Java 实体对象。

二、简述 Mapper 执行流程：

SqlSession组件，它是用户层面的API。用户可利用 SqlSession 获取想要的 Mapper 对象（MapperProxy 代理对象）；当执行 Mapper 的方法，MapperProxy 会创建对应的 MapperMetohd，然后 MapperMethod 底层其实是利用 SqlSession 来执行 SQL。

但是真正执行 SQL 操作的应该是 Executor组件，Executor 可以理解为 SQL 执行器，它会使用 StatementHandler 组件对 JDBC 的 Statement 对象进行操作。当 Statement 类型为 CallableStatement 和 PreparedStatement 时，会通过 ParameterHandler 组件为参数占位符赋值。

ParameterHandler 组件中会根据 Java 类型找到对应的 TypeHandler 对象，TypeHandler 中会通过 Statement 对象提供的 setXXX() 方法（例如setString()方法）为 Statement 对象中的参数占位符设置值。

StatementHandler 组件使用 JDBC 中的 Statement 对象与数据库完成交互后，当 SQL 语句类型为 SELECT 时，MyBatis 通过 ResultSetHandler 组件从 Statement 对象中获取 ResultSet 对象，然后将 ResultSet 对象转换为 Java 对象。

我们可以用一幅图来描述上面各个核心组件之间的关系：

三、简单例子深入讲解底层原理

下面我将带着一个非常简单的 Mapper 使用例子来讲解底层的流程和原理。

例子很简单，首先是获取 MyBatis 的主配置文件的文件输入流，然后创建 SqlSessinoFactory，接着利用 SqlSessionFactory 创建 SqlSessin；然后利用 SqlSession 获取要使用的 Mapper 代理对象，最后执行 Mapper 的方法获取结果。

1、代码例子：

@Test
public  void testMybatis () throws IOException {
    // 获取配置文件输入流
    InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
    // 通过SqlSessionFactoryBuilder的build()方法创建SqlSessionFactory实例
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    // 调用openSession()方法创建SqlSession实例
    SqlSession sqlSession = sqlSessionFactory.openSession();
    // 获取UserMapper代理对象
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    // 执行Mapper方法，获取执行结果
    List<UserEntity> userList = userMapper.listAllUser();
    System.out.println(JSON.toJSONString(userList));
}

第一行代码，非常的明显，就是读取 MyBatis 的主配置文件。正常来说，这个主配置文件应该用来创建 Configuration ，但是这里却是传给 SqlSessionFactoryBuilder 来创建 SqlSessionFactory，然后就利用工厂模式来创建 SqlSession 了；上面我们也提及到， SqlSession 是提供给用户友好的数据库操作接口，那么岂不是说不需要 Configuratin 也可以直接获取 Mapper 然后操作数据库了？

那当然不是了，Configuration 是 MyBatis 的主配置类，它里面会包含 MyBatis 的所有信息（不管是主配置信息，还是所有 Mapper 配置信息），所以肯定是需要创建的。

所以其实在创建 SqlSessionFactory 时就已经初始化 Configuration 了，因为 SqlSession 需要利用 Executor、ParameterHandler 和 ResultSetHandler 等等各大组件互相配合来执行 Mapper，而 Configuration 就是这些组件的工厂类。

我们可以在 SqlSessionFactoryBuilder#build() 方法中看到 Configuration 是如何被初始化的：

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      return build(parser.parse());
    //......
  }

从上面的代码能看到，就是根据主配置文件的文件输入流创建 XMLConfigBuilder 对象，然后利用 XMLConfigBuilder#parse() 方法来创建 Configuration 对象。

当然了，虽然只是简单的调用了 XMLConfigBuilder#parse() 方法，可是里面包含的东西是非常的多的。例如: MyBatis 主配置文件的解析；如何根据标签给每个 Mapper 接口生产 MapperProxy 代理类和将 SQL 配置转换为 MappedStatement；以及、、、等等标签是如何解析的。

当然了，这篇文章我们只会着重于关于 Mapper 配置的解析和加载，根据底层源码一步一步的去分析弄明白，至于其他的知识点就不过多讲解了。

2、XMLConfigBuilder 中关于 Configuration 的解析过程

Ⅰ. XMLConfigBuilder#parseConfiguration()

上面讲到 XMLConfigBuilder 会调用 parse() 方法去解析 MyBatis 的主配置文件，底层主要是利用 XPATH 来解析 XML 文件。代码如下：

public class XMLConfigBuilder extends BaseBuilder {

    // .....

    private final XPathParser parser;

    // .....

    public Configuration parse() {
        // 防止parse（）方法被同一个实例多次调用
        if (parsed) {
          throw new BuilderException("Each XMLConfigBuilder can only be used once.");
        }
        parsed = true;
        // 调用XPathParser.evalNode（）方法，创建表示configuration节点的XNode对象。
        // 调用parseConfiguration（）方法对XNode进行处理
        parseConfiguration(parser.evalNode("/configuration"));
        return configuration;
    }

    private void parseConfiguration(XNode root) {
        try {
            propertiesElement(root.evalNode("properties"));
            Properties settings = settingsAsProperties(root.evalNode("settings"));
            loadCustomVfs(settings);
            typeAliasesElement(root.evalNode("typeAliases"));
            pluginElement(root.evalNode("plugins"));
            objectFactoryElement(root.evalNode("objectFactory"));
            objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
            reflectorFactoryElement(root.evalNode("reflectorFactory"));
            settingsElement(settings);
            environmentsElement(root.evalNode("environments"));
            databaseIdProviderElement(root.evalNode("databaseIdProvider"));
            typeHandlerElement(root.evalNode("typeHandlers"));
            // 最重要的关注点
            mapperElement(root.evalNode("mappers"));
        } catch (Exception e) {
          throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
        }
    }
    // ....
}

在 XMLConfigBuilder#parseConfiguration() 方法里面，会对主配置文件里的所有标签进行解析；当然了，由于我们这篇文章的主题是分析 Mapper 的解析和加载过程，所以接下来将直接关注 parseConfiguration() 方法里面的 mapperElement() 方法，其他部分大家可以直接去阅读 MyBatis 的源码。

备注：MyBatis 里面的所有 xxxBuilder 类都是继承于 BaseBuilder，而 BaseBuilder 要注意的点就是它持有着 Configuration 实例的引用。

Ⅱ . XMLConfigBuilder#mapperElement()

在 XMLConfigBuilder#mapperElement() 方法里面，主要是解析标签里面的标签和标签，这两个标签主要是描述 Mapper 接口的全路径、Mapper 接口所在的包的全路径以及 Mapper 接口对应的 XML 文件的全路径。

代码如下：

  private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        // 通过<package>标签指定包名
        if ("package".equals(child.getName())) {
          String mapperPackage = child.getStringAttribute("name");
          configuration.addMappers(mapperPackage);
        } else {
          String resource = child.getStringAttribute("resource");
          String url = child.getStringAttribute("url");
          String mapperClass = child.getStringAttribute("class");
          // 通过resource属性指定XML文件路径
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            InputStream inputStream = Resources.getResourceAsStream(resource);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url != null && mapperClass == null) {
            // 通过url属性指定XML文件路径
            ErrorContext.instance().resource(url);
            InputStream inputStream = Resources.getUrlAsStream(url);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url == null && mapperClass != null) {
            // 通过class属性指定接口的完全限定名
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

从上面的代码来看，主要是将标签分为和来解析，而再细一点可以分为两种解析情况：一种是指定了Mapper接口的 XML 文件，而另外一种是指定了 Mapper 接口。

那么我们可以先看看指定 XML 文件是如何解析与加载 Mapper 的。

3、XMLMapperBuilder 中关于 Mapper 的解析过程

Mapper 接口的 XML 文件的解析当然也是利用 XPath，但此时不再是 XMLConfigBuilder 来负责了，而是需要创建一个 XMLMapperBuilder 对象，而 XMLMapperBuilder 需要传入 XML 文件的文件输入流。

Ⅰ . XMLMapperBuilder#parse()

我们可以看看 XMLMapperBuilder#parse() 方法，XML 文件的解析流程就是在这里面：

public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
      // 调用XPathParser的evalNode（）方法获取根节点对应的XNode对象
      configurationElement(parser.evalNode("/mapper"));
      // 將资源路径添加到Configuration对象中
      configuration.addLoadedResource(resource);
      bindMapperForNamespace();
    }
    // 继续解析之前解析出现异常的ResultMap对象
    parsePendingResultMaps();
    // 继续解析之前解析出现异常的CacheRef对象
    parsePendingCacheRefs();
    // 继续解析之前解析出现异常<select|update|delete|insert>标签配置
    parsePendingStatements();
}

解析前，会先判断 Configuratin 是否已经加载这个 XML 资源，如果不存在，则调用 configurationElement() 方法；在方法里面会解析所有的、、、、和 <select|insert|update|delete> 标签。

Ⅱ . XMLMapperBuilder#configuratinElement()

下面我们先看一下 XMLMapperBuilder#configuratinElement() 方法的代码：

private void configurationElement(XNode context) {
    try {
      // 获取命名空间
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.equals("")) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }
      // 设置当前正在解析的Mapper配置的命名空间
      builderAssistant.setCurrentNamespace(namespace);
      // 解析<cache-ref>标签
      cacheRefElement(context.evalNode("cache-ref"));
      // 解析<cache>标签
      cacheElement(context.evalNode("cache"));
      // 解析所有的<parameterMap>标签
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));
      // 解析所有的<resultMap>标签
      resultMapElements(context.evalNodes("/mapper/resultMap"));
      // 解析所有的<sql>标签
      sqlElement(context.evalNodes("/mapper/sql"));
      // 解析所有的<select|insert|update|delete>标签
      buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
    }
}

当然了，我们此时将所有注意力集中在 buildStatementFromContext 方法即可。

Ⅲ . XMLMapperBuilder#buildStatementFromContext()

在这个方法里面，会调用重载的 buildStatementFromContext 方法；但是这里还不是真正解析的地方，而是遍历所有标签，然后创建一个 XMLStatementBuilder 对象，对标签进行解析。代码如下：

  private void buildStatementFromContext(List<XNode> list, String requiredDatabaseId) {
    for (XNode context : list) {
      // 通过XMLStatementBuilder对象，对<select|update|insert|delete>标签进行解析
      final XMLStatementBuilder statementParser = new XMLStatementBuilder(configuration, builderAssistant, context, requiredDatabaseId);
      try {
        // 调用parseStatementNode（）方法解析
        statementParser.parseStatementNode();
      } catch (IncompleteElementException e) {
        configuration.addIncompleteStatement(statementParser);
      }
    }
  }

4、XMLStatementBuilder 中关于 <select|insert|update|delete> 的解析过程

Ⅰ. XMLStatementBuilder#parseStatementNode()

那么我们接着看看 XMLStatementBuilder#parseStatementNode 方法：

  public void parseStatementNode() {
    String id = context.getStringAttribute("id");
    String databaseId = context.getStringAttribute("databaseId");

    if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
      return;
    }
    // 解析<select|update|delete|insert>标签属性
    Integer fetchSize = context.getIntAttribute("fetchSize");
    Integer timeout = context.getIntAttribute("timeout");
    String parameterMap = context.getStringAttribute("parameterMap");
    String parameterType = context.getStringAttribute("parameterType");
    Class<?> parameterTypeClass = resolveClass(parameterType);
    String resultMap = context.getStringAttribute("resultMap");
    String resultType = context.getStringAttribute("resultType");
    // 获取LanguageDriver对象
    String lang = context.getStringAttribute("lang");
    LanguageDriver langDriver = getLanguageDriver(lang);
    // 获取Mapper返回结果类型Class对象
    Class<?> resultTypeClass = resolveClass(resultType);
    String resultSetType = context.getStringAttribute("resultSetType");
    // 默认Statement类型为PREPARED
    StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType",
            StatementType.PREPARED.toString()));
    ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);

    String nodeName = context.getNode().getNodeName();
    SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));
    boolean isSelect = sqlCommandType == SqlCommandType.SELECT;
    boolean flushCache = context.getBooleanAttribute("flushCache", !isSelect);
    boolean useCache = context.getBooleanAttribute("useCache", isSelect);
    boolean resultOrdered = context.getBooleanAttribute("resultOrdered", false);

    // 將<include>标签内容，替换为<sql>标签定义的SQL片段
    XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
    includeParser.applyIncludes(context.getNode());

    // 解析<selectKey>标签
    processSelectKeyNodes(id, parameterTypeClass, langDriver);

    // 通过LanguageDriver解析SQL内容，生成SqlSource对象
    SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
    String resultSets = context.getStringAttribute("resultSets");
    String keyProperty = context.getStringAttribute("keyProperty");
    String keyColumn = context.getStringAttribute("keyColumn");
    KeyGenerator keyGenerator;
    String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;
    keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);
    // 获取主键生成策略
    if (configuration.hasKeyGenerator(keyStatementId)) {
      keyGenerator = configuration.getKeyGenerator(keyStatementId);
    } else {
      keyGenerator = context.getBooleanAttribute("useGeneratedKeys",
          configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))
          ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
    }

    builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
        fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
        resultSetTypeEnum, flushCache, useCache, resultOrdered,
        keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);
  }

从上面的代码可得，首先会解析标签里的所有属性；然后创建 LanguageDriver 来解析标签里面的 SQL 配置，并生成对应的 SqlSource 对象；最后，利用工具类 MapperBuilderAssistant 来将上面解析的内容组装成 MappedStatement 对象，并且注册到 Configuration 中。

5、详细介绍 SqlSource 与 LanguageDriver 接口

上面我们说到，解析的 SQL 内容会生成对应的 SqlSource 对象，那么我们先看看 SqlSource 接口，代码如下：

public interface SqlSource {

  BoundSql getBoundSql(Object parameterObject);

}

SqlSource 接口的定义非常简单，只有一个 getBoundSql() 方法，该方法返回一个 BoundSql 实例。

所以说 BoundSql 才是对 SQL 语句及参数信息的封装，它是 SqlSource 解析后的结果，BoundSql 的代码如下：

public class BoundSql {

  // Mapper配置解析后的sql语句
  private final String sql;
  // Mapper参数映射信息
  private final List<ParameterMapping> parameterMappings;
  // Mapper参数对象
  private final Object parameterObject;
  // 额外参数信息，包括<bind>标签绑定的参数，内置参数
  private final Map<String, Object> additionalParameters;
  // 参数对象对应的MetaObject对象
  private final MetaObject metaParameters;
  // ... 省略 get/set 和 构造函数
}

因为 SQL 的解析是利用 LanguageDriver 组件完成的，所以我们再接着看看 LanguageDriver 接口，代码如下：

public interface LanguageDriver {

  ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);

  SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType);

  SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType);

}

如上面的代码所示，LanguageDriver 接口中一共有3个方法，其中 createParameterHandler() 方法用于创建 ParameterHandler 对象，另外还有两个重载的 createSqlSource() 方法，这两个重载的方法用于创建 SqlSource 对象。

MyBatis 中为 LanguageDriver 接口提供了两个实现类，分别为 XMLLanguageDriver 和 RawLanguageDriver。

XMLLanguageDriver 为 XML 语言驱动，实现了动态 SQL 的功能，也就是说可以利用 MyBatis 提供的 XML 标签（常用的、等标签）结合OGNL表达式语法来实现动态的条件判断。
RawLanguageDriver 表示仅支持静态 SQL 配置，不支持动态 SQL 功能。

接下来我们重点了解一下 XMLLanguageDriver 实现类的内容，代码如下：

public class XMLLanguageDriver implements LanguageDriver {

  @Override
  public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
  }
  @Override
  public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
    // 该方法用于解析XML文件中配置的SQL信息
    // 创建XMLScriptBuilder对象
    XMLScriptBuilder builder = new XMLScriptBuilder(configuration, script, parameterType);
    // 调用 XMLScriptBuilder对象parseScriptNode（）方法解析SQL资源
    return builder.parseScriptNode();
  }

  @Override
  public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
    // 该方法用于解析Java注解中配置的SQL信息
    // 字符串以<script>标签开头，则以XML方式解析
    if (script.startsWith("<script>")) {
      XPathParser parser = new XPathParser(script, false, configuration.getVariables(), new XMLMapperEntityResolver());
      return createSqlSource(configuration, parser.evalNode("/script"), parameterType);
    } else {
      // 解析SQL配置中的全局变量
      script = PropertyParser.parse(script, configuration.getVariables());
      TextSqlNode textSqlNode = new TextSqlNode(script);
      // 如果SQL中是否仍包含${}参数占位符，则返回DynamicSqlSource实例，否则返回RawSqlSource
      if (textSqlNode.isDynamic()) {
        return new DynamicSqlSource(configuration, textSqlNode);
      } else {
        return new RawSqlSource(configuration, script, parameterType);
      }
    }
  }

}

如上面的代码所示，XMLLanguageDriver 类实现了 LanguageDriver 接口中两个重载的 createSqlSource() 方法，分别用于处理 XML 文件和 Java 注解中配置的 SQL 信息，将 SQL 配置转换为 SqlSource 对象。

第一个重载的 createSqlSource() 方法用于处理 XML 文件中配置的 SQL 信息，该方法中创建了一个 XMLScriptBuilder 对象，然后调用 XMLScriptBuilder 对象的 parseScriptNode() 方法将 SQL 资源转换为 SqlSource 对象。

第二个重载的 createSqlSource() 方法用于处理 Java 注解中配置的 SQL 信息，该方法中首先判断 SQL 配置是否以