Spring mybatis源码篇章-MybatisDAO文件解析

最新推荐文章于 2024-05-03 12:05:30 发布
最新推荐文章于 2024-05-03 12:05:30 发布
阅读量1k 收藏
点赞数
分类专栏： Mybatis-学习

http://www.cnblogs.com/question-sky/p/6612604.html


默认加载mybatis主文件方式

XMLConfigBuilder xmlConfigBuilder = null;
    if (this.configLocation != null) {
      xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
      configuration = xmlConfigBuilder.getConfiguration();
    } else {
      if (this.logger.isDebugEnabled()) {
        this.logger.debug("Property 'configLocation' not specified, using default MyBatis Configuration");
      }
      //sqlSessionFactoryBean不指定configLocation属性则采用默认的Configuration对象
      configuration = new Configuration();
      configuration.setVariables(this.configurationProperties);
    }

简单的看下Configuration的无参数构造函数

public Configuration() {
    //预存常用的别名
    typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
    typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);

    typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);
    typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);
    typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);

    typeAliasRegistry.registerAlias("PERPETUAL", PerpetualCache.class);
    typeAliasRegistry.registerAlias("FIFO", FifoCache.class);
    typeAliasRegistry.registerAlias("LRU", LruCache.class);
    typeAliasRegistry.registerAlias("SOFT", SoftCache.class);
    typeAliasRegistry.registerAlias("WEAK", WeakCache.class);

    typeAliasRegistry.registerAlias("DB_VENDOR", VendorDatabaseIdProvider.class);

    typeAliasRegistry.registerAlias("XML", XMLLanguageDriver.class);
    typeAliasRegistry.registerAlias("RAW", RawLanguageDriver.class);

    typeAliasRegistry.registerAlias("SLF4J", Slf4jImpl.class);
    typeAliasRegistry.registerAlias("COMMONS_LOGGING", JakartaCommonsLoggingImpl.class);
    typeAliasRegistry.registerAlias("LOG4J", Log4jImpl.class);
    typeAliasRegistry.registerAlias("LOG4J2", Log4j2Impl.class);
    typeAliasRegistry.registerAlias("JDK_LOGGING", Jdk14LoggingImpl.class);
    typeAliasRegistry.registerAlias("STDOUT_LOGGING", StdOutImpl.class);
    typeAliasRegistry.registerAlias("NO_LOGGING", NoLoggingImpl.class);

    typeAliasRegistry.registerAlias("CGLIB", CglibProxyFactory.class);
    typeAliasRegistry.registerAlias("JAVASSIST", JavassistProxyFactory.class);

    languageRegistry.setDefaultDriverClass(XMLLanguageDriver.class);
    languageRegistry.register(RawLanguageDriver.class);
  }

简单的发现其并不去设置前一章节的mybatis主文件中的相关属性，比如settings、environment等

mapper sql 配置文件的加载

