从根上理解：Mybatis中数据库的列和Java字段是怎么映射的？

最新推荐文章于 2023-09-14 16:28:20 发布
最新推荐文章于 2023-09-14 16:28:20 发布
阅读量1.9k 收藏 3
点赞数 2
分类专栏： Mybatis 文章标签： java 数据库 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_46225886/article/details/121648100
版权

1. 写在前头

我们使用Mybatis时要写 mapper.xml，因为MyBatis 不像 Hibernate 那样是全自动 ORM ，对于实体类型它无法直接识别，这里面我们要自己定义 resultMap ，手动实现映射。

那它在底层是如何实现将实体类的字段和数据库的列一一对应的呢？这也是我小米二面的一道面试题：“你知道Mybatis中数据库的列和Java实体类是怎么对应上的吗？”

那我们就从浅入深学习一下吧，我看看谁还能问的倒我！

不想看具体源码直接拖到最后看答案（那就亏大啦 /doge)
在这里插入图片描述

2. 准备工作

  • 创建一个供我们映射的Java实体类，非常的简单只是id，name，tel三个字段
public class Department {

    public Department(String id) {
        this.id = id;
    }

    private String id;

    /**
     * 部门名称
     */
    private String name;

    /**
     * 部门电话
     */
    private String tel;

}
  • 创建DepartmentMapper.xml，定义ResultMap将字段和数据库列一一映射
 <resultMap id="lazyDepartmentMap" type="entity.Department">
     <id property="id" column="id"/>
     <result property="name" column="name"/>
     <result property="tel" column="tel"/>
 </resultMap>
  • 注意在mybatis的配置文件mapper标签中要标记DepartmentMapper.xml
<mappers>
    <mapper resource="mapper/DepartmentMapper.xml"/>
</mappers>

准备好了，我们步入正题！

3. 加载配置文件中mappers标签

