Mybatis useGeneratedKeys參數用法及問題小結

Posted on by

什麼是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參數內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：