MyBatis-Plus中如何使用ResultMap

最新推荐文章于 2025-05-15 15:45:46 发布
最新推荐文章于 2025-05-15 15:45:46 发布
阅读量6.9k 收藏 10
点赞数 3
分类专栏： 程序员 编程 java 文章标签： mybatis java 数据库
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Java_zhujia/article/details/127747543
版权
本文详细介绍了如何在 MyBatis-Plus 中使用 ResultMap 来解决自定义 SQL 查询时实体类属性映射的问题，并提供了一种通过自定义 @AutoResultMap 注解自动构建 resultMap 的解决方案。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

MyBatis-Plus （简称MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。

MyBatis-Plus对MyBatis基本零侵入，完全可以与MyBatis混合使用，这点很赞。

在涉及到关系型数据库增删查改的业务时，我比较喜欢用MyBatis-Plus，开发效率极高。具体的使用可以参考官网，或者自己上手摸索感受一下。

下面简单总结一下在MyBatis-Plus中如何使用ResultMap。

问题说明#

先看个例子：

有如下两张表：

create table tb_book
(
    id     bigint primary key,
    name   varchar(32),
    author varchar(20)
);

create table tb_hero
(
    id      bigint primary key,
    name    varchar(32),
    age     int,
    skill   varchar(32),
    bid bigint
);

其中，tb_hero中的bid关联tb_book表的id。

下面先看Hero实体类的代码，如下：

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@TableName("tb_hero")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Hero {

    @TableId("id")
    private Long id;

    @TableField(value = "name", keepGlobalFormat = true)
    private String name;

    @TableField(value = "age", keepGlobalFormat = true)
    private Integer age;

    @TableField(value = "skill", keepGlobalFormat = true)
    private String skill;

    @TableField(value = "bid", keepGlobalFormat = true)
    private Long bookId;

    // *********************************
    // 数据库表中不存在以下字段(表join时会用到)
    // *********************************

    @TableField(value = "book_name", exist = false)
    private String bookName;

    @TableField(value = "author", exist = false)
    private String author;
}

注意了，我特地把tb_hero表中的bid字段映射成实体类Hero中的bookId属性。

  • 测试BaseMapper中内置的insert()方法或者IService中的save()方法

MyBatis-Plus打印出的SQL为：

==> Preparing: INSERT INTO tb_hero ( id, "name", "age", "skill", "bid" ) VALUES ( ?, ?, ?, ?, ? )
==> Parameters: 1589788935356416(Long), 阿飞(String), 18(Integer), 天下第一快剑(String), 1(Long)

没毛病， MyBatis-Plus会根据@TableField指定的映射关系，生成对应的SQL。

  • 测试BaseMapper中内置的selectById()方法或者IService中的getById()方法

MyBatis-Plus打印出的SQL为：

==> Preparing: SELECT id,"name","age","skill","bid" AS bookId FROM tb_hero WHERE id=?
==> Parameters: 1(Long)

也没毛病，可以看到生成的SELECT中把bid做了别名bookId。

  • 测试自己写的SQL

比如现在我想连接tb_hero与tb_book这两张表，如下：

@Mapper
@Repository
public interface HeroMapper extends BaseMapper<Hero> {
    @Select({"SELECT tb_hero.*, tb_book.name as book_name, tb_book.author" +
            " FROM tb_hero" +
            " LEFT JOIN tb_book" +
            " ON tb_hero.bid = tb_book.id" +
            " ${ew.customSqlSegment}"})
    IPage<Hero> pageQueryHero(@Param(Constants.WRAPPER) Wrapper<Hero> queryWrapper,
                              Page<Hero> page);
}

查询MyBatis-Plus打印出的SQL为：

==> Preparing: SELECT tb_hero.*, tb_book.name AS book_name, tb_book.author FROM tb_hero LEFT JOIN tb_book ON tb_hero.bid = tb_book.id WHERE ("bid" = ?) ORDER BY id ASC LIMIT ? OFFSET ?
==> Parameters: 2(Long), 1(Long), 1(Long)

 

SQL没啥问题，过滤与分页也都正常，但是此时你会发现bookId属性为null，如下：

为什么呢？

调用BaseMapper中内置的selectById()方法并没有出现这种情况啊？？？

回过头来再对比一下在HeroMapper中自己定义的查询与MyBatis-Plus自带的selectById()有啥不同，还记得上面的刚刚的测试吗，生成的SQL有啥不同？

