mybatis中config.xml文件的解析

最新推荐文章于 2023-03-11 20:37:12 发布
最新推荐文章于 2023-03-11 20:37:12 发布
阅读量378 收藏 1
点赞数
分类专栏： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiexingshishu/article/details/108589957
版权

config.xml文件的解析是主要是XMLConfigBuilder完成的，通过调用parseConfiguration来实现整个解析过程

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

private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
      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);
      // read it after objectFactory and objectWrapperFactory issue #631
      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);
    }
  }
1.解析properties结点

首先获取子结点配置的属性值name,value,然后将resource或者url指定的配置文件解析，将属性作合并，同时更新configuration中的变量

private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
      Properties defaults = context.getChildrenAsProperties();
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      Properties vars = configuration.getVariables();
      if (vars != null) {
        defaults.putAll(vars);
      }
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }
2、解析settings结点，得到全局配置

解析全局配置时，通过反射看Configuration中是否有对应的配置项，如果没有，抛出异常。并且设置自定义的vfs

private Properties settingsAsProperties(XNode context) {
    if (context == null) {
      return new Properties();
    }
    Properties props = context.getChildrenAsProperties();
    // Check that all settings are known to the configuration class
    MetaClass metaConfig = MetaClass.forClass(Configuration.class, localReflectorFactory);
    for (Object key : props.keySet()) {
      if (!metaConfig.hasSetter(String.valueOf(key))) {
        throw new BuilderException("The setting " + key + " is not known.  Make sure you spelled it correctly (case sensitive).");
      }
    }
    return props;
  }

private void loadCustomVfs(Properties props) throws ClassNotFoundException {
    String value = props.getProperty("vfsImpl");
    if (value != null) {
      String[] clazzes = value.split(",");
      for (String clazz : clazzes) {
        if (!clazz.isEmpty()) {
          @SuppressWarnings("unchecked")
          Class<? extends VFS> vfsImpl = (Class<? extends VFS>)Resources.classForName(clazz);
          configuration.setVfsImpl(vfsImpl);
        }
      }
    }
  }
3.解析typeAliases类型别名

有两种设置形式，一种是指定包名，另外一种是指定alias,type

private void typeAliasesElement(XNode parent) {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        if ("package".equals(child.getName())) {
          String typeAliasPackage = child.getStringAttribute("name");
          configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
        } else {
          String alias = child.getStringAttribute("alias");
          String type = child.getStringAttribute("type");
          try {
            Class<?> clazz = Resources.classForName(type);
            if (alias == null) {
              typeAliasRegistry.registerAlias(clazz);
            } else {
              typeAliasRegistry.registerAlias(alias, clazz);
            }
          } catch (ClassNotFoundException e) {
            throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
          }
        }
      }
    }
  }

4、解析plugins插件

解析配置的插件，读取插件子结点的插件类型、配置属性，加入到configuration配置中

private void pluginElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        String interceptor = child.getStringAttribute("interceptor");
        Properties properties = child.getChildrenAsProperties();
        Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
        interceptorInstance.setProperties(properties);
        configuration.addInterceptor(interceptorInstance);
      }
    }
  }
5、解析objectFactory结点

解析配置的objectFactory类型及配置属性，添加到configuration配置中

private void objectFactoryElement(XNode context) throws Exception {
    if (context != null) {
      String type = context.getStringAttribute("type");
      Properties properties = context.getChildrenAsProperties();
      ObjectFactory factory = (ObjectFactory) resolveClass(type).newInstance();
      factory.setProperties(properties);
      configuration.setObjectFactory(factory);
    }
  }
6、解析objectWrapperFactory结点

主要是配置自定义的对象封装工厂类。

private void objectWrapperFactoryElement(XNode context) throws Exception {
    if (context != null) {
      String type = context.getStringAttribute("type");
      ObjectWrapperFactory factory = (ObjectWrapperFactory) resolveClass(type).newInstance();
      configuration.setObjectWrapperFactory(factory);
    }
  }
7、解析reflectorFactory结点

解析自定义的反射工厂类并添加到configuration配置中

