mybatis源码分析-配置文件解析(mapper节点的解析)

已于 2024-01-01 12:42:25 修改
阅读量567 收藏 11
点赞数 12
分类专栏： mybatis 文章标签： mybatis java
于 2024-01-01 12:34:43 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/junkangaike/article/details/135324022
版权

文章目录

mybatis源码分析-配置文件解析(2 mapper节点解析)

mappers文件单独放一个文章出来，因为解析mappers很关键，是mybatis最重要的一个环节，解析了mappers下面的节点后，回去解析具体的mapper文件里面的sql等

mappers节点解析过程分析

mapperElement(root.evalNode("mappers"));

//解析mappers的节点，他配置有好多种
private void mapperElement(XNode parent) throws Exception {
  if (parent != null) {
    for (XNode child : parent.getChildren()) {
      //如果是配置了package
      if ("package".equals(child.getName())) {
        //com.wjk.mapper        <package name="com.wjk.mapper"/>
        String mapperPackage = child.getStringAttribute("name");
        configuration.addMappers(mapperPackage);
      } else {
        //resource，url，class的配置优先解析
        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.");
        }
      }
    }
  }
}

mapperParser.parse()解析

public void parse() {
  //这里判断是loadedResources = new HashSet<String>(); loadResources是一个hashSet，里面的contain方法判断是否存在key
  //加载我们的定义的mapper.xml的文件
  if (!configuration.isResourceLoaded(resource)) {
    //解析mapper节点
    configurationElement(parser.evalNode("/mapper"));
    // 添加资源路径到“已解析资源集合”中
    configuration.addLoadedResource(resource);
    // 通过命名空间绑定 Mapper 接口
    bindMapperForNamespace();
  }

  // 处理未完成解析的节点
  parsePendingResultMaps();
  parsePendingCacheRefs();
  parsePendingStatements();
}

//解析mapper节点
private void configurationElement(XNode context) {
  try {
    //获得namespace <mapper namespace="com.wjk.mapper.UserMapper">
    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"));
    //解析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);
  }
}

private void buildStatementFromContext(List<XNode> list) {
  if (configuration.getDatabaseId() != null) {
    buildStatementFromContext(list, configuration.getDatabaseId());
  }
  buildStatementFromContext(list, null);
}

private void buildStatementFromContext(List<XNode> list, String requiredDatabaseId) {
  //具体解析我们的节点
  for (XNode context : list) {
    final XMLStatementBuilder statementParser = new XMLStatementBuilder(configuration, builderAssistant, context, requiredDatabaseId);
    try {
      statementParser.parseStatementNode();
    } catch (IncompleteElementException e) {
      configuration.addIncompleteStatement(statementParser);
    }
  }
}

parseStatementNode解析具体的节点

public void parseStatementNode() {
  //具体的方法名字
  String id = context.getStringAttribute("id");
  String databaseId = context.getStringAttribute("databaseId");

  if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
    return;
  }
	//获得里面节点的信息
  Integer fetchSize = context.getIntAttribute("fetchSize");
  Integer timeout = context.getIntAttribute("timeout");
  String parameterMap = context.getStringAttribute("parameterMap");
  String parameterType = context.getStringAttribute("parameterType");
  //入参参数是否有这个类
  Class<?> parameterTypeClass = resolveClass(parameterType);
  //获得resultmap
  String resultMap = context.getStringAttribute("resultMap");
  //获得resultType，最后也会转换成resultmap
  String resultType = context.getStringAttribute("resultType");
  String lang = context.getStringAttribute("lang");
  LanguageDriver langDriver = getLanguageDriver(lang);
  //获得返回值的class类型，很关键
  Class<?> resultTypeClass = resolveClass(resultType);
  String resultSetType = context.getStringAttribute("resultSetType");
  StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));
  ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);
  //nodeName是我们的标签select ,update,insert之类的
  String nodeName = context.getNode().getNodeName();
  //获得我们具体的sqlCommandType类型
  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 Fragments before parsing
  XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
  includeParser.applyIncludes(context.getNode());

  // Parse selectKey after includes and remove them.
  processSelectKeyNodes(id, parameterTypeClass, langDriver);
  
  // Parse the SQL (pre: <selectKey> and <include> were parsed and removed)
  //获得sqlSource，sqlSource里面有sql #{}部分代替成 ？展示，然后里面的字段隐射放到list里面parameterMapping
  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;
  }
	//生成一个MappedStatement
  builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
      fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
      resultSetTypeEnum, flushCache, useCache, resultOrdered, 
      keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);
}

builderAssistant.addMappedStatement()方法，生成MappedStatement放到configuration里面

public MappedStatement addMappedStatement(
  String id,
  SqlSource sqlSource,
  StatementType statementType,
  SqlCommandType sqlCommandType,
  Integer fetchSize,
  Integer timeout,
  String parameterMap,
  Class<?> parameterType,
  String resultMap,
  Class<?> resultType,
  ResultSetType resultSetType,
  boolean flushCache,
  boolean useCache,
  boolean resultOrdered,
  KeyGenerator keyGenerator,
  String keyProperty,
  String keyColumn,
  String databaseId,
  LanguageDriver lang,
  String resultSets) {

  if (unresolvedCacheRef) {
    throw new IncompleteElementException("Cache-ref not yet resolved");
  }
  //namespace + id
  id = applyCurrentNamespace(id, false);
  boolean isSelect = sqlCommandType == SqlCommandType.SELECT;
  //id selectTest sqlSoure包含sql和parameterMappings                                                         //sql类型 select
  MappedStatement.Builder statementBuilder = new MappedStatement.Builder(configuration, id, sqlSource, sqlCommandType)
    .resource(resource) //userMapper.xml
    .fetchSize(fetchSize)
    .timeout(timeout)
    .statementType(statementType)//PREPARED
    .keyGenerator(keyGenerator)
    .keyProperty(keyProperty)
    .keyColumn(keyColumn)
    .databaseId(databaseId)
    .lang(lang)
    .resultOrdered(resultOrdered)
    .resultSets(resultSets)
    //如果是resultType也转换成resultMap
    .resultMaps(getStatementResultMaps(resultMap, resultType, id)) //class com.wjk.entity.user
    .resultSetType(resultSetType)
    .flushCacheRequired(valueOrDefault(flushCache, !isSelect))
    .useCache(valueOrDefault(useCache, isSelect))
    .cache(currentCache);
  ParameterMap statementParameterMap = getStatementParameterMap(parameterMap, parameterType, id);
  if (statementParameterMap != null) {
    statementBuilder.parameterMap(statementParameterMap);
  }

  MappedStatement statement = statementBuilder.build();
  //放入到configuration里面 mappedStatements是一个StrictMap
  configuration.addMappedStatement(statement);
  return statement;
}

//  protected final Map<String, MappedStatement> mappedStatements = new StrictMap<MappedStatement>("Mapped Statements collection");
public void addMappedStatement(MappedStatement ms) {
  mappedStatements.put(ms.getId(), ms);
}

//类似于我们的hashMap
public V put(String key, V value) {
  //如果存在key，直接抛出异常
  if (containsKey(key)) {
    throw new IllegalArgumentException(name + " already contains value for " + key);
  }
  //如果存在点 namespace.id,直接往map里面放入两个
  //一个是id,一个是nameSpace+id的放入map里面
  if (key.contains(".")) {
    final String shortKey = getShortName(key);
    if (super.get(shortKey) == null) {
      super.put(shortKey, value);
    } else {
      super.put(shortKey, (V) new Ambiguity(shortKey));
    }
  }
  return super.put(key, value);
}

总结：

mappers节点解析过程

1.解析mappers节点

2.遍历mappers下面的xxxmapper.xml文件，解析里面的所有节点，select,insert等

3.遍历里面的每个节点，生成mappedStatement对象，mappedStatement里面有参数解析，结果集解析，sqlSource(后面参数解析使用，里面还有sql，里面的#{}用？代替)

4.mappedStatement对象放入到mappedStatement里面，他是一个StrictMap，里面存两个一个是id，还有一个是namespace+id, value都是mappedStatement

俊康0813
关注
  • 12
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis——mapper文件详解
2401_83916355的博客
03-30 945
总的来说，面试是有套路的，一面基础，二面架构，三面个人。最后，小编这里收集整理了一些资料，其中包括面试题（含答案）、书籍、视频等。希望也能帮助想进大厂的朋友《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门即可获取！漫长，而且极易碰到天花板技术停滞不前！**因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
【Mybatis】mapper文件的解析
qq_34501351的博客
02-10 2460
mybatis的配置文件解析每一个部分，之后将数据添加槽cofiguration类中，本章只介绍解析mapper文件的部分。 mapper文件中的insert,delete,update,select标签会被解析，封装为MappedStatement对象 private String resource; // mybatis总的配置类。 private Configuration configuration; // namespace+标签的id private String id;
MyBatis——Mapper映射文件
如不來的博客
07-12 542
一、Mapper文件简述  Mapper映射文件即前面提到的XxxMapper.xml配置文件，该文件将Mapper接口及其接口方法通过配置的方式进行映射，XxxMapper.xml的主要内容就是各个接口及其接口方法要实现的SQL逻辑。一个XxxMapper.xml文件只能映射一个接口，这也是由dtd约束定义的： <!ELEMENT mapper (cache-ref | cache | r...
Mybatis源码分析（四）Mapper文件的解析
长安不及十里的博客
01-12 1882
1. 调用XMLMapperBuilder#parse（）对我们编写的Mybats.xml文件解析，主要包括：cache，resultMap，sql，select|insert|update|delete语句进行解析 2. resultMap进行解析是主要调用XMLMapperBuilder这个类进行解析返回ResultMapping 3. select|insert|update|delete解析主要调用XMLStatementBuilder这个类对数据库各个节点进行解析返回Mappe
Mybatis源码分析(3) -- Mapper文件解析
chenwei7858的博客
02-27 246
Mybatis源码分析(3) -- Mapper文件解析 前面我们分析到<mappers>的解析最终是由XMLMapperBuilder和MapperAnnotationBuilder解析，XMLMapperBuilder用于解析xml配置文件，MapperAnnotationBu...
MyBatis-Mapper文件
qq_17514043的博客
10-12 922
Mapper文件 Mapper根标签 mapper文件相当于Dao接口的实现类，namespace属性指定实现Dao接口的全限定类名 insert标签 声明添加操作（sql: insert ) 常用属性： id属性：绑定对应Dao接口中的方法 parameterType：指定接口中对应方法发的参数类型（可省略） useGeneratedKeys：用于设置添加操作是否需要回填生成的主键 keyProperty 设置回填的主键值赋值到参数对象的哪个属性 timeOut :设置此操作的超时时间，如果不设置
MyBatis之Mapper文件
carson0408的博客
02-05 471
MyBatis框架中，主要核心部分之一就是Mapper映射文件。因为MyBatis的DAO组件只是通过接口，而不需要实现类，因此，Mapper映射文件显得十分重要，因为接口中的对数据库的原子方法的实现都在Mapper映射文件中进行使用原生的SQL语句实现，所以对于Mapper.xml的编写也十分重要。本文主要讲解一下Mapper文件编写常见的语法以及常见的情况，从而对其进行的一个整理总结。 1.
mybatis-3-mapper.rar
08-06
mybatis-3-mapper.dtd，解决eclipse使用mybatis时，无法自动提示标签信息的问题
mybatis-3-config/mapper.dtd 解决mybatis头文件报错
04-10
然后打开eclipse ->Window->prefenrence->XML->XML Catalog->User Specifiled Entreis->Add->Location(此处是你放dtd文件的位置例如：‪D:\mybatis\mybatis-3-config.dtd)->Key(如果更改config，此处应该是：-//...
mybatis-3-config.dtd mybatis-3-mapper.dtd
06-04
mybatis配置的重要文件包括mybatis-3-config.dtd mybatis-3-mapper.dtd
mybatis自动生成mapper文件
11-06
mybatis自动生成实体类和mapper文件。自动添加实体类注释。
Mapper文件（基于Mybatis Maven插件）
weixin_44674424的博客
02-24 915
自动生成Mapper文件（基于Mybatis Maven插件）
Mybatis的mapper配置文件(一)
u012068294的专栏
11-09 1172
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.geo.dao.UserMapper"> <!--re
Mybatis-select、insert、update、delete标签详解
weixin_34026276的博客
10-11 1043
2019独角兽企业重金招聘Python工程师标准>>> ...
Mybatis 解释 mapper 文件
CoderLi
05-13 767
我们知道 Mybatis 在解释配置文件的时候使用的是 XMLConfigBuilder、在解释 mapper 标签的时候、为每个 Mapper.xml 文件创建一个 XMLMapperBuilder 实例解释 mapper 文件。 public void parse() { if (!configuration.isResourceLoaded(resource)) { configurationElement(parser.evalNode("/mapper")); configu.
mybatis mapper文件配置
SeaLong_的博客
05-23 442
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="c...
MyBatis中Mapper的文件配置讲解一 (三)
昆仔的博客
01-21 451
MyBatis中Mapper的文件配置讲解 学习要点 sql映射文件常用元素的讲解 select元素 insert语句 update delete MySql(SqlServer)与Oracle支持/不支持自增的配置方式 sql映射文件常用元素的讲解 1. select元素 select 元素是用来映射查询语句，是MyBatis常用元素之一 通过上面的语句可以根
Mybatis 解析mapper过程
nobaldnolove的博客
12-28 1293
Mybatis 解析Mapper.xml文件过程
mybatis.config-location=classpath:mybatis/mybatis-config.xml mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
最新发布
07-13
这是一个典型的MyBatis配置文件中的两个重要配置项：mybatis.config-location和mybatis.mapper-locations。 mybatis.config-location指定了MyBatis的配置文件位置。在这个例子中，配置文件名为mybatis-config.xml，并且它位于classpath下的mybatis目录中。配置文件中包含了一些全局的配置选项，比如数据库连接信息、插件配置、类型别名等。 mybatis.mapper-locations指定了MyBatis映射文件（Mapper XML文件）的位置。在这个例子中，映射文件的位置是classpath下的mybatis/mapper目录，并且所有以.xml结尾的文件都会被作为映射文件加载。映射文件中定义了SQL语句与Java接口方法的映射关系，以及结果集的映射规则。 通过这两个配置项，MyBatis能够找到并加载相应的配置文件和映射文件，从而完成数据库操作。当应用程序启动时，MyBatis会根据这些配置进行初始化，建立数据库连接，并加载所有的映射文件，以便后续的数据库操作能够顺利进行。 希望这个解答对您有帮助，如果有其他问题，请随时提问。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值