Mybatis插入数据时，自动获取自增主键值

在平时开发中，可能会遇到数据库主键是自增的情况，这时我们保存数据时并不需要指定主键，可是很多时候都需要获取保存数据后生成的主键，怎么办呢？

mybatis提供了两种方式获取数据库自增主键：

1. 在insert标签中使用 useGeneratedKeys、keyProperty、keyColumn 属性获取；
2. 在insert标签中嵌套 selectKey 标签获取。

下面使用小案例演示一下，这里使用的是MySQL数据库：

1. 创建一张测试用的book表，建表语句如下：

CREATE TABLE `book`  (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;

2. 创建一个spring boot项目，项目结构如下：
   
3. 导入maven依赖：

		<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

4. 编写application.yml配置文件：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/bg-learnsp?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver

logging:
  level:
    root: info
    com.learn.mapper: debug

mybatis:
  mapper-locations: classpath:mapper/**/*.xml

5. 创建数据库实体类：

@Data
public class Book {
    private Integer id;
    private String name;
}

6. 创建BookMapper文件：

@Mapper
public interface BookMapper {
    int insertBook(Book book);
}

7. 创建BookMapper.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.learn.mapper.BookMapper">

    <insert id="insertBook" parameterType="com.learn.entity.Book" >
        INSERT INTO BOOK(NAME) VALUES(#{name})
    </insert>
</mapper>

8. 编写测试用例：

@SpringBootTest
class MybatisTest01ApplicationTests {

    @Autowired
    private BookMapper bookMapper;

    @Test
    public void testPk() {
        Book book = new Book();
        book.setName("java");
        System.out.println("保存前：" + book);
        bookMapper.insertBook(book);
        System.out.println("保存后：" + book);
    }

}

运行结果：

保存前：Book(id=null, name=java)
保存后：Book(id=null, name=java)

数据库：

可以看到数据成功保存了，接着就是获取到保存后的主键，下面就用上面提到的两种方法实践一下。

1. 在insert标签中使用useGeneratedKeys、keyProperty、keyColumn属性获取：

修改一下BookMapper.xml文件：

<insert id="insertBook" parameterType="com.learn.entity.Book" useGeneratedKeys="true" keyColumn="id" keyProperty="id">
        INSERT INTO BOOK(NAME) VALUES(#{name})
    </insert>

再次测试：

保存前：Book(id=null, name=java)
保存后：Book(id=2, name=java)

可以看到，成功获取了保存以后的主键。

useGeneratedKeys、keyProperty、keyColumn属性，仅能在insert或者update标签中使用。作用分别如下所示：

• useGeneratedKeys:是否自动生成主键，默认false。
• keyColumn:数据库中的自增主键的列名，默认是数据库表的第一列，当主键列不是表中的第一列的时候需要设置。
• keyProperty:返回的主键值赋给实体类中哪个属性。

2. 在insert标签中嵌套selectKey 标签获取：

修改一下BookMapper.xml文件：

	<insert id="insertBook" parameterType="com.learn.entity.Book">
        <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
            SELECT LAST_INSERT_ID()
        </selectKey>
        INSERT INTO BOOK(NAME) VALUES(#{name})
    </insert>

再次测试：

保存前：Book(id=null, name=java)
保存后：Book(id=3, name=java)

可以看到，也成功获取了保存以后的主键。

由上面小案例可以看到，使用selectKey标签需要执行2条sql，而之前使用useGeneratedKeys、keyProperty的方式，只需要执行一个sql就可以了，因此selectKey标签效率更低；而且selectKey标签是不支持获取批量插入的记录id的，所以推荐使用useGeneratedKeys、keyProperty的方式来获取自增主键。