Mybatis中useGeneratedKeys和keyProperty的作用

本文介绍在使用MyBatis框架时,如何在插入记录后立即获取自动生成的主键值。通过在XML映射文件中设置useGeneratedKeys为true,并指定keyProperty为实体类的主键属性,即可在Java代码中直接使用该属性获取主键。

转载:https://www.cnblogs.com/smart-hwt/archive/2017/12/28/8136188.html

在使用mybatis时,常常会出现这种需求:

当主键是自增的情况下,添加一条记录的同时,其主键是不能使用的,但是有时我们需要该主键,这时我们该如何处理呢?这时我们只需要在其对应xml中加入以下属性即可:

useGeneratedKeys=“true” keyProperty=“对应的主键的对象”。
如下例:


<!--   主要是在主键是自增的情况下,添加成功后可以直接使用主键值,其中keyProperty的值是对象的属性值不是数据库表中的字段名-->   
 <insert id="saveMsg" parameterType="cn.com.hyddl.smarthome.notice.core.nano.Notice" useGeneratedKeys="true" keyProperty="msgId">    
     insert into notice(msg_type,title,content,rec_time,send_time,user_id,deleted,viewed)        
     values(#{msgType,jdbcType=INTEGER},
     #{title,jdbcType=VARCHAR},#{content,jdbcType=VARCHAR},#{recTime,jdbcType=BIGINT},#{sendTime,jdbcType=BIGINT},
     #{userId,jdbcType=VARCHAR},#{deleted,jdbcType=TINYINT},#{viewed,jdbcType=INTEGER})
 </insert>

这样在之后的java代码中我们就可以获取该主键对应的对象的属性值(msgId)。

MyBatis的注解开发中,`useGeneratedKeys` `keyProperty` 通常用于插入数据时获取数据库自动生成的主键值。 ### `useGeneratedKeys` `keyProperty` 的作用 - `useGeneratedKeys`:这是一个布尔值,设置为 `true` 时表示使用数据库的自动生成主键功能。即让MyBatis获取数据库自动生成的主键值。 - `keyProperty`:指定将自动生成的主键值赋值给Java对象的哪个属性。 ### 设置方法示例 #### 1. 实体类 首先,创建一个简单的实体类,这里以 `User` 类为例: ```java public class User { private Long id; private String name; private Integer age; // 构造方法、GetterSetter方法 public User() {} public User(String name, Integer age) { this.name = name; this.age = age; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } } ``` #### 2. Mapper接口 在Mapper接口中使用注解来设置 `useGeneratedKeys` `keyProperty`: ```java import org.apache.ibatis.annotations.Insert; import org.apache.ibatis.annotations.Options; public interface UserMapper { @Insert("INSERT INTO user (name, age) VALUES (#{name}, #{age})") @Options(useGeneratedKeys = true, keyProperty = "id") int insertUser(User user); } ``` 在上述代码中,`@Insert` 注解用于定义插入SQL语句,`@Options` 注解用于设置额外的选项。`useGeneratedKeys = true` 表示使用数据库的自动生成主键功能,`keyProperty = "id"` 表示将自动生成的主键值赋值给 `User` 对象的 `id` 属性。 #### 3. 使用示例 ```java import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import java.io.InputStream; public class Main { public static void main(String[] args) throws Exception { // 加载MyBatis配置文件 String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 获取SqlSession try (SqlSession session = sqlSessionFactory.openSession()) { UserMapper userMapper = session.getMapper(UserMapper.class); User user = new User("John", 25); // 插入用户 userMapper.insertUser(user); session.commit(); // 输出自动生成的主键值 System.out.println("Generated ID: " + user.getId()); } } } ``` ### 总结 通过 `@Options` 注解的 `useGeneratedKeys` `keyProperty` 属性,可以方便地在MyBatis的注解开发中获取数据库自动生成的主键值,并将其赋值给Java对象的相应属性。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值