Mybatis插入数据后自增id获取方式
作者:二掌柜,酒来!
在MyBatis中,获取自增主键可以通过useGeneratedKeys属性或selectKey节点实现,useGeneratedKeys设置时,需设置keyProperty指定主键字段,数据库表也要相应设置,selectKey节点可在插入操作后,通过特定SQL查询获得主键
需求
我们需要把插入数据后的id(有数据库自增主键生成)返回来,以便我们下一次操作。
like this
/** * 测试插入后获取id */ @Test public void testinsertStudentCacheId(){ Student student=new Student("helloworld",17,85); System.out.println("插入前:student="+student); dao.insertStudentCacheId(student); System.out.println("插入后:student id="+student.getId()); }
了解一下mybatis基本信息
mybatis 可配置的属性
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN" "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> <!-- mapper 为根元素节点, 一个namespace对应一个dao --> <!-- Mapper元素只有一个属性namespace,它有两个作用:`一是用于区分不同的mapper`(在不同的mapper文件里,子元素的id可以相同,mybatis通过namespace和子元素的id联合区分),`二是与接口关联`(应用程序通过接口访问mybatis时,mybatis通过接口的完整名称查找对应的mapper配置,因此namespace的命名务必小心一定要某接口同名)。 --> <mapper namespace="com.dy.dao.UserDao"> <!-- cache- 配置本定命名空间的缓存。 type- cache实现类,默认为PERPETUAL,可以使用自定义的cache实现类(别名或完整类名皆可) eviction- 回收算法,默认为LRU,可选的算法有: LRU– 最近最少使用的:移除最长时间不被使用的对象。 FIFO– 先进先出:按对象进入缓存的顺序来移除它们。 SOFT– 软引用:移除基于垃圾回收器状态和软引用规则的对象。 WEAK– 弱引用:更积极地移除基于垃圾收集器状态和弱引用规则的对象。 flushInterval- 刷新间隔,默认为1个小时,单位毫秒 size- 缓存大小,默认大小1024,单位为引用数 readOnly- 只读 --> <cache type="PERPETUAL" eviction="LRU" flushInterval="60000" size="512" readOnly="true" /> <!-- cache-ref–从其他命名空间引用缓存配置。 如果你不想定义自己的cache,可以使用cache-ref引用别的cache。因为每个cache都以namespace为id,所以cache-ref只需要配置一个namespace属性就可以了。需要注意的是,如果cache-ref和cache都配置了,以cache为准。 --> <cache-ref namespace="com.someone.application.data.SomeMapper"/> <insert <!-- 1. id (必须配置) id是命名空间中的唯一标识符,可被用来代表这条语句。 一个命名空间(namespace) 对应一个dao接口, 这个id也应该对应dao里面的某个方法(相当于方法的实现),因此id 应该与方法名一致 --> id="insertUser" <!-- 2. parameterType (可选配置, 默认为mybatis自动选择处理) 将要传入语句的参数的完全限定类名或别名, 如果不配置,mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理 parameterType 主要指定参数类型,可以是int, short, long, string等类型,也可以是复杂类型(如对象) --> parameterType="com.demo.User" <!-- 3. flushCache (可选配置,默认配置为true) 将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:true(对应插入、更新和删除语句) --> flushCache="true" <!-- 4. statementType (可选配置,默认配置为PREPARED) STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。 --> statementType="PREPARED" <!-- 5. keyProperty (可选配置, 默认为unset) (仅对 insert 和 update 有用)唯一标记一个属性,MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值,默认:unset。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 --> keyProperty="" <!-- 6. keyColumn (可选配置) (仅对 insert 和 update 有用)通过生成的键值设置表中的列名,这个设置仅在某些数据库(像 PostgreSQL)是必须的,当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 --> keyColumn="" <!-- 7. useGeneratedKeys (可选配置, 默认为false) (仅对 insert 和 update 有用)这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段),默认值:false。 --> useGeneratedKeys="false" <!-- 8. timeout (可选配置, 默认为unset, 依赖驱动) 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。 --> timeout="20"> <update id="updateUser" parameterType="com.demo.User" flushCache="true" statementType="PREPARED" timeout="20"> <delete id="deleteUser" parameterType="com.demo.User" flushCache="true" statementType="PREPARED" timeout="20"> </mapper>
很明显啊,keyProperty、keyColumn、useGeneratedKeys 这个三个属性就是我们实现需求的切入点
开始实现
方法一 useGeneratedKeys 设置主键自增
<insert id="insertStudentCacheId" useGeneratedKeys="true" keyProperty="id" parameterType="Student"> insert into student(name,age,score) values(#{name},#{age},#{score}) </insert>
需要注意的地方:
- useGeneratedKeys="true"表示设置属性自增,数据库表字段需要设置
- keyProperty="id"设置主键的字段
- parameterType="Student"设置传入的类型
- 注意:虽然有返回类型,但是我们不需要手动设置返回的类型,这个是由框架帮我们实现的,所以对应的接口方法也是没有返回值的,会自动修改我们插入的对象,设置id值。所以mapper返回值是影响行数。
- 实体类中id属性字段一定需要set以及get方法
方法二 selectKey 查询主键
selectKey 介绍
<selectKey <!-- selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 --> keyProperty="id" <!-- 结果的类型。MyBatis 通常可以推算出来,但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型,包括字符串。如果希望作用于多个生成的列,则可以使用一个包含期望属性的 Object 或一个 Map。 --> resultType="int" <!-- 这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE,那么它会首先选择主键,设置 keyProperty 然后执行插入语句。如果设置为 AFTER,那么先执行插入语句,然后是 selectKey 元素 - 这和像 Oracle 的数据库相似,在插入语句内部可能有嵌入索引调用。 --> order="BEFORE" <!-- 与前面相同,MyBatis 支持 STATEMENT,PREPARED 和 CALLABLE 语句的映射类型,分别代表 PreparedStatement 和 CallableStatement 类型。 --> statementType="PREPARED">
- selectKey给了你一个简单的行为在你的数据库中来处理自动生成的主键,而不需要使你的Java代码变得复杂。
- selectKey节点生成的KeyGenerator优先级高于statement节点的useGeneratedKeys属性生成的KeyGenerator对象,也就是说配置了SelectKey子节点就不需要再配置useGeneratedKeys属性了。
获取主键操作
<insert id="insertStudentCacheId" parameterType="Student"> insert into student(name,age,score) values(#{name},#{age},#{score}) <!-- 指定结果类型resultType,keyProperty是属性,自动返回到属性id中,order是次序,after是指获取id是在于插入后 --> <selectKey resultType="int" keyProperty="id" order="AFTER"> select @@identity </selectKey> </insert>
或者
<insert id="insertStudentCacheId" parameterType="Student"> insert into student(name,age,score) values(#{name},#{age},#{score}) <!-- 指定结果类型resultType,keyProperty是属性,自动返回到属性id中,order是次序,after是指获取id是在于插入后 --> <selectKey resultType="int" keyProperty="id" order="AFTER"> select LAST_INSERT_ID() </selectKey> </insert>
注意要点:
- 最外层的没有返回属性(resultType),但是里面的是有返回值类型的。
- order="AFTER"表示先执行插入,之后才执行selectkey语句的。
- select @@identity和select LAST_INSERT_ID()都表示选出刚刚插入的最后一条数据的id。
- 实体类中id属性字段一定需要set以及get方法
- 此时,接口中仍不需要有返回值,框架会自动将值注入到我们insert的那个对象中,我们可以直接使用就可以了。
同样,我们的接口中可以有返回值,但是这个返回值不是id,而是表示插入后影响的行数,此时sql中仍和上面一样,不需要写返回值。
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。