MyBatis的四种资源加载方式以及优先级

什么是MyBatis资源加载？

MyBatis资源加载指的就是如何加载我们定义好的映射文件(可能使用的是XML方式，也可能是注解方式)，只有这样，MyBatis才能解析我们写的SQL以及将XML中的SQL和接口中的方法关联起来等等。

其实所有的资源加载都差不多，Spring也有这样的资源加载机制，例如支持URL方式的资源加载、支持classpath方式的资源加载、支持文件方式的资源加载等等。

MyBatis的资源加载方式有几种？

我们可以首先查看MyBatis官方文档。在官方文档中给出了四种资源加载的方式：
分别是类路径下的资源加载、URL资源加载、全限定名资源加载、包路径资源加载。但是在官方文档中并没有给出这四种方式的优先级，这一点，我们可以从源码中得到答案。

通常我们都会编写一个mybatis-config.xml文件来配置MyBatis，而解析这个XML则是由XMLConfigBuilder来完成，在其parse方法中完成了XML解析。

public Configuration parse() {if (parsed) {throw new BuilderException("Each XMLConfigBuilder can only be used once.");}parsed = true;// 获取<configuration>根元素parseConfiguration(parser.evalNode("/configuration"));return configuration;
}

private void parseConfiguration(XNode root) {try {// 解析<properties>标签propertiesElement(root.evalNode("properties"));// 解析<settings>标签Properties settings = settingsAsProperties(root.evalNode("settings"));loadCustomVfs(settings);loadCustomLogImpl(settings);// 解析<typeAliases>标签typeAliasesElement(root.evalNode("typeAliases"));// 解析<plugins>标签pluginElement(root.evalNode("plugins"));// 解析<objectFactory>标签objectFactoryElement(root.evalNode("objectFactory"));// 解析<objectWrapperFactory>标签objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));// 解析<reflectorFactory>标签reflectorFactoryElement(root.evalNode("reflectorFactory"));settingsElement(settings);// 解析<environments>标签environmentsElement(root.evalNode("environments"));// 解析<databaseIdProvider>标签databaseIdProviderElement(root.evalNode("databaseIdProvider"));// 解析<typeHandlers>标签typeHandlerElement(root.evalNode("typeHandlers"));// 本次分析重点！！！ 解析<mappers>标签mapperElement(root.evalNode("mappers"));} catch (Exception e) {throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);}
}

通过以上分析，我们也可以得知为什么在mybatis-config.xml文件中那些标签的顺序是那样的，因为在源码中已经规定了解析的顺序。

在mapperElement方法中，我们就可以找到四种资源加载方式的优先级问题答案。

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>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();// 否则，解析的资源加载方式是<url >} else if (resource == null && url != null && mapperClass == null) {ErrorContext.instance().resource(url);InputStream inputStream = Resources.getUrlAsStream(url);XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());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.");}}}}
}

这四种资源加载方式的优先级为：package->resource->url->class。

如果同时指定了这四种方式，只有package方式生效。如果同时指定了resource、url、class，那么这三种都不会生效，而是抛出异常。因为在解析resource、url、class这三种方式中任何一种方式时，都要求另外两种必须为null，如果不为null，则不会解析。