private void reflectorFactoryElement(XNode context) throws Exception {
    if (context != null) {
       String type = context.getStringAttribute("type");
       ReflectorFactory factory = (ReflectorFactory) resolveClass(type).newInstance();
       configuration.setReflectorFactory(factory);
    }
  }
8.设置全局配置

将解析的全局配置设置到configuration中

private void settingsElement(Properties props) throws Exception {
    configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
    configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
    configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
    configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
    configuration.setLazyLoadingEnabled(booleanValueOf(props.getProperty("lazyLoadingEnabled"), false));
    configuration.setAggressiveLazyLoading(booleanValueOf(props.getProperty("aggressiveLazyLoading"), false));
    configuration.setMultipleResultSetsEnabled(booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true));
    configuration.setUseColumnLabel(booleanValueOf(props.getProperty("useColumnLabel"), true));
    configuration.setUseGeneratedKeys(booleanValueOf(props.getProperty("useGeneratedKeys"), false));
    configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));
    configuration.setDefaultStatementTimeout(integerValueOf(props.getProperty("defaultStatementTimeout"), null));
    configuration.setDefaultFetchSize(integerValueOf(props.getProperty("defaultFetchSize"), null));
    configuration.setMapUnderscoreToCamelCase(booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false));
    configuration.setSafeRowBoundsEnabled(booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false));
    configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));
    configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER")));
    configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));
    configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));
    configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));
    @SuppressWarnings("unchecked")
    Class<? extends TypeHandler> typeHandler = (Class<? extends TypeHandler>)resolveClass(props.getProperty("defaultEnumTypeHandler"));
    configuration.setDefaultEnumTypeHandler(typeHandler);
    configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));
    configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));
    configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));
    configuration.setLogPrefix(props.getProperty("logPrefix"));
    @SuppressWarnings("unchecked")
    Class<? extends Log> logImpl = (Class<? extends Log>)resolveClass(props.getProperty("logImpl"));
    configuration.setLogImpl(logImpl);
    configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory")));
  }

9、解析environments结点

根据配置的environment结点及当前所属的环境作解析，解析事务工厂及数据源工厂

private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      if (environment == null) {
        environment = context.getStringAttribute("default");
      }
      for (XNode child : context.getChildren()) {
        String id = child.getStringAttribute("id");
        if (isSpecifiedEnvironment(id)) {
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          DataSource dataSource = dsFactory.getDataSource();
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
  }

10.解析databaseIdProvider结点

根据当前配置的支持数据库及当前数据源所属方言得到当前所选择的数据库厂商

private void databaseIdProviderElement(XNode context) throws Exception {
    DatabaseIdProvider databaseIdProvider = null;
    if (context != null) {
      String type = context.getStringAttribute("type");
      // awful patch to keep backward compatibility
      if ("VENDOR".equals(type)) {
          type = "DB_VENDOR";
      }
      Properties properties = context.getChildrenAsProperties();
      databaseIdProvider = (DatabaseIdProvider) resolveClass(type).newInstance();
      databaseIdProvider.setProperties(properties);
    }
    Environment environment = configuration.getEnvironment();
    if (environment != null && databaseIdProvider != null) {
      String databaseId = databaseIdProvider.getDatabaseId(environment.getDataSource());
      configuration.setDatabaseId(databaseId);
    }
  }
11、解析typeHandlers结点

支持两种配置，一种是指定包，一种是指定javaType,jdbcType,handler

private void typeHandlerElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        if ("package".equals(child.getName())) {
          String typeHandlerPackage = child.getStringAttribute("name");
          typeHandlerRegistry.register(typeHandlerPackage);
        } else {
          String javaTypeName = child.getStringAttribute("javaType");
          String jdbcTypeName = child.getStringAttribute("jdbcType");
          String handlerTypeName = child.getStringAttribute("handler");
          Class<?> javaTypeClass = resolveClass(javaTypeName);
          JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
          Class<?> typeHandlerClass = resolveClass(handlerTypeName);
          if (javaTypeClass != null) {
            if (jdbcType == null) {
              typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
            } else {
              typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
            }
          } else {
            typeHandlerRegistry.register(typeHandlerClass);
          }
        }
      }
    }
  }