原来，MyBatis-Plus为BaseMapper中内置的方法生成SQL时，会把SELECT子句中bid做别名bookId，而自己写的查询MyBatis-Plus并不会帮你修改SELECT子句，也就导致bookId属性为null。

解决方法#

  • 方案一：表中的字段与实体类的属性严格保持一致(字段有下划线则属性用驼峰表示)

在这里就是tb_hero表中的bid字段映射成实体类Hero中的bid属性。这样当然可以解决问题，但不是本篇讲的重点。

  • 方案二：把自己写的SQL中bid做别名bookId
  • 方案三：使用@ResultMap，这是此篇的重点

在@TableName设置autoResultMap = true

@TableName(value = "tb_hero", autoResultMap = true)
public class Hero {
    
}

然后在自定义查询中添加@ResultMap注解，如下：

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.ResultMap;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Repository;

@Mapper
@Repository
public interface HeroMapper extends BaseMapper<Hero> {
    @ResultMap("mybatis-plus_Hero")
    @Select({"SELECT tb_hero.*, tb_book.name as book_name, tb_book.author" +
            " FROM tb_hero" +
            " LEFT JOIN tb_book" +
            " ON tb_hero.bid = tb_book.id" +
            " ${ew.customSqlSegment}"})
    IPage<Hero> pageQueryHero(@Param(Constants.WRAPPER) Wrapper<Hero> queryWrapper,
                              Page<Hero> page);
}

这样，也能解决问题。

下面简单看下源码，@ResultMap("mybatis-plus_实体类名")怎么来的。

详情见：
com.baomidou.mybatisplus.core.metadata.TableInfo#initResultMapIfNeed()

/**
 * 自动构建 resultMap 并注入(如果条件符合的话)
 */
void initResultMapIfNeed() {
    if (autoInitResultMap && null == resultMap) {
        String id = currentNamespace + DOT + MYBATIS_PLUS + UNDERSCORE + entityType.getSimpleName();
        List<ResultMapping> resultMappings = new ArrayList<>();
        if (havePK()) {
            ResultMapping idMapping = new ResultMapping.Builder(configuration, keyProperty, StringUtils.getTargetColumn(keyColumn), keyType)
                .flags(Collections.singletonList(ResultFlag.ID)).build();
            resultMappings.add(idMapping);
        }
        if (CollectionUtils.isNotEmpty(fieldList)) {
            fieldList.forEach(i -> resultMappings.add(i.getResultMapping(configuration)));
        }
        ResultMap resultMap = new ResultMap.Builder(configuration, id, entityType, resultMappings).build();
        configuration.addResultMap(resultMap);
        this.resultMap = id;
    }
}

注意看上面的字符串id的构成，你应该可以明白。

思考： 这种方式的ResultMap默认是强绑在一个@TableName上的，如果是某个聚合查询或者查询的结果并非对应一个真实的表怎么办呢？有没有更优雅的方式？

自定义@AutoResultMap注解#

基于上面的思考，我做了下面简单地实现：

  • 自定义@AutoResultMap注解
import java.lang.annotation.*;

/**
 * 使用@AutoResultMap注解的实体类
 * 自动生成{auto.mybatis-plus_类名}为id的resultMap
 * {@link MybatisPlusConfig#initAutoResultMap()}
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface AutoResultMap {

}
  • 启动时扫描@AutoResultMap注解的实体类
package com.bytesfly.mybatis.config;

import cn.hutool.core.util.ClassUtil;
import cn.hutool.core.util.ReflectUtil;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.baomidou.mybatisplus.core.metadata.TableInfoHelper;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.toolkit.JdbcUtils;
import com.bytesfly.mybatis.annotation.AutoResultMap;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.builder.MapperBuilderAssistant;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import javax.annotation.PostConstruct;
import java.util.Set;

/**
 * 可添加一些插件
 */
@Configuration
@EnableTransactionManagement(proxyTargetClass = true)
@MapperScan(basePackages = "com.bytesfly.mybatis.mapper")
@Slf4j
public class MybatisPlusConfig {

    @Autowired
    private SqlSessionTemplate sqlSessionTemplate;

    /**
     * 分页插件(根据jdbcUrl识别出数据库类型, 自动选择适合该方言的分页插件)
     * 相关使用说明: https://baomidou.com/guide/page.html
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(DataSourceProperties dataSourceProperties) {

        String jdbcUrl = dataSourceProperties.getUrl();
        DbType dbType = JdbcUtils.getDbType(jdbcUrl);

        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(dbType));
        return interceptor;
    }

    /**
     * @AutoResultMap注解的实体类自动构建resultMap并注入
     */
    @PostConstruct
    public void initAutoResultMap() {
        try {
            log.info("--- start register @AutoResultMap ---");

            String namespace = "auto";

            String packageName = "com.bytesfly.mybatis.model.db.resultmap";
            Set<Class<?>> classes = ClassUtil.scanPackageByAnnotation(packageName, AutoResultMap.class);

            org.apache.ibatis.session.Configuration configuration = sqlSessionTemplate.getConfiguration();

            for (Class clazz : classes) {
                MapperBuilderAssistant assistant = new MapperBuilderAssistant(configuration, "");
                assistant.setCurrentNamespace(namespace);
                TableInfo tableInfo = TableInfoHelper.initTableInfo(assistant, clazz);

                if (!tableInfo.isAutoInitResultMap()) {
                    // 设置 tableInfo的autoInitResultMap属性 为 true
                    ReflectUtil.setFieldValue(tableInfo, "autoInitResultMap", true);
                    // 调用 tableInfo#initResultMapIfNeed() 方法，自动构建 resultMap 并注入
                    ReflectUtil.invoke(tableInfo, "initResultMapIfNeed");
                }
            }

            log.info("--- finish register @AutoResultMap ---");
        } catch (Throwable e) {
            log.error("initAutoResultMap error", e);
            System.exit(1);
        }
    }
}

关键代码其实没有几行，耐心看下应该不难懂。

  • 使用@AutoResultMap注解

还是用例子来说明更直观。

下面是一个聚合查询：

@Mapper
@Repository
public interface BookMapper extends BaseMapper<Book> {

    @ResultMap("auto.mybatis-plus_BookAgg")
    @Select({"SELECT tb_book.id, max(tb_book.name) as name, array_agg(distinct tb_hero.id order by tb_hero.id asc) as hero_ids" +
            " FROM tb_hero" +
            " INNER JOIN tb_book" +
            " ON tb_hero.bid = tb_book.id" +
            " GROUP BY tb_book.id"})
    List<BookAgg> agg();
}

其中BookAgg的定义如下，在实体类上使用了@AutoResultMap注解：

@Getter
@Setter
@NoArgsConstructor
@AutoResultMap
public class BookAgg {

    @TableId("id")
    private Long bookId;

    @TableField("name")
    private String bookName;

    @TableField("hero_ids")
    private Object heroIds;
}
【SpringBoot】26、SpringBoot中整合MyBatis-Plus实现数据库操作
Asurplus
07-23 21万+
MyBatis 框架相信大家都用过，虽然 MyBatis 可以直接在 xml 中通过 SQL 语句操作数据库，很是灵活。但正其操作都要通过 SQL 语句进行，就必须写大量的 xml 文件，很是麻烦。于是 MyBatis-Plus 应运而生，作为 MyBatis 的增强工具，更是为我们开发效率得到了质的飞跃。 一、简介 1、MyBatis MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBa
Java 领域 MyBatis 与 MyBatis-Plus 的比较
Java技术栈实战开发的博客
04-18 843
本文的目的是全面、深入地比较 Java 领域中的 MyBatis 和 MyBatis-Plus 框架。通过对这两个框架的核心概念、使用方法、性能特点等多方面进行详细分析，为 Java 开发者在选择合适的持久层框架时提供参考依据。范围涵盖了从基础概念的讲解到实际项目中的应用，以及未来发展趋势的探讨。本文将按照以下结构进行组织：首先介绍 MyBatis 和 MyBatis-Plus 的核心概念和联系，包括它们的原理和架构；接着详细讲解它们的核心算法原理和具体操作步骤，并给出相应的 Python 源代码示例；
Mybatis-plus：单表使用关联查询+ResultMap结果映射
a898712940的博客
07-29 2665
Mybatis-plus：单表使用关联查询+ResultMap结果映射一：数据表与实体类二：mapper与mapper.xml三：service四：控制器五：返回结果 一：数据表与实体类 数据表 DROP TABLE IF EXISTS `security_edu_info_type`; CREATE TABLE `security_edu_info_type` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `keyName` char(12) DEFAULT
MybatisPlus 使用resultMap
Xiaosi_lemon的博客
11-26 1568
MybtatisPlus 使用resultMap 基于springboot
MyBatis-Plus 映射配置详解（含数据库表、实体类、配置），resultMap，association，collection，n+1，一对一，一对多，嵌套查询，嵌套结果
最新发布
Aric_Jones的博客
05-15 905
本文详细介绍了 MyBatis-Plus 的映射配置，涵盖了数据库表设计、实体类定义、MyBatis 配置、XML 映射参数详解，以及一对一、一对多关系的处理方式。首先，通过 SQL 语句创建了用户表、用户详情表和订单表，并定义了对应的实体类。接着，配置了 MyBatis-Plus 的驼峰映射和基础 Mapper。在 XML 映射配置部分，详细讲解了基础 resultMap 和包含一对一、一对多关系的完整 resultMap，并提供了嵌套结果和嵌套查询两种方式的 SQL 配置。最后，文章解释了 N+1 查询
mybaits-plus的resultMap简单使用
热门推荐
dsl
08-11 1万+
为什么在mapper.xml使用resultMap标签 如果查询出来的一个字段和pojo对象里边的属性不一致，那么用来接收查询出来的result对应的数据将会是Null，如果不使用resultMap，那么一般为了避免pojo对象对应的属性为Null，会采用SQL语句中的别名，将查询出的数据库中的字段as pojo对象属性，而且，resultMap支持延迟加载 但是为了避免sql语句看着臃肿，所以就使用了resultMap 简...
MyBatisPlus 中的 resultMap 使用
weixin_32196893的博客
08-03 1250
想让数据库返回 SkuItemSaleAttrVo 实体数据 @ToString @Data public class SkuItemSaleAttrVo { private Long attrId; private String attrName; private List<AttrValueWithSkuIdVo> attrValues; } @Data @ToString public class AttrValueWithSkuIdVo { pr..
改造Mybatis-plus逻辑删除（附带mybatis-plus部分源码解读）
qq_25156781的博客
12-05 1181
AbstractMethod该抽象类是其他增删改查 method的模板抽象父类。/*** EntityWrapper方式获取select where* @param newLine 是否提到下一行* @param table 表信息*/true);//
MyBatis-Plus中的@TableName注解：全面解析与实战指南
xycxycooo的博客
08-31 3511
TableName注解是MyBatis-Plus中非常重要的一个注解，通过它，MyBatis-Plus可以自动识别实体类与数据库表之间的映射关系。本文详细讲解了@TableName注解的基本属性、使用方式、动态表名支持及全局配置，并通过丰富的代码示例帮助你全面理解其工作机制。希望本文能帮助你更好地使用MyBatis-Plus，提高开发效率。如果你有任何问题或建议，欢迎在评论区留言讨论。
【SpringBoot】95、SpringBoot中使用MyBatis-Plus实现自动加密存储和查询自动解密
Asurplus
07-11 1266
有的业务需要将敏感数据加密存储到 DB，如果我们每个都手动去加密，再设值，再保存 DB，不仅麻烦，还对每个开发者不友好，在 MyBatis-Plus 中我们可以使用 BaseTypeHandler 来解决这个问题
MyBatis-Plus 查询返回实体对象还是map
09-07
主要介绍了MyBatis-Plus 查询返回实体对象还是map，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Mybatis-plus resultMap结果集映射
一个搬砖工人
07-08 6178
1实体类 package com.zs.testmybatisplus.entity; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** * @author miemie * @since 2019-11-27 */ @Data @TableName(autoResultMap =.
MybatisPlus二级映射和关联对象ResultMap
m0_51390969的博客
01-27 1654
在我们的教程中，我们设计了一个课程内容的数据结构，包含章节和相关资源。这种结构非常适合在线教育平台或电子学习系统，其中课程内容需要被组织成不同的章节和子章节，每个子章节可能关联特定的学习资源。这将是一个很好的示例来展示 MyBatis 中如何使用一对多（）和一对一（）映射。
mybatis mybatis-plus resultMap 实现多表联查
weixin_51751186的博客
03-08 2030
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录前言一、观察数据库二、观察实体类2.在mapper层定义方法（根据deptno查询dept和其外键关联的表test）3 在xml中实现该方法总结 前言 提示：这里可以添加本文要记录的大概内容： 例如：随着人工智能的不断发展，机器学习这门技术也越来越重要，很多人都开启了学习机器学习，本文就介绍了机器学习的基础内容。 提示：以下是本篇文章正文内容，下面案例可供参考 一、观察数据库 二、观察实体类 User 是 dept表实体类 .
springboot中mybatis-plus的resultMap和resultType踩坑
m0_73612074的博客
05-05 732
6、别人的项目没有明确的写配置把驼峰转化关了也能正常查询，可能是别人版本的问题，应该是我的版本会自动开启下划线转驼峰，这个问题困扰几天了，发出来让大家避避坑。2、但是当我使用resultType的时候，发现查询不到数据了，这时候我是不知道驼峰转换的，因为我看别人的项目也没有加其他的配置。3、然后我找网上的方法试了试，把实体类的下划线去掉，发现可以查询出数据，就觉得很神奇。1、使用resultMap的时候，绑定了映射关系，这样查询是正常的。4、我查了查驼峰转换的知识。
基于mybatisplus扫描实体类自动生成resultmap，自动填充多个主键
thethefighter的专栏
12-04 7337
在xml中编写resultmap是件头痛的事，特别是表连接时返回的对象是多样的，如果不按照map返回，分别建resultmap工作量会翻倍。 使用mybatisplus-plus的@AutoMap注解entity实体类，就可以在应用启动时解析使用@TableField注解的字段，自动生成scan.mybatis-plus_xxxx为id的resultMap 可以在xml中直接配置使用这个resultMap实例 并且还支持继承关系，扫描实体子类会附加上父类的字段信息一起构建子类的resultmap 对于各种表
mybatis/mybatisplus的resultMap/动态sql的xml和lambda/代码生成器使用/逻辑删除/多数据源/全局配置/sql拦截器和多租户含代码案例
qq_44501608的博客
03-27 1187
本文可以一次性学习和理解mybatis和mybatisplus 的开发细节包括resultMap封装动态sqllambda语法以及mp的高阶实战等等
清晰的解释 mybatisplus中resultType与resultMap的区别
Obscurede的博客
04-23 1211
结论：resultType与resultMap都可以用于接收mybatisplus中select的查询结果，
mybatis-plus中resultMap
05-12
MyBatis-Plus 是一个 MyBatis 的增强工具，它提供了一系列增强功能来简化 MyBatis 的使用。其中之一就是提供了一个比 MyBatis 更加方便的结果映射方式，就是通过 `ResultMap`。 `ResultMap` 是 MyBatis 提供的结果映射器，它可以将数据库查询返回的结果映射成 Java 对象。MyBatis-Plus 的 `ResultMap` 功能就是在 MyBatis 的 `ResultMap` 基础上进行的增强。 在 MyBatis-Plus 中，我们可以通过 `@TableName` 注解来指定实体类和数据库表的映射关系，然后使用 `@TableField` 注解来指定实体类中的属性和数据库表中的字段的映射关系。 使用 MyBatis-Plus 的 `ResultMap` 功能时，我们只需要在实体类中定义一个 `ResultMap`，然后在查询语句中使用该 `ResultMap` 即可将查询结果映射成 Java 对象。 以下是一个使用 MyBatis-Plus `ResultMap` 的示例： ```java @TableName("user") public class User { @TableId(value = "id", type = IdType.AUTO) private Long id; @TableField("username") private String username; @TableField("password") private String password; // getter 和 setter 省略 } // 定义 ResultMap private static final ResultMap USER_RESULT_MAP = new ResultMap.Builder(configuration, "userResultMap", User.class, new ArrayList<ResultMapping>()) .id(new ResultMapping.Builder(configuration, "id", "id", Long.class).build()) .result(new ResultMapping.Builder(configuration, "username", "username", String.class).build()) .result(new ResultMapping.Builder(configuration, "password", "password", String.class).build()) .build(); // 使用 ResultMap 查询 List<User> userList = sqlSession.selectList("com.example.mapper.UserMapper.selectUserList", null, new RowBounds(0, 10), USER_RESULT_MAP); ``` 在上面的示例中，我们首先使用 `@TableName` 和 `@TableField` 注解指定了实体类和数据库表之间的映射关系。然后我们定义了一个 `ResultMap`，并在其中指定了实体类中的属性和数据库表中的字段的映射关系。最后我们在查询语句中使用该 `ResultMap` 将查询结果映射成 Java 对象。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值