Mybatis useGeneratedKeys參數(shù)用法及問題小結(jié)

更新時(shí)間：2022年05月26日 11:31:43 作者：二樓Kirara

這篇文章主要介紹了Mybatis useGeneratedKeys參數(shù)用法及遇到的問題,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

什么是useGeneratedKeys？

官方的說法是該參數(shù)的作用是：“允許JDBC支持自動生成主鍵，需要驅(qū)動兼容”，如何理解這句話的意思？

其本意是說：對于支持自動生成記錄主鍵的數(shù)據(jù)庫，如：MySQL，SQL Server，此時(shí)設(shè)置useGeneratedKeys參數(shù)值為true，在執(zhí)行添加記錄之后可以獲取到數(shù)據(jù)庫自動生成的主鍵ID。

如何使用？

可以通過如下的方式來實(shí)現(xiàn)配置：

配置全局的配置文件
在xml映射器中配置useGeneratedKeys參數(shù)
在接口映射器中設(shè)置useGeneratedKeys參數(shù)

一、配置全局的配置文件

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

文件內(nèi)容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	
	<settings>
		<setting name="cacheEnabled"             value="true" />  <!-- 全局映射器啟用緩存 -->
		<setting name="useGeneratedKeys"         value="true" />  <!-- 允許 JDBC 支持自動生成主鍵 -->
		<setting name="defaultExecutorType"      value="REUSE" /> <!-- 配置默認(rèn)的執(zhí)行器 -->
		<setting name="logImpl"                  value="SLF4J" /> <!-- 指定 MyBatis 所用日志的具體實(shí)現(xiàn) -->
<!--		<setting name="mapUnderscoreToCamelCase" value="true"/> &lt;!&ndash; 駝峰式命名 &ndash;&gt;-->
	</settings>
</configuration>

另外，==在settings元素中設(shè)置的全局useGeneratedKeys參數(shù)對于xml映射器無效==。如果希望在xml映射器中執(zhí)行添加記錄之后返回主鍵ID，則必須在xml映射器中明確設(shè)置useGeneratedKeys參數(shù)值為true。

二、在xml映射器中配置useGeneratedKeys參數(shù)

Mapper.xml 文件

<insert id="addBigdataGroup" parameterType="BigdataGroup" useGeneratedKeys="true" keyProperty="groupId" keyColumn="group_id">
        insert into bigdata_group (
        group_id, group_name, comment, business_line, create_by, remark, create_time)
        values(#{groupId}, #{groupName}, #{comment}, #{businessLine}, #{createBy}, #{remark}, sysdate() );
</insert>

parameterType 傳入?yún)?shù)類型
keyProperty JAVA屬性
keyColumn 數(shù)據(jù)庫字段

xml映射器中配置的useGeneratedKeys參數(shù)只會對xml映射器產(chǎn)生影響，且在settings元素中設(shè)置的全局useGeneratedKeys參數(shù)值對于xml映射器不產(chǎn)生任何作用。

三、在接口映射器中設(shè)置useGeneratedKeys參數(shù)

/設(shè)置useGeneratedKeys為true，返回?cái)?shù)據(jù)庫自動生成的記錄主鍵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);

注意：在接口映射器中設(shè)置的useGeneratedKeys參數(shù)會覆蓋在元素中設(shè)置的對應(yīng)參數(shù)值。

遇到的問題

當(dāng)我配置好獲取主鍵ID后，但是返回的結(jié)果，并沒有如預(yù)期的一樣返回新插入數(shù)據(jù)庫row的主鍵真實(shí)的數(shù)據(jù)。而是1。

代碼如下：

Mybatis層

import java.util.List;
public interface BigdataMapper {
    List<BigdataGroup> 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 id="addBigdataGroup" parameterType="BigdataGroup" useGeneratedKeys="true" keyProperty="groupId" keyColumn="group_id">
        insert into bigdata_group (
        group_id, group_name, comment, business_line, create_by, remark, create_time)
        values(#{groupId}, #{groupName}, #{comment}, #{businessLine}, #{createBy}, #{remark}, sysdate() );
    </insert>

打印結(jié)果

按理說返回結(jié)果應(yīng)該為插入主鍵的真實(shí)數(shù)據(jù)，但是結(jié)果卻是返回是1。

注意：==原來真正的id已經(jīng)被注入到傳參對象的主鍵對應(yīng)屬性里了==，只需要使用插入語句的入?yún)ο蟮膅et方法即可獲取到正確的自增id。

如這邊獲取新增數(shù)據(jù)的主鍵值，那么只需要獲取對象主鍵對應(yīng)的主鍵值就好了。

代碼修改：

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;
    }

觀察結(jié)果：

成功獲取到了結(jié)果！

到此這篇關(guān)于Mybatis useGeneratedKeys參數(shù)用法及遇到的問題的文章就介紹到這了,更多相關(guān)Mybatis useGeneratedKeys參數(shù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: