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());