Mybatis返回主键详解

MTVOL • 2025-04-12 13:00 • 编程

一、Mybatis返回主键介绍

Mybatis是一个持久层框架，负责将Java对象与数据库中的表进行映射关系的创建和维护。通常在开发中，我们会使用Mybatis向数据库插入一行新数据并返回该行数据的主键，以便于后续的操作。在Mybatis中，我们可以使用三种方式返回主键：

二、使用返回主键

在Mybatis中，标签常常用来返回新插入数据的主键。它的使用方法为：


  INSERT INTO user(name, age) VALUES(#{name}, #{age})
  
    SELECT last_insert_id()

这里的selectKey标签定义了在执行insert语句之后，调用SELECT last_insert_id()语句来获取刚插入数据对应的主键。其中，resultType属性指定了返回值类型，keyProperty属性指定了主键所对应的Java对象属性名（这里是id），order属性用来指定执行顺序。如果order属性的值为AFTER，那么标签中的SQL语句会先被执行，再执行标签中的SQL语句。如果order属性的值为BEFORE，那么selectKey标签中的SQL语句会先被执行，再执行标签中的SQL语句。这里需要注意的是，如果使用MySQL数据库，那么使用LAST_INSERT_ID()会得到正确的结果，而其他的情况下，该SQL语句可能会有问题。

三、使用useGeneratedKeys返回主键

在Mybatis 3.3及以上版本中，还提供了另一种方式，即通过useGeneratedKeys返回主键。


  INSERT INTO user(name, age) VALUES(#{name}, #{age})

通过useGeneratedKeys可以告诉Mybatis使用数据库自动生成的主键作为返回结果，而不需要在SQL语句中手动指定主键的值。keyProperty属性还是用来指定主键所对应的Java对象属性名。需要注意的是，在使用useGeneratedKeys的时候，需要指定数据库驱动支持自动生成主键功能。

四、使用返回主键

除了上面两种方式外，还有另一种方式即使用返回主键


  {call insert_user(#{name, jdbcType=VARCHAR, mode=IN}, #{age, jdbcType=INTEGER, mode=IN}, #{id, jdbcType=INTEGER, mode=OUT})}

这种方式下，我们需要定义一个存储过程（这里以MySQL存储过程为例），并使用标签将Java对象与存储过程中的输入、输出参数进行绑定。在使用标签时，需要指定statementType属性为CALLABLE，以便让Mybatis知道应该使用存储过程而不是SQL语句。在执行完存储过程后，Mybatis会将输出参数的值返回给Java对象。

五、总结

在使用Mybatis开发时，返回主键是一个必不可少的功能。本文介绍了使用三种方式实现返回主键的方法，分别是标签、useGeneratedKeys属性和标签。通过了解这些方式，我们可以更加优雅地编写Mybatis的SQL语句和Java代码。

原创文章，作者：MTVOL，如若转载，请注明出处：https://www.506064.com/n/369013.html