深入理解MyBatis：如何返回主键ID（注解与XML配置）

于 2024-08-12 06:00:00 发布
阅读量1.7k 收藏 13
点赞数 26
分类专栏： web 文章标签： mybatis xml tomcat
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xycxycooo/article/details/141097192
版权

深入理解MyBatis：如何返回主键ID（注解与XML配置）

在现代的Web应用开发中，MyBatis作为一种持久层框架，广泛应用于数据库操作。在许多场景中，我们需要在插入数据后获取生成的主键ID，以便进行后续操作。本文将深入探讨MyBatis中如何返回主键ID的原理、方法及其应用场景，帮助开发者更好地理解和利用这一功能。

为什么需要返回主键ID？

在数据库操作中，主键ID（Primary Key ID）是一个重要的概念。它通常用于唯一标识一条记录，是数据表中最重要的字段之一。在插入数据后获取生成的主键ID，有以下几个常见的需求：

  1. 关联操作：在插入一条记录后，可能需要立即使用该记录的主键ID进行关联操作。例如，插入用户信息后，需要立即插入用户的详细信息，此时需要用到用户信息表的主键ID。
  2. 日志记录：在插入数据后，可能需要记录操作日志，此时需要用到生成的主键ID。
  3. 缓存管理：在插入数据后，可能需要将数据缓存起来，此时需要用到生成的主键ID作为缓存的键。
MyBatis返回主键ID的原理

MyBatis提供了多种方式来返回插入数据后生成的主键ID。其核心原理是通过数据库的自动生成主键机制，结合MyBatis的配置和API，实现主键ID的获取。

返回主键ID的方法

MyBatis提供了以下几种方法来返回主键ID：

  1. 使用注解方式：通过MyBatis的注解配置，直接在Mapper接口中定义插入方法，并使用@Options注解或@SelectKey注解来返回主键ID。
  2. 使用XML配置方式：通过MyBatis的XML配置文件，定义插入语句，并使用<selectKey>标签或useGeneratedKeys属性来返回主键ID。
方法一：使用注解方式
使用@Options注解

@Options注解可以让MyBatis自动获取生成的主键ID，并将其赋值给参数对象的指定属性。以下是一个示例：

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Options;

public interface UserMapper {

    @Insert("INSERT INTO users (username, email) VALUES (#{username}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);
}

在这个示例中，我们通过@Options注解设置了useGeneratedKeys = true和keyProperty = "id"，让MyBatis自动获取生成的主键ID，并将其赋值给User对象的id属性。

使用@SelectKey注解

@SelectKey注解可以在插入语句执行前后执行一个查询语句，获取生成的主键ID。以下是一个示例：

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.SelectKey;

public interface UserMapper {

    @Insert("INSERT INTO users (username, email) VALUES (#{username}, #{email})")
    @SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "id", before = false, resultType = int.class)
    void insertUser(User user);
}

在这个示例中，我们在插入语句后执行了一个SELECT LAST_INSERT_ID()查询，获取生成的主键ID，并将其赋值给User对象的id属性。

方法二：使用XML配置方式
使用<selectKey>标签

<selectKey>标签可以在插入语句执行前后执行一个查询语句，获取生成的主键ID。以下是一个示例：

<insert id="insertUser" parameterType="User">
    <selectKey keyProperty="id" resultType="int" order="AFTER">
        SELECT LAST_INSERT_ID()
    </selectKey>
    INSERT INTO users (username, email) VALUES (#{username}, #{email})
</insert>

在这个示例中，我们在插入语句后执行了一个SELECT LAST_INSERT_ID()查询，获取生成的主键ID，并将其赋值给User对象的id属性。

使用useGeneratedKeys属性

useGeneratedKeys属性可以让MyBatis自动获取生成的主键ID，并将其赋值给参数对象的指定属性。以下是一个示例：

<insert id="insertUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO users (username, email) VALUES (#{username}, #{email})
</insert>

在这个示例中，我们通过设置useGeneratedKeys="true"和keyProperty="id"，让MyBatis自动获取生成的主键ID，并将其赋值给User对象的id属性。

实际案例分析

为了更好地理解MyBatis返回主键ID的应用，我们来看一个实际的案例：

假设我们正在开发一个电商应用，用户可以浏览商品、下单购买等。我们需要实现一个功能：用户下单后，系统需要生成订单并返回订单ID。

使用注解方式

首先，定义一个订单实体类：

public class Order {
    private int id;
    private String userId;
    private double totalPrice;
    // 其他属性和getter/setter方法
}

然后，定义一个订单Mapper接口：

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Options;
import org.apache.ibatis.annotations.SelectKey;

public interface OrderMapper {

    @Insert("INSERT INTO orders (user_id, total_price) VALUES (#{userId}, #{totalPrice})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void createOrder(Order order);

    @Insert("INSERT INTO orders (user_id, total_price) VALUES (#{userId}, #{totalPrice})")
    @SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "id", before = false, resultType = int.class)
    void createOrderWithSelectKey(Order order);
}

在这个示例中，我们通过@Options注解和@SelectKey注解分别定义了两个插入订单的方法，一个使用@Options注解自动获取主键ID，另一个使用@SelectKey注解手动获取主键ID。

接下来，定义一个Service类，处理下单业务逻辑：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Transactional
    public int createOrder(Order order) {
        orderMapper.createOrder(order);
        return order.getId();
    }

    @Transactional
    public int createOrderWithSelectKey(Order order) {
        orderMapper.createOrderWithSelectKey(order);
        return order.getId();
    }
}

