Mybatis?useGeneratedKeys參數怎么使用

這篇文章主要介紹了Mybatis useGeneratedKeys參數怎么使用的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇Mybatis 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

文件內容如下：

<?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參數怎么使用”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。