MyBatis 自动生成主键 , 返回自增主键 insert语句

     对于表的主键自动生成的 insert语句 , 在不需要返回自增主键时 , 就和普通的insert语句没有区别 , 在需要的返回的时候 , 情况稍微有点不一样 , 故在此记录一下 . 在MyBatis中 ,  有两种方式编写SQL , 一种XML方式 , 一种是注解方式 . 首先在MYSQL中新建一张表 , 建表语句如下

CREATE TABLE `sys_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户id',
  `user_name` varchar(64) DEFAULT NULL COMMENT '用户名',
  `password` varchar(64) DEFAULT NULL COMMENT '密码',
  `email` varchar(100) DEFAULT NULL COMMENT '邮箱',
  `info` text COMMENT '简介',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户表';

 在使用主键自增的时候 ,  插入数据库后可能需要得到自增的主键值 , 然后使用这个值进行一些其他的操作 . 有些数据库提供主键自增(MYSQL , SQLSERVER) , 有些不提供(ORACLE) , 而是使用序列得到一个值 , 然后将这个值赋给 id , 再讲数据插入.

1. XML方式

    1.1 返回自增主键

<insert id="insert1" useGeneratedKeys="true" keyProperty="id">
		insert into sys_user(user_name,password,email,info,create_time)
		values(#{userName},#{password},#{email},#{info},#{createTime})
	</insert>

     使用useGeneratedKeys设置为true后 , MyBatis会使用JDBC的getGeneratedKeys方法取出由数据库内部生成的主键 . 获得主键值之后将其赋给keyProperty配置的 id 属性 . 当需要设置多个属性时 , 使用逗号隔开 , 这种情况下 还需要配置 keyColumn属性 , 按顺序指定数据库的列 , 这里列的值会和 keyProperty 配置的属性一一对应 . 由于要使用数据库返回的主键值 , 所以SQL上下两部分的列中去掉了 id 列和对于的 #{id} 属性

   1.2 返回非自增主键

    采用 <selectKey>标签获取主键的值 , 这种方式对提供和不提供主键自增功能的数据库同样适用

<insert id="insert2">
		insert into sys_user(user_name,password,email,info,create_time)
		values(#{userName},#{password},#{email},#{info},#{createTime})
		<selectKey keyColumn="id" resultType="int" keyProperty="id" order="AFTER">
		    SELECT LAST_INSERT_ID()
		</selectKey>
	</insert>

 selectKey标签的 keyColumn,keyProperty和上面useGeneratedKeys的用法和含义一样 , 这里的resultType用于设置返回值类型. order 属性和数据库相关 , 在MYSQL 中 , order是AFTER , 因为当前及记录的主键值在insert语句执行成功之后才能拿到 , 而在ORACLE中 ,oder是BEFORE , 因为ORACLE需要先从序列取到值 , 再将其作为主键插入到数据库

2. 注解方式

 2.1 返回自增主键

@Insert("insert into sys_user(user_name,password,email,info,create_time)"
			+"values(#{userName},#{password},#{email},#{info},#{createTime})")
	@Options(keyColumn="id",keyProperty="id",useGeneratedKeys=true)
	int insert(SysUser user);

 insert方法上除了 @Insert 注解之外 , 多了一个 @Option 注解 , 在这个注解上配置了useGeneratedKeys 和 keyProperty属性, 用法和 XML 的方式一样 , 当需要配置多个列的时候 , 这个注解也提供了 keyColumn 属性 , 可以像XML中那样配置使用 . 

2.2 返回非自增

@Insert("insert into sys_user(user_name,password,email,info,create_time)"
			+"values(#{userName},#{password},#{email},#{info},#{createTime})")
	@SelectKey(statement="SELECT LAST_INSERT_ID()",
			   keyProperty="id",
			   resultType=Integer.class,
			   before = false)
	int insert(SysUser user);

 和XML的方式对比  , 只是XML中的order属性换成了 before属性 , before = true时 , 功能和order = before一样 , before = false时, 功能和order = after一样