前提是sqlSessionFactoryBean设置了mapperLocations属性，比如<property name="mapperLocations" value="classpath:com/du/wxServer/mapper/*.xml" />

  1. 查看sqlSessionFactoryBean#buildSqlSessionFactory()方法

    if (!isEmpty(this.mapperLocations)) {
  //具体的如何从string转为Resource[]，暂且不知何处加载获得，有兴趣的读者可补充
  for (Resource mapperLocation : this.mapperLocations) {
    if (mapperLocation == null) {
      continue;
    }

    try {
     //对扫描包及其子包下的每个sql mapper配置文件进行解析
      XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
          configuration, mapperLocation.toString(), configuration.getSqlFragments());
      xmlMapperBuilder.parse();
    } catch (Exception e) {
      throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
    } finally {
      ErrorContext.instance().reset();
    }

    if (this.logger.isDebugEnabled()) {
      this.logger.debug("Parsed mapper file: '" + mapperLocation + "'");
    }
  }
} else {
  if (this.logger.isDebugEnabled()) {
    this.logger.debug("Property 'mapperLocations' was not specified or no matching resources found");
  }
}

  2. 直接进入XMLMapperBuilder#parse方法

    public void parse() {
//对每个xml资源只加载一次
if (!configuration.isResourceLoaded(resource)) {
  //解析xml配置，其中配置的根节点必须为mapper
  configurationElement(parser.evalNode("/mapper"));
  configuration.addLoadedResource(resource);
  //绑定mapper的工作区间
  bindMapperForNamespace();
}

parsePendingResultMaps();
parsePendingChacheRefs();
parsePendingStatements();
  }

  3. 分析XMLMapperBuilder#configurationElement方法

    try {
  //表明mapper根节点的namespace属性是必须的，且不为空
  String namespace = context.getStringAttribute("namespace");
  if (namespace.equals("")) {
      throw new BuilderException("Mapper's namespace cannot be empty");
  }
  //设置工作区间
  builderAssistant.setCurrentNamespace(namespace);
  //解析相应的属性
  cacheRefElement(context.evalNode("cache-ref"));
  cacheElement(context.evalNode("cache"));
  //解析<parameterMap>节点集合
  parameterMapElement(context.evalNodes("/mapper/parameterMap"));
  //解析<resultMap>节点集合
  resultMapElements(context.evalNodes("/mapper/resultMap"));
  //解析<sql>节点集合
  sqlElement(context.evalNodes("/mapper/sql"));
  //创建MappedStatement,这里与注解方式的加载方式还是类似的      
  buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
} catch (Exception e) {
  throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e);
}
    这里讨论下与前一章节不同的解析同一属性配置方法：

    • XMLMapperBuilder#resultMapElement(XNode resultMapNode, List<ResultMapping> additionalResultMappings)解析单个<resultMap>节点方法

      ErrorContext.instance().activity("processing " + resultMapNode.getValueBasedIdentifier());
//读取id属性，最好配置以免不必要的错误
String id = resultMapNode.getStringAttribute("id",
resultMapNode.getValueBasedIdentifier());
//优先级为type>ofType>resultType>javaType
String type = resultMapNode.getStringAttribute("type",
resultMapNode.getStringAttribute("ofType",
resultMapNode.getStringAttribute("resultType",
resultMapNode.getStringAttribute("javaType"))));

String extend = resultMapNode.getStringAttribute("extends");
//是否开启自动映射，默认值为unset
Boolean autoMapping = resultMapNode.getBooleanAttribute("autoMapping");
Class<?> typeClass = resolveClass(type);

//<discriminator><case /><case/></discriminator>根据结果值进行结果类型的映射，类似java的switch-case语法 
Discriminator discriminator = null;
//ResultMap节点信息转化为ResultMapping集合
List<ResultMapping> resultMappings = new ArrayList<ResultMapping>();
resultMappings.addAll(additionalResultMappings);
List<XNode> resultChildren = resultMapNode.getChildren();
for (XNode resultChild : resultChildren) {
  if ("constructor".equals(resultChild.getName())) {
    //<resultMap>节点下<constructor>节点处理
    processConstructorElement(resultChild, typeClass, resultMappings);
  } else if ("discriminator".equals(resultChild.getName())) {
    //<resultMap>节点下<discriminator>节点处理
    discriminator = processDiscriminatorElement(resultChild, typeClass, resultMappings);
  } else {
    //<id>/<result>/<collection>/<association>节点的解析
    ArrayList<ResultFlag> flags = new ArrayList<ResultFlag>();
    if ("id".equals(resultChild.getName())) {
      flags.add(ResultFlag.ID);
    }
    resultMappings.add(buildResultMappingFromContext(resultChild, typeClass, flags));
  }
}
ResultMapResolver resultMapResolver = new ResultMapResolver(builderAssistant, id, typeClass, extend, discriminator, resultMappings, autoMapping);
try {
  //组装成ResultMap对象保存到Configuration对象的私有集合变量resultMaps
  return resultMapResolver.resolve();
} catch (IncompleteElementException  e) {
  configuration.addIncompleteResultMap(resultMapResolver);
  throw e;
}

    • XMLMapperBuilder#sqlElement(List<XNode list>)sql节点信息的解析，主要作用是将每个sql节点对象都保存到Configuration对象中的Map<String, XNode> sqlFragments属性中。

      for (XNode context : list) {
  //sql节点的databaseId属性
  String databaseId = context.getStringAttribute("databaseId");
  //sql节点的id属性
  String id = context.getStringAttribute("id");
  //id=${namespace}+"."+id
  id = builderAssistant.applyCurrentNamespace(id, false);
  //true的前提是
  //主配置文件指定了databaseId属性
  //或者主配置和sql节点的databaseId属性均不存在，但sql节点的id属性存在
  if (databaseIdMatchesCurrent(id, databaseId, requiredDatabaseId)) {
sqlFragments.put(id, context);
  }
}

    • XMLMapperBuilder#buildStatementFromContext(context.evalNodes("select|insert|update|delete"))CRUD语句节点解析，
      这里直接看 XMLStatementBuilder#parseStatementNode()方法的部分代码

      //节点上支持的常见属性
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");
String lang = context.getStringAttribute("lang");
LanguageDriver langDriver = getLanguageDriver(lang);
...
String resultSetType = context.getStringAttribute("resultSetType");
StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));
...
// Include Fragments before parsing 导入<include>标签内容，其内部可以含有<if>/<where>/<set>等标签
XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
includeParser.applyIncludes(context.getNode());


// Parse selectKey after includes and remove them.导入<selectKey>标签内容
processSelectKeyNodes(id, parameterTypeClass, langDriver);

// Parse the SQL (pre: <selectKey> and <include> were parsed and removed) 如何解析sql语句？放置下一章节讲解
SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);

...
//这里就跟上一章节的注解生成MappedStatement是一致的，最终都是保存在Configuration的Map<String, MappedStatement> mappedStatement集合属性
builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
resultSetTypeEnum, flushCache, useCache, resultOrdered, 
keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);

总结

  • 不管是通过注解模式还是配置文件模式，都会生成MappedStatement对象保存到Configuration对象中
  • 注解模式可以很好的直接通过上一章节的讲解模式来达到sql语句与类直接绑定；但本章的sql 配置文件并没有讲到如何绑定对应namespace指向的class对象。这在MapperScannerConfigurer源码分析中讲解
  • 每个select|update|insert|delete标签均会被解析为单个MappedStatement对象，其中的id为namespace_id作为唯一标志

下节预告

Spring mybatis源码篇章-XMLLanguageDriver解析sql包装为SqlSource


OkidoGreen
关注
专栏目录
Mybatis源码解析之Spring集成mybatis-spring分析
翻身已碰头的博客
03-21 1064
Mybatis源码解析之核心类分析 Mybatis源码解析之初始化分析 Mybatis源码解析之执行流程解析 Mybatis源码解析之数据库连接和连接池 Mybatis源码解析之事务管理 Mybatis源码解析之缓存机制（一）：一级缓存 Mybatis源码解析之缓存机制（二）：二级缓存 Mybatis源码解析之插件机制 前面的几篇相关博客都针对原生的mybatis进行解析，从本文开始将针对myba...
spring boot 如何优雅的使用mybatis-spring-boot-starter
qq_44894516的博客
04-14 5969
spring boot 如何优雅的使用mybatis-spring-boot-starter
spring整合myBatis源码及jar
03-29
spring整合myBatis源码及jar
spring-mybatis源码分析
weixin_45453628的博客
07-28 201
spring-mybatis源码分析
spring-mybatis源码解析
BushRo
05-11 1456
本文主要围绕三个问题展开？ - 1.spirng是怎么和mybatis关联起来的？ - 2.xml和mapper是如何解析的 - 3.mapper中的方法是怎么和xml中的方法关联起来的？
Mybatis-Spring源码分析(一) MapperScan
Smallc0de的博客
10-14 588
说到Mybatis想必大家都很熟悉，作为和Spring结合的非常紧密的一个数据库插件，其提供的便利性非常值得我们去学习。研读Mybatis-Spring的第一步就是要明白Mybatis是怎么把Mapper接口转化为MapperFactoryBean的，如果不了解这一步，基本上读源码也会读的知其然不知所以然。由于网上很多讲解MapperScan注解的都已经过时了，而Mybati-Spring的新版本已经对代码做了重大的修改，所以笔者根据比较新的mybatis-spring:2.0.5版本进行一个重新的解读，和
mybatis-spring源码分析（有图解）
qq1805696978的博客
07-24 583
springboot所有的中间件配置都是从 xxxAutoConfiguration开始的。mybatis也不例外。MybatisAutoConfiguration最重要的3个方法 接下来按照执行顺序，逐一讲解 一、MapperScannerRegistrarNotFoundConfiguration 这个类不一定会执行，主要取决于 1、那么这个bean什么时候会有，什么时候会没有呢？这取决于你用什么方式扫描方式。我们通常有2种方式声明mapper： ①在启动类添加@Mappe..
mybatis-spring-1.2.2-sources.jar源码
11-30
《深入解析mybatis-spring-1.2.2源码》 在Java开发领域，MyBatis和Spring的集成是常见的技术栈选择，mybatis-spring库为这两者提供了无缝的连接。本文将深入探讨mybatis-spring-1.2.2-sources.jar的源码，揭示其...
Mybatis源码分析——mybatis-config.xml解析
有米oooooooo
06-23 927
在源码分析过程中，会使用到一些额外的知识，比如 Mybatis中使用的spring接口 Mybatis中使用的设计模式 Mybatis初始化配置文件分为三个阶段，如下 mybatis-config.xml解析 mapper.xml文件解析 mapper跟dao绑定 本篇分析的是第一阶段。 本系列的文章都是基于这个demo来分析的 Mybatis入门，一个简单的demo 首先，看一下初始化入口 ...
MyBatis详解：spring和mybatis整合
最新发布
2401_84153193的博客
05-03 1375
毕竟工作也这么久了 ，除了途虎一轮，也七七八八面试了不少大厂，像阿里、饿了么、美团、滴滴这些面试过程就不一一写在这篇文章上了。我会整理一份详细的面试过程及大家想知道的一些问题细节毕竟工作也这么久了 ，除了途虎一轮，也七七八八面试了不少大厂，像阿里、饿了么、美团、滴滴这些面试过程就不一一写在这篇文章上了。我会整理一份详细的面试过程及大家想知道的一些问题细节。
Spring + Spring MVC + MyBatis整合项目（源码）
12-25
Spring + Spring MVC + MyBatis整合项目的源码。
《spring+mybatis 企业应用实战》源码、类库全资料
06-07
《spring+mybatis 企业应用实战》源码、类库全资料
springBoot整合mybatis源码
08-23
springBoot整合mybatis源码,直接可以在idea中运行，简单易学，上手快
java+springMVC+Mybatis源码
07-02
这是一个java+springMVC+Mybatis源码包，可以供刚刚学习java框架的朋友们学习参考
mybatis-spring的jar包和源码包
10-05
mybatis-Spring的jar包和源码包： mybatis-spring-1.2.3.jar mybatis-spring-1.2.3-javadoc.jar mybatis-spring-1.2.3-sources.jar
Spring Boot 整合Mybatis(步骤讲解) 附源码
初心の GP的博客
08-19 1533
新建Maven项目 新建项目后目录结构 新增目录结构src/main/resources 新增目录结构后的结构展示 新增包结构 在原pom.xml添加
Spring-Mybatis框架使用与源码解析
恐龙弟旺仔的博客
08-02 1044
前言：     在上一篇文章 https://blog.csdn.net/qq_26323323/article/details/81335058 中，我们说了使用mybatis有三种方式， 而上篇文章介绍了关于使用原生Mybatis的源码解析。     实际在常规项目开发中，大部分都会使用mybatis与Spring结合起来使用，毕竟现在不用Spring开发的项目实在太少了。     那么...
SpringSpringMvcMybatis
05-14
################ tips：################ Spring MVC测试 测试Web项目不需要启动项目：需要servlet相关的模拟对象,比如： MockMVC,MockHttpServletRequest,MockHttpServletResponse,MockHttpSession 引入一个概念：测试驱动开发(TDD) 借助Junit和Spring TestContext framework 和RestController 监听器的作用： 监听对象 监听对象的属性 1：统计在线人数和在线用户 HttpSessionListener httpSessionAttributeListener 2：系统启
Spring+SpringMVC+MyBatis整合工程实例 完整版源码（带注释）
07-19
这个SSM框架整合工程是基于IntelliJ IDEA完成的的，工程里面配置文件均有注释，可直接拷贝使用（工程代码可导入IDEA中直接运行）
MyBatis源码分析：实用篇与配置解析
"MyBatis源码分析专题之Mybatis课程一之实用篇.pdf，主要讲解了MyBatis框架的基本概念、使用方法以及与JDBC的对比，旨在帮助开发者更好地理解和应用MyBatis进行数据库操作。" 在Java Web开发中，MyBatis是一个流行...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值