快捷導(dǎo)航

Mybatis新增數(shù)據(jù)并返回主鍵id的兩種方法實現(xiàn)

更新時間：2025年02月12日 10:33:07 作者：愛吃蜂蜜的王

本文主要介紹了Mybatis新增數(shù)據(jù)并返回主鍵id的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

我們在開發(fā)過程中有時可能會有這樣的場景，新增數(shù)據(jù)并返回新增行的主鍵id值，這個場景很簡單，常規(guī)操作是在新增數(shù)據(jù)成功后，在訪問數(shù)據(jù)庫查詢一次，這樣雖然能解決問題，但是寫在業(yè)務(wù)中感覺怪怪的，其實在Mybatis中，它就考慮到了這個場景，那下面我們就展開講解哈。

注意：useGeneratedKeys 可以設(shè)置全局配置項開啟，建議不全局開啟，那個地方使用就在那地方手動配置。

keyProperty 屬性必須開發(fā)者處理，且要么都是基于XML配置，要么都是注解（@Insert+@Options），不能XML與注解混用。

一、常規(guī)使用（具有自增主鍵的數(shù)據(jù)庫）

1、基于配置（XML）

a）在mapper.xml配置中<insert> 標(biāo)簽中添加兩個屬性。

useGeneratedKeys：開啟返回主鍵id
keyProperty：指定主鍵id值存放屬性

b）配置文件詳解

    <!--新增用戶-->
    <insert id="saveUpdate" useGeneratedKeys="true" keyProperty="id">
        insert into d_user(id, user_name, age, gender)
        values (#{user.id}, #{user.userName}, #{user.age}, #{user.gender})
        ON DUPLICATE KEY UPDATE
        user_name = values(user_name),
        age = values(age),
        gender = values(gender)
    </insert>

c）測試

注意：返回值（keyProperty值）是放入在參數(shù)對象的屬性中。

可以關(guān)注新增數(shù)據(jù)前id屬性未有值。

新增成功后，可以看到對象中的id屬性已經(jīng)返回了數(shù)據(jù)庫的主鍵id，與數(shù)據(jù)庫的id比對的上。

2、基于注解（annotation）

a）需要添加@Options注解，注解中在配置useGeneratedKeys與keyProperty屬性即可。

useGeneratedKeys：開啟返回主鍵id
keyProperty：指定主鍵id值存放屬性

b）詳細配置

    /**
     * 新增用戶
     *
     * @param user 用戶信息
     */
    @Insert("<script>" +
            " insert into d_user(id, user_name, age, gender)\n" +
            "        values (#{user.id}, #{user.userName}, #{user.age}, #{user.gender})\n" +
            "        ON DUPLICATE KEY UPDATE\n" +
            "        user_name = values(user_name),\n" +
            "        age = values(age),\n" +
            "        gender = values(gender)" +
            "</script>")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void saveUpdate(@Param("user") User user);

c）測試

注意：返回值（keyProperty值）是放入在參數(shù)對象的屬性中。

可以看到未操作數(shù)據(jù)庫時，id屬性值為空：

新增成功后，已經(jīng)將結(jié)果返回。

二、自定義使用

所謂的自定義使用時Mybatis官方對外提供的一些沒有自增主鍵的數(shù)據(jù)庫而生成的一種方式。例如，Oracle數(shù)據(jù)庫就沒有自增情況，所以需要自定義來獲取。

注意：keyPropety屬性必須采用insert表中的id的別名。具體的可看下面截圖。

1、基于配置

a）在mapper.xml配置中<insert> 標(biāo)簽中添加<selectKey>標(biāo)簽。

# mysql
 <selectKey keyProperty="id"  order="AFTER" resultType="int">
            SELECT LAST_INSERT_ID();
 </selectKey>
# oracel
 <selectKey keyProperty="id"  order="AFTER" resultType="int">
            SELECT 數(shù)據(jù)表.NEXTVAL;
 </selectKey>

b）selectKey標(biāo)簽屬性講解

keyProperty：存放執(zhí)行SQL的結(jié)果屬性。
databaseId：指定數(shù)據(jù)庫id。例如：oracle
order：執(zhí)行在insert語句之前還是之后，參數(shù)值：AFTER, BEFORE。
resultType：結(jié)果類型。
statementType：指定SQL語句的類型，默認為STATEMENT，也可以設(shè)置為PREPARED。

c）Mysql測試

2、基于注解

a）需要添加@SelectKey注解。

keyProperty：存放執(zhí)行SQL的結(jié)果屬性。
databaseId：指定數(shù)據(jù)庫id。例如：oracle
order：執(zhí)行在insert語句之前還是之后，參數(shù)值：AFTER, BEFORE。
resultType：結(jié)果類型。

b）具體配置

@Insert("<script>" +
            " insert into d_user(id, user_name, age, gender)\n" +
            "        values (#{user.id}, #{user.userName}, #{user.age}, #{user.gender})\n" +
            "        ON DUPLICATE KEY UPDATE\n" +
            "        user_name = values(user_name),\n" +
            "        age = values(age),\n" +
            "        gender = values(gender)" +
            "</script>")
// Mysql配置
    @SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "user.id", resultType = Integer.class, before = false)
// Oracle配置
 @SelectKey(statement = "SELECT 數(shù)據(jù)表.NEXTVAL;", keyProperty = "user.id", resultType = Integer.class, before = false)

c）測試

d）總結(jié)

使用@SelectKey注解時，要謹(jǐn)慎，對于keyProperty與before的配合使用需要仔細調(diào)試，避免出現(xiàn)問題。

到此這篇關(guān)于Mybatis新增數(shù)據(jù)并返回主鍵id的實現(xiàn)的文章就介紹到這了,更多相關(guān)Mybatis新增數(shù)據(jù)返回主鍵id內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: