阅读完需:约 3 分钟
开发过程中我们经常性的会用到许多的中间表,用于数据之间的对应和关联.这个时候我们关联最多的就是ID,我们在一张表中插入数据后级联增加到关联表中.我们熟知的mybatis在插入数据后返回的是插入成功的条数,那么这个时候我们想要得到相应的这条新增数据的ID,该怎么办呢?
xml映射:
在xml中定义useGeneratedKeys
为true
,返回主键id的值,keyProperty
和keyColumn
分别代表数据库记录主键字段和java对象成员属性名
<!-- 插入数据:返回记录主键id值 -->
<insert id="insert" useGeneratedKeys="true" keyProperty="id" keyColumn="id">
insert into stu (name,age) values (#{name},#{age})
</insert>
在xml中 insert 标签中定义 :
-
useGeneratedKeys
为true,用来设置返回主键id的值, -
keyProperty
代表数据库记录主键字段 -
keyColumn
代表 java对象成员属性名
接口映射器
在接口映射器中通过注解@Options
分别设置参数useGeneratedKeys
,keyProperty
,keyColumn
值
// 返回主键字段id值
@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
@Insert("insert into stu (name,age) values (#{name},#{age})")
void insert(Student stu);
获取新添加记录主键字段值
需要注意的是,在MyBatis中添加操作返回的是记录数并非记录主键id。因此,如果需要获取新添加记录的主键值,需要在执行添加操作之后,直接读取Java对象的主键属性。
Integer rows = sqlSession.getMapper(StuMapper.class).insertOneTest(student);
System.out.println("rows = " + rows); // 添加操作返回记录数
System.out.println("id = " + student.getId()); // 执行添加操作之后通过Java对象获取主键属性值
添加批量记录时返回主键ID
如果希望执行批量添加并返回各记录主键字段值,只能在xml映射器中实现,在接口映射器中无法做到。
<!-- 批量添加数据,并返回主键字段 -->
<insert id="insert" useGeneratedKeys="true" keyProperty="id">
insert into stu (name,age) values
<foreach collection="list" separator="," item="t">
(#{t.name},#{t.age})
</foreach>
</insert>
可以看到,执行批量添加并返回记录主键值的xml映射器配置,跟添加单条记录时是一致的。不同的地方仅仅是使用了foreach元素构建批量添加语句。
useGeneratedKeys
在MyBatis中,允许设置名称为“useGeneratedKeys
”参数存在3个位置如下:
- 在
settings
元素中设置useGeneratedKeys
参数 - 在
xml
映射器中设置useGeneratedKeys
参数 - 在接口映射器中设置
useGeneratedKeys
参数
在settings
元素中设置useGeneratedKeys
参数 对于支持自动生成记录主键的数据库,如:MySQL,SQL Server,此时设置useGeneratedKeys
参数值为true
,在执行添加记录之后可以获取到数据库自动生成的主键ID。
使用useGeneratedKeys
生成主键时,不能在DAO层使用@Param注解传递参数,否则无法获取主键。
///Dao层对应的代码 不能使用 @Param注解传递参数
/// Long savNewUser(@Param("user") User user);
Long savNewUser( User user);
///Mapper对应的映射层
<insert id="add" useGeneratedKeys="true" keyProperty="id">
insert into t_user(u_name,u_age) VALUES (#{user.userName},#{user.userAget})
</insert>