MyBatis中向Model返回自增主键

在插入数据的过程中,有时候不会人工显式指定记录中的ID,而是将数据库中ID字段设定为auto increment,让其自动增长,这里介绍如何将数据库自增的ID返回到我们的model参数中

abstract

使用 LAST_INSERT_ID() 函数

Mysql中的LAST_INSERT_ID()函数,从字面就可以看出,该函数返回最近一条INSERT插入语句的自增字段的值,而一般,自增一般都是设置在字段为ID的主键上。现通过一个简单Demo说明使用方法

现提供一个Controller方法addStu()如下,用于添加Student对象

1
2
3
4
5
6
7
8
9
10
11
12
13
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@Controller
@RequestMapping("Student")
public class StudentController {
private final StudentService studentService;

@RequestMapping("/add")
@ResponseBody
public Student addStu(@RequestBody Student stu) {
studentService.addStu(stu);
return stu;
}
}

Mapper接口文件如下,其接收一个Student参数的对象

1
2
3
4
@Mapper
public interface StudentMapper2 {
public void addStu(Student stu);
}

重点来了,我们将在mapper.xml映射文件通过selectKey标签LAST_INSERT_ID()函数来将刚刚INSERT插入数据的主键返回并设置到Student参数中。SQL语句如下所示,其中 SELECT LAST_INSERT_ID() 前文已经解释过了,用于获取刚刚INSERT 进去记录的自增键值。这里对selectKey标签的几个属性介绍下:

  • keyProperty: 将LAST_INSERT_ID查询到的自增键值设置到 parameterType 指定对象(这里即,Student)的哪个属性中
  • order: 相对于INSERT语句而言,SELECT LAST_INSERT_ID()的执行顺序。因为自增主键必须先插入后,才能获取该记录的主键值,故很明显应该设置为AFTER
  • resultType: 指定 SELECT LAST_INSERT_ID() 的结果类型
1
2
3
4
5
6
<insert id="addStu" parameterType="com.aaron.springbootdemo.pojo.Student">
<selectKey keyProperty="id" order="AFTER" resultType="int">
SELECT LAST_INSERT_ID()
</selectKey>
INSERT INTO user (username, sex, address) VALUE (#{username}, #{sex}, #{address})
</insert>

这里使用Postman进行测试,从结果中可以看到,将接收的Student对象数据插入数据库后,自动获取自增主键ID值(137)并将其设置到model对象中

figure 1.jpeg

使用insert标签

事实上,通过insert标签同样可以实现上述功能,甚至可能会简便,这里介绍下insert标签的需要用到的两个标签:

  • useGeneratedKeys: 使能MyBatis通过JDBC的getGeneratedKeys方法来取出数据被插入后的自增主键的值,需要设置为true
  • keyProperty: 将获得自增主键的值设置到parameterType指定对象(这里即,Student)的哪个属性中

现通过如下一个简单Demo说明使用方法
现提供一个Controller方法addStu2()如下,用于添加Student对象

1
2
3
4
5
6
7
8
9
10
11
12
13
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@Controller
@RequestMapping("Student")
public class StudentController {
private final StudentService studentService;

@RequestMapping("/add2")
@ResponseBody
public Student addStu2(@RequestBody Student stu) {
studentService.addStu2(stu);
return stu;
}
}

Mapper接口文件如下,其接收一个Student参数的对象

1
2
3
4
@Mapper
public interface StudentMapper2 {
public void addStu2(Student stu);
}

mapper.xml接口按上文所述设置即可

1
2
3
<insert id="addStu2" parameterType="com.aaron.springbootdemo.pojo.Student" useGeneratedKeys="true" keyProperty="id">
INSERT INTO user (username, address) VALUES (#{username}, #{address})
</insert>

这里使用Postman进行测试,从结果中可以看到,将接收的Student对象数据插入数据库后,自动获取自增主键ID值(138)并将其设置到model对象中

figure 2.jpeg

0%