MyBatis 返回insert操作主鍵

    應用場景 在向數據庫插入數據時，需要保留插入數據的id，以便進行后續的update操作或者將id存入其他表作為外鍵。但是，在默認情況下，insert操作返回的是一個int值，它並非表示主鍵id，而是表示當前SQL語句影響的行數。

   接下來，我們依次從options注解和SQL兩個方面，了解MyBatis如何在使用MySQL和Oracle做insert插入操作時將返回的id綁定到對象中。

Mybatis的@Options注解

    mybatis的@Options注解能夠拿到對象自增的id的值，能夠設置緩存時間，首先，創建一張用於測試的表instance。

CREATE TABLE instance (
  instance_id BIGINT NOT NULL AUTO_INCREMENT COMMENT '主鍵id',
  infos VARCHAR(2048) NOT NULL DEFAULT '' COMMENT '消息',
  create_time datetime COMMENT '創建時間',
  update_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新時間',
  PRIMARY KEY (instance_id)
)ENGINE=INNODB DEFAULT CHARSET=utf8 COMMENT '實例表';

    其中的instance_id是自增的主鍵。我希望通過dao層的接口插入的數據能夠返回主鍵的id。接口代碼如下：

@Insert("insert into instance (infos)"
                    + " ("
                    + " @{infos},"
                    + " NOW()"
                    + ")")
    @Options(useGeneratedKeys = true, keyProperty = "instanceId", keyColumn = "instance_id")
    int addInstance(Instance instanceDto);

    @Options注解中默認設置的主鍵對應的字段名為id，而在instance表中，主鍵為instance_id，因此需要將keyProperty和keyColumn設置成我們想要的字段。這個示例的意思就是，從instance_id這個字段把數據放到傳入對象instanceDto的instanceId成員變量里面。

    在調用了插入方法之后，@Options注解會自動為表的主鍵字段設置自增的值，並把它賦值給作為入參的DTO，進而可以直接從這個對象中獲取新生成記錄的主鍵。接下來看下@Option注解的源碼：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Options {
    boolean useCache() default true;
    boolean flushCache() default false;
    ResultSetType resultSetType() default ResultSetType.FORWARD_ONLY;
    StatementType statementType() default StatementType.PREPARED;
    int fetchSize() default -1;
    int timeout() default -1;
    boolean useGeneratedKeys() default false;
    String keyProperty() default "id";
    String keyColumn() default "";
}

    注解中的useCache還可以設置緩存相關的選項，useCache = true表示本次查詢結果被緩存以提高下次查詢速度，flushCache = false表示下次查詢時不刷新緩存，timeout = 10000表示查詢結果緩存10000秒。

    在文獻[2]中，Java API àMapper Annotations中可以找到英文原版介紹。

從執行insert SQL時返回主鍵ID

    MySQL用法：

<insert id="insert" parameterType="com.test.Instance"  keyProperty=" instanceId" useGeneratedKeys="true" >

    上面配置中，“keyProperty”表示返回的instance_id要保存到對象的那個屬性中，“useGeneratedKeys”表示主鍵為自增長模式。

    MySQL中做以上配置就OK了，較為簡單，不再贅述。下面分享Oracle中的用法。

<insert id="insert" parameterType="com.test.Instance ">
   <selectKey resultType="Long" order="BEFORE" keyProperty="instanceId">  
       SELECT SEQ_USER.NEXTVAL as instanceId from DUAL
   </selectKey> 
    insert into instance (instance_id, infos, create_time)
    values (#{instanceId}, #{infos}, now())
</insert>

    Oracle用法中，需要注意的是：由於Oracle沒有自增長一說法，只有序列這種模仿自增的形式，所以不能再使用“useGeneratedKeys”屬性，而是使用<selectKey>將ID獲取並賦值到對象的屬性中，insert插入操作時正常插入id。

參考文獻

[1] https://www.cnblogs.com/sonofelice/p/6250203.html.

[2] http://www.mybatis.org/mybatis-3/index.html.

原文地址：https://www.cnblogs.com/east7/p/10200872.html