MyBatis中的selectKey

SelectKey在Mybatis中是爲了解決Insert數據時不支持主鍵自動生成的問題，他能夠很隨意的設置生成主鍵的方式。

無論SelectKey有多好，儘可能不要遇到這種狀況吧，畢竟很麻煩。

selectKey Attributes

屬性
描述

keyProperty
selectKey 語句結果應該被設置的目標屬性。

resultType
結果的類型。MyBatis 一般能夠算出來,可是寫上也沒有問題。MyBatis 容許任何簡單類型用做主鍵的類型,包括字符串。

order
這能夠被設置爲 BEFORE 或 AFTER。若是設置爲 BEFORE,那麼它會首先選擇主鍵,設置 keyProperty 而後執行插入語句。若是設置爲 AFTER,那麼先執行插入語句,而後是 selectKey 元素-這和如 Oracle 數據庫類似,能夠在插入語句中嵌入序列調用。

statementType
和前面的相 同,MyBatis 支持 STATEMENT ,PREPARED 和CALLABLE 語句的映射類型,分別表明 PreparedStatement 和CallableStatement 類型。

SelectKey須要注意order屬性，像Mysql一類支持自動增加類型的數據庫中，order須要設置爲after纔會取到正確的值。

像Oracle這樣取序列的狀況，須要設置爲before，不然會報錯。

另外在用Spring管理事務時，SelectKey和插入在同一事務當中，於是Mysql這樣的狀況因爲數據未插入到數據庫中，因此是得不到自動增加的Key。取消事務管理就不會有問題。

下面是一個xml和註解的例子，SelectKey很簡單，兩個例子就夠了：

[html] view plaincopy

1. <insert id="insert" parameterType="map">
2.     insert into table1 (name) values (#{name}) 
3. <selectKey resultType="java.lang.Integer" keyProperty="id">
4.       CALL IDENTITY() 
5. </selectKey>
6. </insert>

上面xml的傳入參數是map，selectKey會將結果放到入參數map中。用POJO的狀況同樣，可是有一點須要注意的是，keyProperty對應的字段在POJO中必須有相應的setter方法，setter的參數類型還要一致，不然會報錯。

[java] view plaincopy

1. @Insert("insert into table2 (name) values(#{name})") 
2. @SelectKey(statement="call identity()", keyProperty="nameId", before=false, resultType=int.class) 
3. int insertTable2(Name name); 

上面是註解的形式。

在insert語句中，在Oracle常常使用序列、在MySQL中使用函數來自動生成插入表的主鍵，並且須要方法能返回這個生成主鍵。使用myBatis的selectKey標籤能夠實現這個效果。

下面例子，使用mysql數據庫自定義函數nextval('student')，用來生成一個key，並把他設置到傳入的實體類中的studentId屬性上。因此在執行完此方法後，邊能夠經過這個實體類獲取生成的key。

Xml代碼

1. <!-- 插入學生 自動主鍵-->
2. <insert id="createStudentAutoKey" parameterType="liming.student.manager.data.model.StudentEntity" keyProperty="studentId">
3. <selectKey keyProperty="studentId" resultType="String" order="BEFORE">
4.         select nextval('student') 
5. </selectKey>
6.     INSERT INTO STUDENT_TBL(STUDENT_ID, 
7.                             STUDENT_NAME, 
8.                             STUDENT_SEX, 
9.                             STUDENT_BIRTHDAY, 
10.                             STUDENT_PHOTO, 
11.                             CLASS_ID, 
12.                             PLACE_ID) 
13.     VALUES (#{studentId}, 
14.             #{studentName}, 
15.             #{studentSex}, 
16.             #{studentBirthday}, 
17.             #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler}, 
18.             #{classId}, 
19.             #{placeId}) 
20. </insert>

調用接口方法，和獲取自動生成key

Java代碼

1. StudentEntity entity = new StudentEntity(); 
2. entity.setStudentName("黎明你好"); 
3. entity.setStudentSex(1); 
4. entity.setStudentBirthday(DateUtil.parse("1985-05-28")); 
5. entity.setClassId("20000001"); 
6. entity.setPlaceId("70000001"); 
7. this.dynamicSqlMapper.createStudentAutoKey(entity); 
8. System.out.println("新增學生ID: " + entity.getStudentId());