Mybatis useGeneratedKeys参数用法及问题小结

Mybatis useGeneratedKeys参数用法及问题小结

目录什么是useGeneratedKeys？如何使用？一、配置全局的配置文件二、在xml映射器中配置useGeneratedKeys参数三、在接口映射器中设置useGeneratedKeys参数遇到的问题

什么是useGeneratedKeys？

官方的说法是该参数的作用是：“允许JDBC支持自动生成主键，需要驱动兼容”，如何理解这句话的意思？

其本意是说：对于支持自动生成记录主键的数据库，如：mysql，SQL Server，此时设置useGeneratedKeys参数值为true，在执行添加记录之后可以获取到数据库自动生成的主键ID。

如何使用？

可以通过如下的方式来实现配置：

配置全局的配置文件在xml映射器中配置useGeneratedKeys参数在接口映射器中设置useGeneratedKeys参数

一、配置全局的配置文件

application.yml 配置文件

# MyBatis配置

mybatis:

# 搜索指定包别名

typeAliasesPackage: com.ruoyi.**.domain

# 配置mapper的扫描，找到所有的mapper.xml映射文件

mapperLocations: classpath*:mapper/**/*Mapper.xml

# 加载全局的配置文件

configLocation: classpath:mybatis/mybatis-config.xml

配置mybatis config文件

3. mybatis-config.xml

文件内容如下：

PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-config.dtd">

另外，==在settings元素中设置的全局useGeneratedKeys参数对于xml映射器无效==。如果希望在xml映射器中执行添加记录之后返回主键ID，则必须在xml映射器中明确设置useGeneratedKeys参数值为true。

二、在xml映射器中配置useGeneratedKeys参数

Mapper.xml 文件

insert into bigdata_group (

group_id, group_name, comment, business_line, create_by, remark, create_time)

values(#{groupId}, #{groupName}, #{comment}, #{businessLine}, #{createBy}, #{remark}, sysdate() );

parameterType 传入参数类型keyProperty java属性keyColumn 数据库字段

xml映射器中配置的useGeneratedKeys参数只会对xml映射器产生影响，且在settings元素中设置的全局useGeneratedKeys参数值对于xml映射器不产生任何作用。

三、在接口映射器中设置useGeneratedKeys参数

/设置useGeneratedKeys为true，返回数据库自动生成的记录主键id

@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")

@Insert("insert into test(name,descr,url,create_time,update_time) values(#{name},#{descr},#{url},now(),now())")

Integer insertOneTest(Test test);

注意： 在接口映射器中设置的useGeneratedKeys参数会覆盖在元素中设置的对应参数值。

遇到的问题

当我配置好获取主键ID后，但是返回的结果，并没有如预期的一样返回新插入数据库row的主键真实的数据。而是1。

代码如下：

Mybatis层

import java.util.List;

public interface BigdataMapper {

List getBigdataGroup();

int addBigdataGroup(BigdataGroup bigdataGroup);

}

service层

public int addBigdataGroup(BigdataGroup bigdataGroup) {

bigdataGroup.setCreateBy(SecurityUtils.getUsername());

int update = bigdataMapper.addBigdataGroup(bigdataGroup);

log.info("update: {}", update);

return update;

}

xml文件

insert into bigdata_group (

group_id, group_name, comment, business_line, create_by, remark, create_time)

values(#{groupId}, #{groupName}, #{comment}, #{businessLine}, #{createBy}, #{remark}, sysdate() );

打印结果

按理说返回结果应该为插入主键的真实数据，但是结果却是返回是1。

注意：==原来真正的id已经被注入到传参对象的主键对应属性里了==，只需要使用插入语句的入参对象的get方法即可获取到正确的自增id。

如这边获取新增数据的主键值，那么只需要获取对象主键对应的主键值就好了。

代码修改：

public int addBigdataGroup(BigdataGroup bigdataGroup) {

bigdataGroup.setCreateBy(SecurityUtils.getUsername());

int update = bigdataMapper.addBigdataGroup(bigdataGroup);

log.info("update: {}", update);

// 新增如下代码

int group_id = bigdataGroup.getGroupId();

log.info("group_id: {}", group_id);

// 到此为止

return update;

}

观察结果：

成功获取到了结果！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。