您的位置:

Mybatis新增数据返回id详解

一、Mybatis如何返回新增数据的主键id

Mybatis是一种基于Java语言的持久层框架,它提供了一种方便、快捷的方式来与数据库进行交互。在进行数据库操作时,我们经常会遇到一种需求:新增数据后需要获取该数据的自增id。Mybatis如何满足这一需求呢?

在Mybatis中,当执行insert语句后,我们可以通过 标签来获取新插入记录的id值,它有以下两种配置方式:

1、useGeneratedKeys

使用useGeneratedKeys配置可以使用数据库厂商的自增字段返回策略来产生主键。在statement标签中,添加useGeneratedKeys="true"和keyProperty属性即可返回主键。

// mapper.xml配置文件
<insert id="addUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
  INSERT INTO user(name) VALUES(#{name})
</insert>

// 使用方式
User user = new User("Tom");
userMapper.addUser(user);
Long id = user.getId();

2、selectKey

使用selectKey标签,需要设置keyProperty、resultType、order(在什么时候执行)、pre、post等属性。通过配置产生一个独立的sql语句来返回新的主键。

// mapper.xml配置文件
<insert id="addUser" parameterType="User">
  <selectKey keyProperty="id" resultType="int" order="AFTER">
    SELECT LAST_INSERT_ID()
  </selectKey>
  INSERT INTO user(name) VALUES(#{name})
</insert>

// 使用方式
User user = new User("Tom");
userMapper.addUser(user);
Long id = user.getId();

二、Mybatis如何支持批量插入并返回主键id

Mybatis提供了batch插入数据的方式,这种方式可以一次性向数据库插入多条数据,提高了数据库操作的效率。但是,在批量插入数据时,返回主键id的需求并没有得到完美的解决。Mybatis官方文档给出的建议是:使用SELECT LAST_INSERT_ID()或者SELECT SCOPE_IDENTITY()(具体使用方法同上)。

// mapper.xml配置文件
<insert id="batchInsertUser" parameterType="java.util.List">
  <selectKey keyProperty="id" resultType="int" order="AFTER">
    SELECT LAST_INSERT_ID()
  </selectKey>
  INSERT INTO user(name) VALUES
  <foreach collection="list" item="item" index="index" separator=",">
    (#{item.name})
  </foreach>
</insert>

// 使用方式
List<User> list = new ArrayList<>();
list.add(new User("Tom"));
list.add(new User("Jerry"));
userMapper.batchInsertUser(list);
Long id1 = list.get(0).getId();
Long id2 = list.get(1).getId();

三、Mybatis插入数据返回非自增主键id的方法

有些时候,我们需要插入的数据主键并不是使用数据库自增值。这时我们可以在Java代码中手动设置主键值,然后在insert语句中将主键值确定即可。

// mapper.xml配置文件
<insert id="addBook" parameterType="Book">
    INSERT INTO book(id, title, author) VALUES(#{id}, #{title}, #{author})
</insert>

// 使用方式
Book book = new Book(123456L, "Mybatis详解", "Tom");
bookMapper.addBook(book);
Long id = book.getId();

在这种情况下,我们必须手动给实体类中的主键id属性设置值。如果想要跟mybatis类似,自动生成对应id的话,我们可以使用UUID.randomUUID().toString()方法来生成一个随机的字符串:

Book book = new Book(UUID.randomUUID().toString(), "Mybatis详解", "Tom");
bookMapper.addBook(book);
String id = book.getId();

四、总结

通过本文的介绍,我们对Mybatis如何返回新增数据的主键id有了清晰的认识。在具体使用时,根据不同的需求选择不同的方式,实现新增数据后的主键id获取。同时,也要注意批量新增数据时返回主键id的问题,需要使用上述特殊的方案来解决。最后,对于需要插入非自增主键id的情况,我们需要在Java代码中手动设置主键值,并在mapper.xml文件中加入对应的配置。