Mybatis中如何获取生成的主键

# MyBatis中如何获取生成的主键

## 引言

在数据库操作中，插入数据后获取自动生成的主键是一个常见需求。MyBatis作为流行的ORM框架，提供了多种灵活的方式来实现这一功能。本文将深入探讨MyBatis中获取生成主键的四种主要方式，并通过代码示例详细说明每种方法的适用场景和注意事项。

---

## 一、JDBC方式获取主键（useGeneratedKeys）

这是最直接的方式，利用JDBC的`Statement.RETURN_GENERATED_KEYS`特性。

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

关键参数说明

• useGeneratedKeys="true"：启用JDBC获取主键功能
• keyProperty="id"：将生成的主键值赋给参数对象的id属性

注意事项

1. 仅适用于支持自增主键的数据库（MySQL/SQL Server等）
2. 主键字段必须设置为自增（AUTO_INCREMENT）
3. 返回的主键会自动注入到传入的参数对象中

---

二、<selectKey>标签方式

适用于不支持自增主键的数据库（如Oracle），或需要自定义主键生成规则的场景。

Oracle序列示例

<insert id="insertProduct" parameterType="Product">
    <selectKey keyProperty="id" resultType="long" order="BEFORE">
        SELECT product_seq.nextval FROM dual
    </selectKey>
    INSERT INTO product(id, name) 
    VALUES(#{id}, #{name})
</insert>

MySQL AFTER示例

<insert id="insertOrder" parameterType="Order">
    INSERT INTO orders(total_amount) VALUES(#{totalAmount})
    <selectKey keyProperty="orderId" resultType="long" order="AFTER">
        SELECT LAST_INSERT_ID()
    </selectKey>
</insert>

参数详解

属性	说明
order	BEFORE/AFTER（执行SQL前/后获取）
keyProperty	目标属性名
resultType	主键类型

---

三、注解方式获取主键

在Mapper接口中直接使用注解配置：

@Insert("INSERT INTO employee(name) VALUES(#{name})")
@Options(useGeneratedKeys=true, keyProperty="empId")
int insertEmployee(Employee employee);

适用场景

• 简单SQL语句
• 偏好注解式开发的团队
• 需要与其他注解（如@SelectKey）组合使用

---

四、批量插入获取主键

MyBatis 3.3.1+版本支持批量插入获取主键：

配置示例

<insert id="batchInsert" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO department(dept_name) VALUES
    <foreach collection="list" item="item" separator=",">
        (#{item.deptName})
    </foreach>
</insert>

注意事项

1. 需要数据库驱动支持批量返回主键
2. 主键会按顺序注入到集合元素的对应属性中
3. MySQL需添加rewriteBatchedStatements=true参数

---

五、不同数据库的适配方案

1. MySQL

• 推荐使用useGeneratedKeys
• 批量插入需确认连接参数

2. Oracle

• 必须使用<selectKey>配合序列
• BEFORE模式获取序列值

3. PostgreSQL

• 支持useGeneratedKeys
• 也可使用RETURNING子句：

<insert id="insertPost">
    INSERT INTO post(title) VALUES(#{title})
    RETURNING id
</insert>

---

六、常见问题排查

问题1：主键未正确注入

• 检查keyProperty是否与实体类属性名一致
• 确认数据库确实生成了主键

问题2：批量插入主键错乱

• 确保集合中的对象是可变的
• 检查数据库事务隔离级别

问题3：复合主键处理

<selectKey keyProperty="id1,id2" resultType="map">
    SELECT key1 as id1, key2 as id2 FROM dual
</selectKey>

---

七、性能对比

方式	执行效率	适用场景
useGeneratedKeys	★★★★★	单条插入，自增主键
selectKey BEFORE	★★★☆☆	需要预生成主键的情况
selectKey AFTER	★★☆☆☆	需要插入后获取的场景
批量获取	★★★★☆	大批量数据插入

---

结语

MyBatis提供了灵活的主键获取机制，开发者应根据具体数据库类型和业务场景选择最合适的方式。对于简单的自增主键，useGeneratedKeys是最简洁高效的方案；而对于需要复杂主键生成的场景，<selectKey>标签则提供了更大的灵活性。理解这些技术细节将帮助您编写更健壮的数据访问层代码。

最佳实践建议：在项目文档中明确标注主键生成策略，避免团队成员因使用方式不一致导致的问题。 “`

注：本文实际约1350字，包含： 1. 7个主要章节 2. 5个代码示例 3. 2个对比表格 4. 详细的注意事项说明 5. 不同数据库的适配方案 6. 常见问题排查指南