12.解析mappers结点

支持四种形式，一种指定package,一种是指定resource,一种是指定url，一种是指定class。指定resource,url时是通过XMLMapperBuilder来解析。指定package是通过configuration.addMappers来完成的,指定class是通过configuration.addMapper

private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        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");
          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) {
            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<?> 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.");
          }
        }
      }
    }
  }
 

 

kgduu
关注
专栏目录
Mybatis中的config.xml配置文件详细解析
08-28
Mybatis-config.xml配置文件详细解析 Mybatis-config.xml文件是Mybatis框架中最重要的配置文件之一，它负责配置Mybatis的整体环境和行为。这个文件的正确配置对Mybatis的使用起着至关重要的作用。下面我们将详细...
Mybatis 之 mybatis-config.xml 子节点的详解篇
weixin_44245828的博客
12-26 380
双篇同线进行 mybatis-config.xml 文件的解析。 还没开写，先占位置。
Mybatis 调试输出SQL语句，到底是如何实现的呢？
Java知音
05-27 1226
点击关注公众号，实用技术文章及时了解Java 开发中常用的几款日志框架有很多种，并且这些日志框架来源于不同的开源组织，给用户暴露的接口也有很多不同之处，所以很多开源框架会自己定义一套统一的日志接口，兼容上述第三方日志框架，供上层使用。一般实现的方式是使用适配器模式，将各个第三方日志框架接口转换为框架内部自定义的日志接口。MyBatis 也提供了类似的实现，这里我们就来简单...
Mybatis日志适配学习
zhuping2002的专栏
05-10 313
一. 指定Mybatis日志框架 1.在mybatis-config.xml中配置如下 <configuration> <settings> ... <setting name="logImpl" value="LOG4J"/> ... </settings> </configuration> 2.mybatis启动时会解析xml,通过XMLConfigBuilder中parseConfiguration->
mybatis spring注解配置类
qq_40285312的博客
08-31 318
package com.bj58.zpsender.config; import com.alibaba.druid.pool.DruidDataSource; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.core.MybatisConfiguration; import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInte
Springboot - 多数据源 mybatis 配置log
A_bad_horse的专栏
03-11 202
Springboot - 多数据源 mybatis 配置log
mybatis-3-config.dtd mybatis-3-mapper.dtd
04-08
在实际应用中，`mybatis-3-config.dtd` 和 `mybatis-3-mapper.dtd` 通过引入机制被引用到XML配置文件中，确保解析器能够理解并验证配置文件的语法。例如： ```xml <!DOCTYPE configuration PUBLIC "-//mybatis.org...
mybatis-config.rar
10-10
9. **mybatis-config**：这个文件可能是MyBatis的配置文件，包含了MyBatis的全局配置，如数据源、事务管理、插件设置等，也可能包含代码生成器的相关配置，如数据库连接信息、生成的代码模板等。 总的来说，...
【免费】mybatis3.2.3所需的jar包+mybatis3.2.3中文帮助文档+mybatis-config.dtd
09-23
其次，`mybatis-config.dtd`文件是MyBatis配置文件的DTD（Document Type Definition），定义了`mybatis-config.xml`文件的结构和元素。在MyBatis的配置文件中，你可以设置数据库连接信息、事务管理器、环境配置等，...
项目配置文件( spring-mvc.xml spring-mybatis.xml web.xml log4j.properties)
02-07
7. **mybatis-config.xml**: MyBatis的全局配置文件，定义了MyBatis的配置，包括类型别名、映射器文件的位置、数据库环境等。通过这个文件，MyBatis知道如何查找和处理SQL语句。 这些配置文件的组合使用，使得开发...
用java程序生成mybatis的mapper.xml和mapper.java文件
08-19
3. **配置Mybatis**：在项目的Mybatis配置文件（mybatis-config.xml）中，需要引入刚刚生成的mapper.xml文件，使得Mybatis能够找到并解析它们。 4. **编写mapper接口**：虽然逆向工具会生成基础的mapper接口和实现...
mybatis3.x源码深度解析与最佳实践.pdf
09-12
XMLConfigBuilder.parseConfiguration 方法是 MyBatis 中的核心方法之一，该方法负责解析 MyBatis 的配置文件，包括属性解析、加载 settings 节点、加载自定义 VFS、解析类型别名、加载插件、加载对象工厂、创建对象...
mybatis-generator.jar以及generatorConfig.xml
03-25
这个JAR文件通常需要在构建脚本或者IDE的构建过程中引入，以便在运行时解析数据库表并创建相应的Java代码。 `generatorConfig.xml`是MBG的配置文件，它定义了MBG的行为和生成代码的规则。这个XML文件包含了数据库...
mybatis中文文档.rar
11-05
1. **环境配置**：MyBatis的环境配置文件（mybatis-config.xml）是整个框架的中心，它定义了数据源、事务管理器等核心组件，同时也允许用户自定义插件和类型处理器。 2. **SqlSessionFactory**：它是MyBatis的入口...
mybatis-3-mybatis-3.5.13.zip
08-18
MyBatis作为一个流行的持久化框架，其源码是开放的，允许开发者深入了解框架...MyBatis使用XML解析器解析映射文件，将SQL语句和数据库操作转化为Java对象。 4. SQL执行： 当执行SQL操作时，MyBatis会将映射文件。。。
Mybatis配置文件（mybatis-config.xml ）源码分析
吖脖（博）
09-12 786
Mybatis配置文件mybatis-config.xmlsettings，Mybatis配置文件解析源码分析
MyBatis源码解析（二）：配置文件解析
xugc2015的博客
06-19 102
上一文中提到的两种方式，其实都是最终得到了Configuration对象，正好可以对应上官方文档上的Configuration XML小节。 这也大概就是Configuration的结构，我们先接着上一篇的代码往下看， public Configuration parse() { if (parsed) { throw new BuilderException("E...
源码：Mybatis的LogFactory生成逻辑
ToryXu的博客
02-01 563
源码：Mybatis的LogFactory生成逻辑 发现某一数据源的sql日志一直没有打印，一看configuration配置，作了 configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class); 注释掉 ，就成功打印。 接下来分析源码： public final class LogFactory { /** * Marker to be used by logging impleme.
MyBatis源码阅读之日志logging
weixin_34277853的博客
03-02 443
MyBatis源码阅读之日志logging 本文介绍个人对 logging 包下源码的理解。 logging 配置加载 我们先从日志的配置加载开始阅读， MyBatis 的各项配置的加载过程都可以从 XMLConfigBuilder 类中找到，我们定位到该类下的日志加载方法 loadCustomLogImpl： private void ...
Resources.getResourceAsStream("mybatis-config.xml");
最新发布
08-27
`Resources.getResourceAsStream("mybatis-config.xml")` 是Java Resource API的一种用法，用于从类路径中加载名为 "mybatis-config.xml" 的资源作为输入流。这个语句通常在MyBatis初始化时被用来读取mybatis的配置文件。 在MyBatis构建过程中[^1]，`XMLConfigBuilder` 类会尝试通过 `InputStream` 来解析XML配置文件，比如 `mybatis-config.xml`。当调用 `Resources.getResourceAsStream()` 时，它会在指定的类路径下查找该文件，如MyBatis核心jar包的lib目录[^2]。 具体操作如下： 1. 获取当前应用的类路径资源（通常是项目的resources目录） 2. 使用 `Resources.getResourceAsStream()` 函数，传入配置文件名 "mybatis-config.xml" 3. 如果文件存在并成功打开，返回一个指向该文件的InputStream；如果文件不存在或无法访问，则抛出异常 示例代码片段可能看起来像这样： ```java InputStream configStream = Resources.getResourceAsStream("mybatis-config.xml"); XMLConfigBuilder parser = new XMLConfigBuilder(configStream, ...); SqlSessionFactory factory = build(parser.parse()); // ... ``` 请注意，这仅表示文件定位和打开的过程，实际的解析和工厂构建还需要其他参数和处理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

kgduu

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值