Mybatis useGeneratedKeys引數用法及問題小結

2022-05-26 14:01:04

什麼是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

檔案內容如下：

<?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" /> <!-- 設定預設的執行器 -->
		<setting name="logImpl"                  value="SLF4J" /> <!-- 指定 MyBatis 所用紀錄檔的具體實現 -->
<!--		<setting name="mapUnderscoreToCamelCase" value="true"/> &lt;!&ndash; 駝峰式命名 &ndash;&gt;-->
	</settings>
</configuration>

另外，==在settings元素中設定的全域性useGeneratedKeys引數對於xml對映器無效==。如果希望在xml對映器中執行新增記錄之後返回主鍵ID，則必須在xml對映器中明確設定useGeneratedKeys引數值為true。

二、在xml對映器中設定useGeneratedKeys引數

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 傳入引數型別
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<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>

列印結果

按理說返回結果應該為插入主鍵的真實資料，但是結果卻是返回是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;
    }

觀察結果：

成功獲取到了結果！

到此這篇關於Mybatis useGeneratedKeys引數用法及遇到的問題的文章就介紹到這了,更多相關Mybatis useGeneratedKeys引數內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！