在这个示例中，我们在createOrder方法和createOrderWithSelectKey方法中调用了OrderMapper的相应方法，并返回生成的订单ID。

最后，定义一个Controller类，处理下单请求：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class OrderController {

    @Autowired
    private OrderService orderService;

    @PostMapping("/orders")
    public int createOrder(@RequestBody Order order) {
        return orderService.createOrder(order);
    }

    @PostMapping("/orders/selectKey")
    public int createOrderWithSelectKey(@RequestBody Order order) {
        return orderService.createOrderWithSelectKey(order);
    }
}

在这个示例中，我们通过@PostMapping注解定义了两个POST请求映射，分别调用OrderService的createOrder方法和createOrderWithSelectKey方法生成订单并返回订单ID。

使用XML配置方式

首先，定义一个订单实体类：

public class Order {
    private int id;
    private String userId;
    private double totalPrice;
    // 其他属性和getter/setter方法
}

然后，定义一个订单Mapper接口：

public interface OrderMapper {
    void createOrder(Order order);
    void createOrderWithSelectKey(Order order);
}

接下来，在MyBatis的XML配置文件中定义插入语句：

<insert id="createOrder" parameterType="Order" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO orders (user_id, total_price) VALUES (#{userId}, #{totalPrice})
</insert>

<insert id="createOrderWithSelectKey" parameterType="Order">
    <selectKey keyProperty="id" resultType="int" order="AFTER">
        SELECT LAST_INSERT_ID()
    </selectKey>
    INSERT INTO orders (user_id, total_price) VALUES (#{userId}, #{totalPrice})
</insert>

在这个示例中，我们通过useGeneratedKeys属性和<selectKey>标签分别定义了两个插入订单的语句，一个使用useGeneratedKeys属性自动获取主键ID，另一个使用<selectKey>标签手动获取主键ID。

接下来，定义一个Service类，处理下单业务逻辑：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Transactional
    public int createOrder(Order order) {
        orderMapper.createOrder(order);
        return order.getId();
    }

    @Transactional
    public int createOrderWithSelectKey(Order order) {
        orderMapper.createOrderWithSelectKey(order);
        return order.getId();
    }
}

在这个示例中，我们在createOrder方法和createOrderWithSelectKey方法中调用了OrderMapper的相应方法，并返回生成的订单ID。

最后，定义一个Controller类，处理下单请求：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class OrderController {

    @Autowired
    private OrderService orderService;

    @PostMapping("/orders")
    public int createOrder(@RequestBody Order order) {
        return orderService.createOrder(order);
    }

    @PostMapping("/orders/selectKey")
    public int createOrderWithSelectKey(@RequestBody Order order) {
        return orderService.createOrderWithSelectKey(order);
    }
}

在这个示例中，我们通过@PostMapping注解定义了两个POST请求映射，分别调用OrderService的createOrder方法和createOrderWithSelectKey方法生成订单并返回订单ID。

结论

在MyBatis中返回主键ID是一个常见且重要的需求。通过合理使用注解方式和XML配置方式，可以灵活地实现主键ID的获取。无论是简单的插入操作还是复杂的主键生成逻辑，MyBatis都提供了丰富的选项来满足不同的需求。

通过本文的探讨，希望读者能够对MyBatis返回主键ID的原理和方法有一个更深入的理解，并能够在实际开发中灵活应用这一功能，从而提高数据库操作的效率和质量。

需要重新演唱
关注
专栏目录
MyBatis+MySQL 返回插入的主键ID的方法
08-30
本篇文章主要介绍了MyBatis+MySQL 返回插入的主键ID的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
详解mybatis plus使用insert没有返回主键的处理
09-08
主要介绍了详解mybatis plus使用insert没有返回主键的处理，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
mybatis注解方式插入数据后返回自增主键id
tiantiantbtb的博客
10-18 602
useGeneratedKeys：是否使用生成的密钥，数据库中生成的主键。keyProperty：关键属性名。keyColumn ：关键列名。
在使用MyBatis做持久层时主键
gcy6164的专栏
12-19 121
在使用MyBatis做持久层时，insert语句默认是不返回记录的主键值，而是返回插入的记录条数；如果业务层需要得到记录的主键时，可以通过配置的方式来完成这个功能 针对Sequence主键而言，在执行insert sql前必须指定一个主键值给要插入的记录，如Oracle、DB2，可以采用如下配置方式： SELECT SEQ_TEST.NEXTVAL FROM DUA...
MyBatis主键返回
qq_53843555的博客
10-16 5016
这篇文章介绍了MyBatis的主键返回方法。1.< selectKey >标签,keyProperty：设置为目标属性，resultType：设置返回值类型，order:值为after,before 2.设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置为目标属性就 OK 了 after: sql之后执行，before: sql之前执行
Mybatis的主键返回
最新发布
zyxzyx666的博客
01-03 546
例如：我们在进行一次新增数据库表的操作时，需要同时修改两张表，第二张表中插入的数据中含有第一张表中的主键ID，但是由于整个新增操作还没有完成，所以我们无法get其属性得到第一张表中的新增的数据的主键ID值。在我们新插入一条数据时，我们不需要手动设置其主键id，而让数据库自动生成该条记录的主键id，那么在插入一条记录后，如何得到数据库自动生成的这条记录的主键id呢？属性（作用：它的值是第一张表中我们希望赋值给第二张表中的数据）那么我们该怎么做呢？和keyProperty。
mybatis 主键的返回
Wanger_tt的博客
03-22 1042
简述mybatis主键的返回，根据表中主键是否自增分为两种情况1.在表中主键为自增列主键若在表中为自增项，即主键生成过程为： 向表中插入数据，数据库接到插入信息，根据现有主键值进行自增运算后才可以返回主键所以，我们需要在insert操作之后才可以调用方法返回主键 这个方法就是 SELECT LAST_INSERT_ID();在配置文件中应如下：<selectkey keyProperty="i
Mybatis中如何返回主键值
m0_63949203的博客
09-13 1653
Mapper接口中的抽象方法SQL语句junit测试注意Mybatis是将自增主键的值设置到实体类对象中，而不是以Mapper接口方法返回值的形式返回。
spring-boot-mybatis-interceptor:mybatis自定义主键插件,通过该插件生成分布式唯一雪花ID作为数据库表的主键
05-14
Mybatis自定义插件生成...通过拦截器拦截Mybatis的insert语句,通过自定义注解获取到主键，并为该主键赋值雪花ID,插入数据库中。 2、技术架构 项目总体技术选型 SpringBoot2.1.7 + Mybatis + Maven3.5.4 + Mysql + lom
5.4 如何在Mybatis中使用insert标签并返回主键id？-- 教你通用做法
天罡gg的专栏
04-26 3322
通过 《上文》，我们学会了XML映射文件Mapper的创建，以及最常用的select标签和resultMap标签，本文主要讲解insert标签，用于和insert SQL语句映射，非常简单上手，只有两个点可以扩展讲讲：一个点是insert后返回主键id(会介绍两种方式)，另外一个点是实现批量添加，原本打算一文讲完，但由于合在一起篇幅过长，所以后面再讲批量添加，本文会结合实战案例边做边讲，让你彻底玩转Mybatis insert标签，Let’s Go!创建接口对应的xml映射文件。
最新Mybatis插入数据返回自增主键详细配置
12-14
通过注解或者xml配置无法直接返回自增的主键。Mybatis插入数据返回的自增主键会自动设置为插入对象的属性值，因此我们可以通过获取对象的属性获得自增的主键。 1、通过xml配置获取自增主键 xml配置 select last_...
SQL---mybatis如何返回主键id
IT云清
03-06 1524
使用mybatis时，insert方法如何返回主键？方法一：&lt;insert id="add" parameterType="com.java4all.User"&gt; &lt;selectKey resultType="java.lang.String" order="AFTER" keyProperty="id"&gt; SEL
Mybatis之主键返回
xjszsd的博客
12-13 1556
通常我们会将数据库表的主键id设为自增。在插入一条记录时，我们不设置其主键id，而让数据库自动生成该条记录的主键id，那么在插入一条记录后，如何得到数据库自动生成的这条记录的主键id呢？有两种方式： 使用useGeneratedKeys和keyProperty属性 <insert id="save" parameterType="com.xia.domo.User" useGeneratedKeys="true" keyProperty="id"> insert into u
mybatis 返回主键
wangjun5159的专栏
06-03 4500
mybatis 返回主键
深入浅出mybatis之返回主键ID
weixin_30405421的博客
05-21 204
目录 添加单一记录时返回主键ID 在映射器中配置获取记录主键值 获取新添加记录主键字段值 添加批量记录时返回主键ID 获取主键ID实现原理 添加记录后获取主键ID，这是一个很常见的需求，特别是在一次前端调用中需要插入多个表的场景。 除了添加单条记录时获取主键值，有时候可能需要获取批量添加记录时各记录的主键值，MyBatis从3.3.1版本开始支持批量添加记录并返回各记录主键字段值。 添加...
Mybatis之执行插入语句后返回主键id的三种方式
热门推荐
ldcaws的专栏
08-21 1万+
在工程应用中，通常会遇到多表更新操作，在集成mybatis中需要在执行插入语句后返回主键id进行后续的表更新操作，下面对其实现的方式记录分享出来，以应对不同的应用场景。
MyBatis —— 返回主键值
ruanhao1203的专栏
06-12 8430
目录 1、使用 JDBC 方式返回主键自增的值 2、使用 selectKey 返回主键的值 1、使用 JDBC 方式返回主键自增的值 Mapper.xml 伪代码： <insert id="insert" useGeneratedKeys="true" keyProperty="id"> insert语句 </insert> useGeneratedKeys ...
mybatis插入数据后返回自增主键ID详解
weixin_30484739的博客
07-27 444
1.场景介绍: ​ 开发过程中我们经常性的会用到许多的中间表,用于数据之间的对应和关联.这个时候我们关联最多的就是ID,我们在一张表中插入数据后级联增加到关联表中.我们熟知的mybatis在插入数据后返回的是插入成功的条数,那么这个时候我们想要得到相应的这条新增数据的ID,该怎么办呢? 2.插入数据返回自增主键ID方法(一) 在映射器中配置获取记录主键值 xml映射: 在xml中定义useGe...
mybatis新增返回主键id
07-28
在MyBatis中，有两种方式可以实现在插入数据后返回主键ID的需求。 第一种方式是在XML文件中设置属性。你需要在对应的Mapper接口的insert方法上添加@Options注解，并设置useGeneratedKeys属性为true，keyProperty属性为你想要返回的主键ID字段的名称。例如： ```java @Options(useGeneratedKeys = true, keyProperty = "id") @Insert("INSERT INTO table_name (column1, column2) VALUES (#{value1}, #{value2})") int insertData(Data data); ``` 这样，在插入数据后，你就可以通过data.getId()来获取到返回的主键ID。 第二种方式是使用注解。你可以在对应的Mapper接口的insert方法上添加@SelectKey注解，并设置statement属性为获取自增ID的SQL语句，keyProperty属性为你想要返回的主键ID字段的名称。例如： ```java @SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "id", before = false, resultType = Long.class) @Insert("INSERT INTO table_name (column1, column2) VALUES (#{value1}, #{value2})") int insertData(Data data); ``` 这样，在插入数据后，你同样可以通过data.getId()来获取到返回的主键ID。 需要注意的是，无论是哪种方式，你都需要确保返回的主键ID对应的字段是自增主键，并且在插入数据时，该字段的值为null。另外，如果你使用的是PostgreSQL数据库，可以使用"select currval('sequence_name')"来获取自增ID的值。 #### 引用[.reference_title] - *1* *3* [mybatis插入数据后返回自增主键ID的2种方式](https://blog.csdn.net/lchmyhua88/article/details/125132281)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [Mybatis框架新增数据返回主键id](https://blog.csdn.net/SGdan_qi/article/details/104222696)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

需要重新演唱

你的鼓励将是我创作的最大动力

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

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

打赏作者

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

抵扣说明：

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

余额充值