Java + Spring Boot + Mybatis 插入数据后，获取自增 id 的方法

BillKu2025-06-09 16:57

在 MyBatis 中使用 useGeneratedKeys="true" 获取新插入记录的自增 ID 值，可通过以下步骤实现：

1. 配置 Mapper XML

在插入语句的 <insert> 标签中设置：

xml

复制

下载

运行

复制代码 
<insert id="insertUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO user(name, email)
    VALUES (#{name}, #{email})
</insert>

  • useGeneratedKeys="true"：启用数据库生成的主键（如自增 ID）。

  • keyProperty="id" ：将生成的主键值赋给参数对象（如 User 对象）的 id 属性。

2. 定义实体类

确保实体类有对应的属性（与 keyProperty 一致）：

java

复制

下载

复制代码 
public class User {
    private Long id; // 属性名必须与 keyProperty 匹配
    private String name;
    private String email;
    
    // Getter & Setter
}

3. 调用 Mapper 方法

插入后，自动填充的 ID 会直接赋给传入的实体对象：

java

复制

下载

复制代码 
User newUser = new User();
newUser.setName("John");
newUser.setEmail("[email protected]");

// 执行插入（返回的是影响行数，非 ID）
int rows = userMapper.insertUser(newUser); 

// 插入后，自增 ID 已注入 newUser 的 id 属性
Long newId = newUser.getId(); // ✅ 直接获取
System.out.println("新记录的 ID：" + newId);

关键点说明

  1. keyProperty 必须匹配实体属性名

    如实体属性为 userId，则需配置 keyProperty="userId"。

  2. 支持批量插入（MyBatis 3.3.1+）

    配置 keyProperty 为集合元素的属性：

    xml

    复制

    下载

    运行

    复制代码 
    <insert id="insertUsers" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO user(name) VALUES 
    <foreach collection="list" item="user" separator=",">
        (#{user.name})
    </foreach>
</insert>

    调用后，每个对象的 id 都会被赋值：

    java

    复制

    下载

    复制代码 
    List<User> users = Arrays.asList(new User("A"), new User("B"));
userMapper.insertUsers(users);
users.forEach(u -> System.out.println(u.getId())); // 输出所有新 ID

  3. 数据库兼容性

    • MySQL/SQL Server：直接支持 useGeneratedKeys。

    • Oracle：需用 <selectKey> 配合序列（非本方案范畴）。

常见问题

  • 获取值为 null？

    检查 keyProperty 是否与实体属性名一致，或数据库是否真的生成了自增 ID。

  • 批量插入无效？

    确保 MyBatis 版本 ≥ 3.3.1，且 keyProperty 指向集合元素的属性（如 id）。

通过此方案，插入后无需额外查询，ID 值直接注入对象属性，高效简洁。

在 MyBatis 中，keyProperty 可以指定为参数对象中的任意属性路径（包括嵌套对象或 Map 的键值），不一定必须是主实体对象的属性。以下是几种灵活用法：

1. 指定参数对象的嵌套属性

若参数是一个包含 ID 容器的复合对象：

java

复制

下载

复制代码 
public class InsertParam {
    private User user;
    private Long generatedId; // 专门接收 ID 的属性
    
    // Getter & Setter
}

Mapper XML 配置：

xml

复制

下载

运行

复制代码 
<insert id="insertUser" parameterType="InsertParam" 
        useGeneratedKeys="true" keyProperty="generatedId">
    INSERT INTO user(name) VALUES (#{user.name})
</insert>

插入后获取：

java

复制

下载

复制代码 
InsertParam param = new InsertParam();
param.setUser(new User("Alice"));
userMapper.insertUser(param);

Long newId = param.getGeneratedId(); // ✅ 从专用属性获取

2. 使用 Map 参数接收

直接通过 Map 传递参数并接收 ID：

xml

复制

下载

运行

复制代码 
<insert id="insertUser" parameterType="map"
        useGeneratedKeys="true" keyProperty="resultId">
    INSERT INTO user(name) VALUES (#{name})
</insert>

Java 调用：

java

复制

下载

复制代码 
Map<String, Object> params = new HashMap<>();
params.put("name", "Bob");

userMapper.insertUser(params);

Long newId = (Long) params.get("resultId"); // ✅ 从 Map 获取

3. 多参数场景（结合 @Param）

当方法有多个参数时，用 @Param 指定命名空间：

java

复制

下载

复制代码 
int insertUser(
    @Param("user") User user,
    @Param("idHolder") Map<String, Long> idHolder // 专门存 ID 的 Map
);

Mapper XML 配置：

xml

复制

下载

运行

复制代码 
<insert id="insertUser" useGeneratedKeys="true" keyProperty="idHolder.id">
    INSERT INTO user(name) VALUES (#{user.name})
</insert>

插入后获取：

java

复制

下载

复制代码 
Map<String, Long> idHolder = new HashMap<>();
User user = new User("Charlie");

userMapper.insertUser(user, idHolder);

Long newId = idHolder.get("id"); // ✅ 从独立 Map 获取

关键规则

  1. 路径匹配原则
    keyProperty 的值是 OGNL 表达式，需严格匹配参数对象的属性路径：

    • 单参数：直接写属性名（如 generatedId）

    • 多参数：用 @Param 别名前缀（如 idHolder.id）

  2. 批量插入场景

    批量操作时 keyProperty 需指向集合元素的属性（不支持外部容器）：

    xml

    复制

    下载

    运行

    复制代码 
    <!-- 正确：ID 注入到每个元素的 id 属性 -->
<insert id="batchInsert" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO user(name) VALUES 
    <foreach item="item" collection="list" separator=",">
        (#{item.name})
    </foreach>
</insert>

  3. 常见问题

    • 属性未注入？ 检查 keyProperty 路径是否存在 setter 方法

    • 返回 null？ 确保数据库自增 ID 已生效（如 MySQL 的 AUTO_INCREMENT）

使用建议

  • 专用 ID 容器 ：推荐用独立 Map 或 DTO 属性接收 ID，避免污染实体对象

  • 明确路径 ：多参数时用 @Param 定义清晰命名空间（如 keyProperty="holder.id"）

  • 事务安全：插入后立即从参数对象中获取 ID，确保在同一事务内

当 Mapper 方法有多个参数时，MyBatis 无法确定将生成的自增 ID 注入到哪个参数中。以下是详细解决方案：

错误原因分析

复制

下载

复制代码 
Cause: org.apache.ibatis.executor.ExecutorException: 
Could not determine which parameter to assign generated keys to.
Note that when there are multiple parameters, 'keyProperty' must include the parameter name

  • 当 Mapper 方法有多个参数时，必须使用 参数名前缀 明确指定注入位置

  • 您当前配置的 keyProperty="generatedId" 缺少参数名前缀

  • MyBatis 找到的可用参数：[generatedId, ckDetailId, param1, param2]

解决方案：添加参数名前缀

方法 1：使用 @Param 注解明确命名参数

java

复制

下载

复制代码 
// Mapper 接口方法
int insertRecord(
    @Param("data") Map<String, Object> data,       // 数据参数
    @Param("idHolder") Map<String, Long> idHolder  // 专门接收ID的参数
);

xml

复制

下载

运行

复制代码 
<!-- Mapper XML 配置 -->
<insert id="insertRecord" useGeneratedKeys="true" 
        keyProperty="idHolder.generatedId">  <!-- 添加参数名前缀 -->
    INSERT INTO your_table(...) 
    VALUES (#{data.field1}, #{data.field2})
</insert>
方法 2：使用 MyBatis 默认参数名（不推荐）

xml

复制

下载

运行

复制代码 
<insert id="insertRecord" useGeneratedKeys="true" 
        keyProperty="param2.generatedId">  <!-- 使用paramN格式 -->
    ...
</insert>

参数索引从1开始：param1=第一个参数, param2=第二个参数

完整示例代码

1. Mapper 接口

java

复制

下载

复制代码 
public interface YourMapper {
    int insertRecord(
        @Param("detail") YourEntity entity,         // 实体参数
        @Param("idHolder") Map<String, Long> holder // ID容器参数
    );
}
2. Mapper XML

xml

复制

下载

运行

复制代码 
<insert id="insertRecord" useGeneratedKeys="true"
        keyProperty="idHolder.generatedId">  <!-- 关键：带前缀的keyProperty -->
    INSERT INTO your_table(name, ck_detail_id)
    VALUES (#{detail.name}, #{detail.ckDetailId})
</insert>
3. 调用代码

java

复制

下载

复制代码 
// 准备参数
YourEntity entity = new YourEntity("test", 1001);
Map<String, Long> idHolder = new HashMap<>();  // 专门接收ID

// 执行插入
mapper.insertRecord(entity, idHolder); 

// 获取自增ID (注意键名与XML中一致)
Long newId = idHolder.get("generatedId"); 
System.out.println("Generated ID: " + newId);

关键注意事项

  1. 前缀必须匹配 @Param 值
    keyProperty="idHolder.generatedId" 对应：

    • idHolder → @Param("idHolder")

    • generatedId → Map中的键名

  2. Map 接收 vs 对象属性

    xml

    复制

    下载

    运行

    复制代码 
    <!-- 如果使用对象属性接收 -->
keyProperty="detail.id"  <!-- 注入到实体对象的id属性 -->

<!-- 如果使用Map接收 -->
keyProperty="idHolder.generatedId"  <!-- 注入到Map的generatedId键 -->

  3. 批量插入特殊处理

    批量操作时仍需注入到集合元素内：

    xml

    复制

    下载

    运行

    复制代码 
    <insert id="batchInsert" useGeneratedKeys="true" keyProperty="id">
    INSERT ... <!-- 无法注入到外部参数 -->
</insert>

常见错误排查

错误现象 解决方案
返回null 检查数据库自增列是否生效
报Invalid bound statement 检查keyProperty前缀是否匹配@Param值
批量插入ID未注入 确保keyProperty指向集合元素的属性
Oracle数据库不生效 需使用<selectKey>替代

建议 ：对多参数场景始终使用 @Param + 前缀的 keyProperty，避免依赖 paramN 隐式命名

相关推荐
stein_java26 分钟前
springMVC-10验证及国际化
java·spring
weixin_4786897629 分钟前
C++ 对 C 的兼容性
java·c语言·c++
LUCIAZZZ1 小时前
HikariCP数据库连接池原理解析
java·jvm·数据库·spring·springboot·线程池·连接池
sky_ph1 小时前
JAVA-GC浅析（二）G1(Garbage First)回收器
java·后端
IDRSolutions_CN2 小时前
PDF 转 HTML5 —— HTML5 填充图形不支持 Even-Odd 奇偶规则？（第二部分）
java·经验分享·pdf·软件工程·团队开发
hello早上好2 小时前
Spring不同类型的ApplicationContext的创建方式
java·后端·架构
HelloWord~3 小时前
SpringSecurity+vue通用权限系统2
java·vue.js
让我上个超影吧3 小时前
黑马点评【基于redis实现共享session登录】
java·redis
全栈凯哥4 小时前
Java详解LeetCode 热题 100(26):LeetCode 142. 环形链表 II（Linked List Cycle II）详解
java·算法·leetcode·链表
热门推荐
01【图像处理与机器视觉】XJTU期末考点02从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑03KGG转MP3工具|非KGM文件|解密音频04海康Visionmaster-常见问题排查方法-启动阶段05YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】06【SpeedAI科研小助手】2分钟极速解决知网维普重复率、AIGC率过高，一键全文降！文件格式不变，公式都保留的！07Coze扣子平台完整体验和实践（附国内和国际版对比）08DeepSeek各版本说明与优缺点分析09VMware虚拟机安装Win7专业版保姆级教程（附镜像包）10R-tree详解