注意：因为本次我们只讲映射的实现，所以我会将无关的源码都省去，因为不是逐条分析的源码可能会有些跳跃，但是逐条分析又显得不针对问题，所以我建议大家结合文章内容自己Debug一下，我觉得这样才是最好的状态，大家注意看代码中的注释，我会将需要注意的点都标记出来

  • mybatis在启动的时候，会调用parseConfiguration方法，其中需要关注mapperElement方法，这是对我们指定的mapper.xml文件进行加载的过程，下方源码大家扫一眼，重点关注标记的最后一句
  private void parseConfiguration(XNode root) {
    try {
      // 这里就是对配置文件的加载，大家看其中的字符串是不是和我们在配置文件中写的标签一致
      // properties, settings, typeAliases...这些，重点需要关注最后一个mappers
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      loadCustomLogImpl(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      
      // 加载配置文件中我们指定的mappers，这里对应我们上边指定的DepartmentMapper.xml文件
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

3.1 mapperElement方法，加载mapper.xml

  • 加载mapper.xml文件时，有package包扫描和根据resource, url, mapperClass指定扫描，下面源码中也标记的很清楚。因为我们在本例中使用的是resource，所以我就把无关的代码擦掉啦
  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 {
          // 三种不同的指定方式 resource url class 
          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();
          } else if (resource == null && url != null && mapperClass == null) {
            // url加载 ...
          } else if (resource == null && url == null && mapperClass != null) {
            // class加载 ...
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

3.2 parse方法，加载mapper.xml的具体步骤

  • 核心的方法步骤都在这里了，我们重点看标记了数字的代码行
  public void parse() {
    // 判断mapper.xml文件是否被加载过
    if (!configuration.isResourceLoaded(resource)) {
      // 1. 加载mapper元素 
      configurationElement(parser.evalNode("/mapper"));
      configuration.addLoadedResource(resource);
      // 绑定命名空间，这个是不是很熟悉？ 
      bindMapperForNamespace();
    }

	// 2. 解析resultMap
    parsePendingResultMaps();
    // 解析cache-ref，与二级缓存有关
    parsePendingCacheRefs();
    // 解析statement，statement是我们写的select等SQL代码
    parsePendingStatements();
  }

我们先看configurationElement方法

3.2.1 加载mapper元素，configurationElement方法
  • configurationElement(parser.evalNode("/mapper"));
    注意方法调用中有/mapper参数，这个其实是我们xml文件中最顶层的标签
    在这里插入图片描述
  • 实现细节如下
 private void configurationElement(XNode context) {
    try {
      // 获取命名空间
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.isEmpty()) {
        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标签和我们写的SQL
      sqlElement(context.evalNodes("/mapper/sql"));
      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);
    }
  }

我们要深入resultMapElements方法，抓好了，前边路抖！

3.2.1.1 解析resultMap，resultMapElements方法
  • 多次调用resultMapElement方法
  // 这里是一个for循环，因为我们会定义多个resultMap嘛
  private void resultMapElements(List<XNode> list) {
    for (XNode resultMapNode : list) {
      try {
        resultMapElement(resultMapNode);
      } catch (IncompleteElementException e) {
        // ignore, it will be retried
      }
    }
  }
  • 下面我们直接看resultMapElement核心方法，有点儿长警告！

在这里插入图片描述

一步步来，没有我们看不完的代码！

  private ResultMap resultMapElement(XNode resultMapNode, List<ResultMapping> additionalResultMappings, Class<?> enclosingType) {
    ErrorContext.instance().activity("processing " + resultMapNode.getValueBasedIdentifier());

    // 解析映射目标对应的实体类类型，在我们的xml文件中使用的是type标签
    String type = resultMapNode.getStringAttribute("type",
        resultMapNode.getStringAttribute("ofType",
            resultMapNode.getStringAttribute("resultType",
                resultMapNode.getStringAttribute("javaType"))));

    // 加载出实体类类型
    Class<?> typeClass = resolveClass(type);
    if (typeClass == null) {
      typeClass = inheritEnclosingType(resultMapNode, enclosingType);
    }
    Discriminator discriminator = null;
    List<ResultMapping> resultMappings = new ArrayList<>(additionalResultMappings);
    
    // 解析resultMap的子标签，并封装成resultMapping
    // 子标签constructor，这个是指定构造器
    // 子标签discriminator，鉴别器，它有妙用，可以根据数据不同指定不同的resultMap，大家可以了解一下
    // id和result子标签，常用，也是我们xml文件中使用的标签
    List<XNode> resultChildren = resultMapNode.getChildren();
    for (XNode resultChild : resultChildren) {
      if ("constructor".equals(resultChild.getName())) {
        processConstructorElement(resultChild, typeClass, resultMappings);
      } else if ("discriminator".equals(resultChild.getName())) {
        discriminator = processDiscriminatorElement(resultChild, typeClass, resultMappings);
      } else {
        // 因为我们在xml文件中只指定了id和result，所以会直接跑到这里执行
        List<ResultFlag> flags = new ArrayList<>();
        if ("id".equals(resultChild.getName())) {
          flags.add(ResultFlag.ID);
        }
        // result标签直接注册成resultMapping，下面我贴了两张Debug图供大家加深理解
        resultMappings.add(buildResultMappingFromContext(resultChild, typeClass, flags));
      }
    }
    // 获取resultMap的id值，我们这里id是lazyDepartmentMap
    String id = resultMapNode.getStringAttribute("id",
            resultMapNode.getValueBasedIdentifier());
    // 看看是否有继承的resultMap
    String extend = resultMapNode.getStringAttribute("extends");
    // autoMapping标签
    Boolean autoMapping = resultMapNode.getBooleanAttribute("autoMapping");
    // 利用ResultMapResolver处理resultMap
    ResultMapResolver resultMapResolver = new ResultMapResolver(builderAssistant, id, typeClass, extend, discriminator, resultMappings, autoMapping);
    try {
      // 最后一步
      return resultMapResolver.resolve();
    } catch (IncompleteElementException e) {
      configuration.addIncompleteResultMap(resultMapResolver);
      throw e;
    }
  }
  • buildResultMappingFromContext方法我就不粘出来了，因为它只是简单的取标签属性值罢了，没什么意思，下面儿两张图供大家加深理解，在图之后我们再简单的看一下最后一步resultMapResolver.resolve方法
    在这里插入图片描述
    在这里插入图片描述
  • 我把最后一步代码抽出来，方便大家看
    try {
      // 最后一步
      return resultMapResolver.resolve();
    } catch (IncompleteElementException e) {
      configuration.addIncompleteResultMap(resultMapResolver);
      throw e;
    }
  • 这里调用的是MapperBuilderAssistant的resolve方法，它会把生成的resultMap封装到Configuration的resultMaps中
  private final MapperBuilderAssistant assistant;

  public ResultMap resolve() {
    return assistant.addResultMap(this.id, this.type, this.extend, this.discriminator, this.resultMappings, this.autoMapping);
  }

  // 封装到Configuration的resultMaps中
  public ResultMap addResultMap(...) {
    id = applyCurrentNamespace(id, false);
    extend = applyCurrentNamespace(extend, true);

    if (extend != null) {
      ...
    }
    ResultMap resultMap = new ResultMap.Builder(configuration, id, type, resultMappings, autoMapping)
        .discriminator(discriminator)
        .build();
    // 这里，便加入到了configuration的resultMaps中
    configuration.addResultMap(resultMap);
    return resultMap;
  }
  • Configuration中的resultMaps字段
protected final Map<String, ResultMap> resultMaps = new StrictMap<>("Result Maps collection");
3.2.2 我们回到parse方法中，再看parsePendingResultMaps方法
  private void parsePendingResultMaps() {
  
    Collection<ResultMapResolver> incompleteResultMaps = configuration.getIncompleteResultMaps();
    synchronized (incompleteResultMaps) {
      Iterator<ResultMapResolver> iter = incompleteResultMaps.iterator();
      while (iter.hasNext()) {
        try {
          // 逐个解析
          iter.next().resolve();
          iter.remove();
        } catch (IncompleteElementException e) {
          // ResultMap is still missing a resource...
        }
      }
    }
  }

  • 这里取出来一组ResultMapResolver，注意它有个单词incomplete，不完整的，说明来到这里的resultMap还没有真正的解析完成，需要在这里继续解析，而pending又有悬而未决的意思，现在觉得能自解释的代码真的很酷

  • 因为我们定义的resultMap是已经完整解析的，我们Debug到这里incompleteResultMaps的大小为0，不必继续解析

  • 那什么样的是没有完整解析的呢？我们需要再看看3.2.1.1节中resultMapElement方法最末尾的代码

    try {
      return resultMapResolver.resolve();
    } catch (IncompleteElementException e) {
      // 这里添加了IncompleteResultMap
      // 说明上边的resolve方法必须抛出IncompleteElementException异常才行
      configuration.addIncompleteResultMap(resultMapResolver);
      throw e;
    }

那什么情况下能抛出IncompleteElementException异常？我们需要再看一下resultMapResolver.resolve方法中的代码

  public ResultMap addResultMap(...) {
    id = applyCurrentNamespace(id, false);
    extend = applyCurrentNamespace(extend, true);

    if (extend != null) {
      // 这里，resultMap中必须指定了extend标签
      // 且当前configuration中不包含我们继承的resultMap，就会抛出这个异常
      if (!configuration.hasResultMap(extend)) {
        throw new IncompleteElementException("Could not find a parent resultmap with id '" + extend + "'");
      }
		......
  }

在有继承的resultMap时，也就是result指定了extend标签，但是这个被继承的resultMap还没被解析完成：Configuration中还没有这个ResultMap，这时就会抛出这个异常，那么就会被添加到IncompleteResultMap中

  • 我们试一下，给我们定义的resultMap添加上extend标签，如下
    <resultMap id="lazyDepartmentMap" type="entity.Department" 
    extends="dao.UserMapper.userMap">
    
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="tel" column="tel"/>
    </resultMap>
  • Debug一下，确实抛出了这个异常，进入到了这里
    在这里插入图片描述
  • 我们再回到parsePendingResultMaps方法看看
    在这里插入图片描述
    这下进来的正是我们定义的这个没完全解析的ResultMap，需要进一步完成解析才行，好了，到这里ResultMap的加载就说完了

4. 我们该怎么回答这个问题

Java实体类与数据库列在mybatis中是半自动ORM映射，需要我们指定ResultMap，将实体类的字段和数据库列一一对应，在底层中它解析成resultMapping的形式，通过ResultMapResolver生成对应的ResultMap

5. 写在最后

这一部分源码读起来很清晰也很简单，也是因为我们只是从面上读了源码，并没有深入到它的具体细节中，包括生命周期什么的，我想如果在一篇帖子中写完那估计得上万字才行了，所以我把深入理解的放在新的帖子中吧

非常感谢大家的阅读，求收藏求点赞，如果能有一条评论那就是对我更大的支持了，我们，之后见吧！

巨人的肩膀

方圆想当图灵
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
MyBatis的核心配置
yandao的博客
03-18 897
mybatis:https://mybatis.org/mybatis-3/zh/index.html 主要有三个核心对象：SqlSessionFactoryBuilder, SqlSessionFactory, SqlSession这个是一个构建器，是用来构建SqlSessionFactory对象的，SqlSessionFactoryBuilder可以通过读取mybatis的配置文件，然后构建一个SqlSessionFactory对象，SqlSessionFactoryBuilder将mybatis配置文
Java的MyBatis框架中关键的XML字段映射的配置参数详解
09-02
在Java的MyBatis框架中，XML配置文件是连接应用程序与数据库的关键桥梁，其中包含了各种字段映射和配置参数。这些参数帮助开发者精细控制数据访问行为，提高程序的灵活性和性能。下面我们将深入探讨一些重要的XML...
insert语句返回主键id并映射到实体类中
qq_42715450的博客
01-10 2645
insert语句返回id映射到实体类中
mybatis 指定类型映射处理，实现针对数组集合,枚举,JSON对应类型映射
Dizzilys的博客
06-29 4307
主要说明对于mapper映射查询和新增时候进行的一些特殊类型处理。 首先讲解一下映射数组 CREATE TABLE `admin_role_ids` ( `id` bigint(20) NOT NULL primary key AUTO_INCREMENT COMMENT 'id', `type` varchar(16) DEFAULT NULL COMMENT '分别 admin , tourist 枚举', `role_ids` varchar(256) DEFAULT NULL COMME
Mybatis底层映射原理！
lxx的博客
05-21 644
Mybatis核心映射原理！
Mybatis 工作原理详解
huangtenglong的博客
11-09 5302
mybatis：缓存、防止注入、标签使用，结果集封装从底层实现
基于java的企业级应用开发：MyBatis的关联映射.ppt
06-21
总的来说，MyBatis的关联映射是实现Java对象与数据库表关联关系的重要手段，通过合理使用`<association>`元素和延迟加载机制，可以在保证开发灵活性的同时，有效提升应用程序的性能。学习并掌握这些知识点对于进行...
详解Java的MyBatis框架中SQL语句映射部分的编写
09-02
在Java的MyBatis框架中，SQL...总的来说，理解并熟练掌握MyBatis的`resultMap`和CRUD操作，对于提升Java应用中数据库操作的效率和灵活性至关重要。通过这种方式，开发者可以专注于业务逻辑，而不必过多关注SQL的细节。
mybatis根据数据库自动生成实体类，映射类，dao
08-01
MyBatis是一个强大的Java持久层框架，它允许开发者将SQL语句与Java代码分离，提供了更灵活的数据库操作方式。本教程将详细讲解如何利用MyBatis的代码生成器（Generator）根据数据库自动生成实体类、映射类以及DAO...
数据库框架Mybatis-plus,实现java代码对数据库的增删改查
最新发布
12-20
Mybatis-plus是一个基于...文件“05-mybatisplus”可能包含了一个简单的示例项目，展示了如何在Java项目中集成和使用Mybatis-plus进行数据库操作。通过学习这个示例，你可以更好地理解和应用Mybatis-plus的各种特性。
MybatisPlus 实体类与数据库表映射关系&MybatisPlus：ORM思想
qq_43842093的博客
08-27 1万+
在开发中可能会遇到MyBatis-Plus使用实体类属性进行SQL操作，但是不用存到数据库中去查找，这时候我们的实体中有这个属性，但是数据库的表中没有这个字段(即：实体类属性非数据库表字段)，如果不做处理就会报错。例如MyUserTable 对应的数据库表为 my_user_table;TEMyUserTable 对应表名为t_e_my_user_table;在类名上方添加@TableName(“my_user_table”)在实体类的属性上面加上这个注解后，此字段就不会映射数据库了。......
mybatis-plus和mybatis实体名和数据库字段映射问题
热门推荐
weixin_40598838的博客
10-10 1万+
概述 在mybatis-plus中，数据库字段为first_char，而实体类中为firstChar，不用在mapper中配置ResultMap，也能自动映射，不过记得加上get和set方法，或者使用@Data注解进行配置 demo 看到了嘛? 在mapper中，没有配置ResultMap，数据库字段中两个英文间的下划线在实体中使用小驼峰式命名规则(firstName, camelCase)进行了代替，然后完成注入，使用和数据库一样的命名也是无法注入的。我们来测试一下。 有没有看到。 ...
java类中属性值与数据库字段的匹配方式总结
qq_60614034的博客
01-21 1643
调用方法：类名.select(类名.class,"select * from 表名 where 字段名1=?, 字段名2=?....",字段名1的值，字段名2的值.....)通过反射机制来实现数据库字段的识别，说人话就是通过类中的属性名与数据库的字段名进行匹配，假如类中的属性不包含数据库的字段就会报错。匹配方式比较严苛。
Mybatis-Plus简述
weixin_64742764的博客
04-02 482
以几乎不写Sql.
MyBatis字段名和属性名不一样的解决方案
weixin_55772633的博客
09-14 832
这样设置之后，MyBatis就会将数据库中的下划线分隔的字段名转换为Java中的驼峰式命名。例如，如果数据库中的字段名为。开启驼峰匹配后，会将_自动映射为驼峰，如emp_name将会被映射为empName.如上面的SQL语句将emp_name取别名为empName对应实体类的属性名。在Spring Boot中，使用MyBatis时，可以通过在。resultMap：设置自定义映射。，则在Java中将会被映射为。
mybatisplus字段名和数据库名对不上怎么处理
weixin_58180226的博客
06-19 297
如果是springboot项目可以在yml的配置文件中开启mybatiplus中的驼峰命名映射功能。手写的sql查询语句也可以在在mapper.xml 文件中设置结果集的property属性。如果是自定以mapper.xml文件中手写的sql查询语句，可以给字段起一个别名。把实体类的字段名改成和数据库的字段名一样。
Mybatis如何做到dao.java与mapper.xml对应的
My_Way666的博客
04-15 1270
转：http://www.jb51.net/article/116402.htm 本文主要介绍的是关于mybatis通过接口查找对应mapper.xml及方法执行的相关内容，下面话不多说，来看看详细的介绍： 在使用mybatis的时候，有一种方式是 1 BookMapper bookMapper = SqlSessi...
mybatis 数据映射字段的关系
Hi, Sun
09-10 718
https://blog.csdn.net/sayoulalayy/article/details/50994350
Mybatis映射器原理分析
clyu的博客
01-25 1203
映射器（mappers） 既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要来定义 SQL 映射语句了。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL...
MyBatis入门：简化数据库操作与Java对象映射
MyBatis 是一款优秀的Java持久层框架，它专注于简化数据库操作，特别是与SQL查询、存储过程和高级映射相关的任务。该框架的核心理念是消除繁琐的JDBC代码编写，自动管理参数设置和结果集处理，从而提高开发效率。 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

方圆想当图灵

嘿嘿，小赏就行，不赏俺也不争你

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

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

打赏作者

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

抵扣说明：

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

余额充值