1 解析入口

在解析 mybatis-config.xml 時， 會進行解析 xxxMapper.xml 的文件。

在圖示流程的 XMLConfigBuilder.parse() 函數中, 該函數內部， 在解析 mappers 節點時， 會調用 mapperElement(root.evalNode("mappers"))。

private void mapperElement(XNode parent) throws Exception { if (parent != null) { // 遍歷其子節點 for (XNode child : parent.getChildren()) { // 如果配置的是包(packege) if ("package".equals(child.getName())) { String mapperPackage = child.getStringAttribute("name"); configuration.addMappers(mapperPackage); } else { // 如果配置的是類（有三種情況 resource / class / url） String resource = child.getStringAttribute("resource"); String url = child.getStringAttribute("url"); String mapperClass = child.getStringAttribute("class"); // 配置一：使用 resource 類路徑 if (resource != null && url == null && mapperClass == null) { ErrorContext.instance().resource(resource); InputStream inputStream = Resources.getResourceAsStream(resource); // 創建 XMLMapperBuilder 對象 XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments()); // 解析 xxxMapper.xml mapperParser.parse(); // 配置二： 使用 url 絕對路徑 } else if (resource == null && url != null && mapperClass == null) { ErrorContext.instance().resource(url); InputStream inputStream = Resources.getUrlAsStream(url); // 創建 XMLMapperBuilder 對象 XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments()); // 解析 xxxMapper.xml mapperParser.parse(); // 配置三： 使用 class 類名 } else if (resource == null && url == null && mapperClass != null) { // 通過反射創建對象 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."); } } } }}

從以上源碼中可以發現， 配置時， 一種是通過包的方式， 一種是通過指定文件的方式。

但不管是怎麼配置， 最後的找落點都是 xxxMapper.xml 文件的解析。

2 解析

包掃描時， 會加載指定包下的文件， 最終會調用

private void loadXmlResource() { // 判斷是否已經加載過 if (!configuration.isResourceLoaded("namespace:" + type.getName())) { String xmlResource = type.getName().replace('.', '/') + ".xml"; InputStream inputStream = null; try { inputStream = Resources.getResourceAsStream(type.getClassLoader(), xmlResource); } catch (IOException e) { // ignore, resource is not required } if (inputStream != null) { XMLMapperBuilder xmlParser = new XMLMapperBuilder(inputStream, assistant.getConfiguration(), xmlResource, configuration.getSqlFragments(), type.getName()); // 解析 xmlParser.parse(); } }}

因此， 不管是包掃描還是文件掃描， 最終都經歷一下 xmlParser.parse() 解析過程。

2.1 解析流程

解析 xxxMapper.xml 文件的是下面這個函數，解析 mapper 節點。

public void parse() { // 判斷是否已經加載過 if (!configuration.isResourceLoaded(resource)) { // 解析 節點 configurationElement(parser.evalNode("/mapper")); // 標記一下，已經加載過了 configuration.addLoadedResource(resource); // 綁定映射器到namespace bindMapperForNamespace(); } // 處理 configurationElement 中解析失敗的 parsePendingResultMaps(); // 處理configurationElement 中解析失敗的 parsePendingCacheRefs(); // 處理 configurationElement 中解析失敗的 SQL 語句 parsePendingStatements(); }

大致流程：

解析調用 configurationElement() 函數來解析各個節點標記傳入的文件已經解析了綁定文件到相應的 namespace， 所以 namespace 需要是唯一的處理解析失敗的節點

2.2 解析各個節點

private void configurationElement(XNode context) { try { // 獲取namespace屬性， 其代表者這個文檔的標識 String namespace = context.getStringAttribute("namespace"); if (namespace == null || namespace.equals("")) { throw new BuilderException("Mapper's namespace cannot be empty"); } builderAssistant.setCurrentNamespace(namespace); // 解析 節點 cacheRefElement(context.evalNode("cache-ref")); // 解析 節點 cacheElement(context.evalNode("cache")); // 解析 節點 parameterMapElement(context.evalNodes("/mapper/parameterMap")); // 解析 節點 resultMapElements(context.evalNodes("/mapper/resultMap")); // 解析 節點 sqlElement(context.evalNodes("/mapper/sql")); // 解析 select|insert|update|delet 節點 buildStatementFromContext(context.evalNodes("select|insert|update|delete")); } catch (Exception e) { throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e); } }

爲了避免篇幅太長， 在此就不深入講解各個解析過程， 後續會開專門的章節。