Mybatis 之useGeneratedKeys注意点

news2024/10/2 22:27:45

一.例子

Order.java

public class Order {
	private Long id;
	private String serial;
}



orderMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" 
	"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.vic.mybatis.dao.OrderDao">
	<insert id="createOrder" useGeneratedKeys="true" keyProperty="id">
		insert into t_order(serial) values (#{serial})
	</insert>
</mapper>



OrderDao.java
@Mapper
public interface OrderDao {
    public int createOrder(Order order);
}



OrderServiceImpl.java
@Service
@Slf4j
public class OrderServiceImpl implements OrderService {

    @Resource
    private OrderDao orderDao;

    @Override
    public int createOrder(Order order) {
    	// 这个result是否就是插入数据成功后返回的主键ID？
    	int id = orderDao.createOrder(order);
    	log.info(" *****插入数据后返回的id： " + id + " *****");
    	log.info(" *****插入数据后返回的id： " + order.getId() + " *****");
        return result;
    }
}

大家应该懂得都懂哈，下面就围绕useGeneratedKeys探讨上面这两行输出的内容

若数据库支持自动生成主键（比如 MySQL 和 SQL Server），则可以设置 useGeneratedKeys=“true”，表明使用自增主键获取主键值策略，然后再利用 keyProperty 属性指定对应的主键属性，也就是 Mybatis 获取到主键值后，将这个值封装给 JavaBean 的哪个属性。

前提就是你的数据库的的那个字段必须是自增的字段然后你的mybatis 才可以设置这个字段是一个自增的字段

二. 官网说明

mybatis对于mapper中 useGeneratedKey的描述

(insert and update only) This tells MyBatis to use the JDBC getGeneratedKeys method to retrieve keys generated internally by the database (e.g. auto increment fields in RDBMS like MySQL or SQL Server). Default: false.

mybatis对于Configuration中useGeneratedKey的描述

Allows JDBC support for generated keys. A compatible driver is required. This setting forces generated keys to be used if set to true, as some drivers deny compatibility but still work (e.g. Derby). Default: false.

mybatis对于注解映射中useGeneratedKey

@Options This annotation provides access to the wide range of switches and configuration options that are normally present on the mapped statement as attributes

@Options注解提供了对广泛开关和配置选项的访问，这些开关和配置选项通常作为属性出现在映射语句中，就是也就是说这个配置了后，它会直接作为属性出现在映射语句中，会覆盖上面Configuration(setting)中的配置

三.Mybatis中的useGeneratedKeys

3.1、对于Configuration(setting)中useGeneratedKey

<settings>
	<setting name="useGeneratedKeys" value="true" />
</settings>

在执行insert成功之后可以获取到数据库自动生成的主键ID，因为在settings元素中设置useGeneratedKeys是全局生效的，但实际是只会对接口映射器(没有同时配置@Options注解情况下)产生影响，对xml映射器不起效。

3.2、对于mapper中useGeneratedKey

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" 
	"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.vic.mybatis.dao.OrderDao">
	<insert id="createOrder" useGeneratedKeys="true" keyProperty="id">
		insert into t_order(serial) values (#{serial})
	</insert>
</mapper>

在mapper(xml)中配置的useGeneratedKeys属性只会对当前mapper(xml映射器)产生影响，且在settings元素中设置的全局useGeneratedKeys参数值对于mapper(xml映射器)不产生任何作用。

3.3、对于注解映射中useGeneratedKey

@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
@Insert("insert into t_order(serial) values(#{serial})")
Integer createOrder(Order order);

在同时在Configuration(setting) 和接口映射器中都添加了useGeneratedKeys属性，无论属性值是否相同，接口映射器的优先级会高于Configuration(setting) 的优先级；

也就说，不管你在Configuration(setting) 中设置useGeneratedKeys 为 true 或者 false，只要你在接口映射器中设置了@Options(useGeneratedKeys = true), 那么就会返回主键ID，如果@Options(useGeneratedKeys = false),那么就不会返回主键ID