探究insert,update以及delete元素的用法
在这篇文章中,我们主要学习一下insert,update以及delete元素的定义和作用.
insert和update元素
如果认真观察的话,我们可以发现insert和update两个元素具有完全相同的DTD定义:
相较于select元素来讲,insert和update元素移除了用于配置返回结果的相关属性,新增了几个用于配置主键的属性.
(上图中,红色标记为移除属性,绿色标记为新增属性.)
在Mybatis源码之美:3.7.深入了解select元素一文中针对上诉的大部分属性,我们已经做了详细的介绍,因此这篇文章,我们主要看一下新增的用于配置主键的属性.
有些时候,在进行数据库表设计的时候,我们会将数据记录的主键生成行为交给数据库来完成,以此来避免类似于主键冲突之类的问题.
比如,针对USER表设计:
create table USER
(
id INTEGER NOT NULL GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1 ),
name varchar(20),
PRIMARY KEY (id)
);
我们在新增USER记录的时候,只需要指定name列的值即可,而无需关心id列的值.
但是,这样就产生了一个新的问题:在新增数据记录之后,我们可能需要新增数据的主键值,并以此进行后续的工作.
比如,在新增用户之后,我们可能会需要新增用户的id来关联用户角色表.
这时候,我们就需要获取到由数据库生成的主键值.
useGeneratedKeys属性
自JDBC3.0开始,Statement对象的getGeneratedKeys()可以获取因为执行当前Statement对象而生成的主键,如果Statement没有生成主键,则返回空的ResultSet对象.
/**
* Retrieves any auto-generated keys created as a result of executing this
* Statement object. If this Statement object did
* not generate any keys, an empty ResultSet
* object is returned.
*
*Note:If the columns which represent the auto-generated keys were not specified,
* the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
*
* @return a ResultSet object containing the auto-generated key(s)
* generated by the execution of this Statement object
* @exception SQLException if a database access error occurs or
* this method is called on a closed Statement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.4
*/
ResultSet getGeneratedKeys() throws SQLException;
mybatis中useGeneratedKeys属性的作用就是通知mybatis使用JDBC自带的getGeneratedKeys()方法来获取由数据库生成的主键.
Statement对象提供了三种执行SQL的方法,他们分别是:execute(),executeUpdate()以及executeLargeUpdate().
这三个方法都提供了一个可以额外传入int类型的autoGeneratedKeys参数的重载实现.
autoGeneratedKeys参数的取值来自于Statement接口中的两个常量:RETURN_GENERATED_KEYS和NO_GENERATED_KEYS.
// 返回生成的主键
int RETURN_GENERATED_KEYS = 1;
// 不返回生成的主键
int NO_GENERATED_KEYS = 2;
其中RETURN_GENERATED_KEYS表示返回生成的主键,NO_GENERATED_KEYS表示不返回生成的主键.
我们先感受一下原始的JDBC获取自增主键的方法:
数据初始化脚本:
/* ======================== 插入用户数据 =============================*/
drop table USER if exists;
create table USER
(
id INTEGER NOT NULL GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1 ),
name varchar(20),
role_id int,
PRIMARY KEY (id)
);
insert into USER (name, role_id)
values ( 'Panda1', 1);
insert into USER (name, role_id)
values ( 'Panda2', 2);
单元测试类:
@Test
@SneakyThrows
public void returnGeneratedKeysTest() {
// 获取连接
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
@Cleanup
Connection connection = sqlSession.getConnection();
assert connection.getMetaData().supportsGetGeneratedKeys();
// 执行插入
Statement statement = connection.createStatement();
// 插入一条新纪录
statement.executeUpdate("insert into USER ( name, role_id) values ('Panda', 1);", Statement.RETURN_GENERATED_KEYS);
ResultSet keys = statement.getGeneratedKeys();
while (keys.next()) {
log.debug("当前数据生成的ID是:{}", keys.getInt("ID"));
}
ResultSet select = statement.executeQuery("SELECT * FROM USER");
while (select.next()) {
System.out.print("查询结果:");
System.out.print(String.format("id=%d,", select.getInt("ID")));
System.out.print(String.format("name=%s,", select.getString("NAME")));
System.out.println(String.format("role_id=%d,", select.getInt("ROLE_ID")));
}
}
因为在调用executeUpdate()方法时,我们传入了Statement.RETURN_GENERATED_KEYS参数,因此,我们可以通过getGeneratedKeys()方法获来取到到本次Statement语句生成的主键数据.
日志数据:
...省略...
DEBUG [main] - 当前数据生成的ID是:3
查询结果:id=1,name=Panda1,role_id=1,
查询结果:id=2,name=Panda2,role_id=2,
查询结果:id=3,name=Panda,role_id=1,
...省略...
但是,针对相同的测试代码,如果在调用executeUpdate()方法时.我们传入的是Statement.NO_GENERATED_KEYS参数,getGeneratedKeys()方法就无法获取到主键信息了.
日志数据:
...省略...
查询结果:id=1,name=Panda1,role_id=1,
查询结果:id=2,name=Panda2,role_id=2,
查询结果:id=3,name=Panda3,role_id=1,
...省略...
感受了原始的jdbc操作之后,我们再来感受一下mybatis中useGeneratedKeys属性的效果,不过在此之前,我们需要先了解一下keyProperty和keyColumn属性.
keyProperty和keyColumn属性
当我们决定配置useGeneratedKeys属性的值为true,以此来获取数据库生成的主键时,我们就需要着手配置keyProperty属性和keyColumn属性了.
keyProperty属性的取值是java对象的属性名,当获取到新增数据记录的主键之后,mybatis会将主键对应的值赋给keyProperty指向的属性,如果有多个属性,可以使用,进行分隔.
keyColumn属性稍有不同,他只在statementType属性为PREPARED时才会生效.
keyColumn属性用于指定当Statement执行完成后,需要返回的数据的数据列名称,如果有多个数据列的话,可以使用,进行分隔.
前面我们已经说过了statementType属性用于控制Statement实例的类型,其中PREPARED对应的是PreparedStatement.
在JDBC中,Connection通过prepareStatement()方法来创建PreparedStatement对象.
prepareStatement()方法有多种重载实现,我们这里主要看下面两种:
方法一:
PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)
throws SQLException;
方法二:
PreparedStatement prepareStatement(String sql, String columnNames[])
throws SQLException;
当我们通过方法一来获取PreparedStatement对象时,如果我们把autoGeneratedKeys参数设置为1,PreparedStatement的getGeneratedKeys()方法返回的是本次PreparedStatement语句执行时创建的主键信息.
当我们通过方法二来获取PreparedStatement对象时,PreparedStatement的getGeneratedKeys()方法返回的columnNames参数指定的数据列的数据信息.
在statementType属性的取值为PREPARED时,如果我们配置了keyColumn属性,那么mybatis将会通过方法二来创建PreparedStatement对象.
现在,我们先通过原始的JDBC操作来感受这两个方法的不同之处.
在创建PreparedStatement对象,我们明确指定了需要返回NAME属性.
@Test
@SneakyThrows
public void specifyTheReturnedDataColumnTest(){
// 获取连接
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
@Cleanup
Connection connection = sqlSession.getConnection();
assert connection.getMetaData().supportsGetGeneratedKeys();
// 执行插入
PreparedStatement statement = connection.prepareStatement("insert into USER ( name, role_id)\n" +
"values ('Panda3', 1);",new String[]{"NAME"});
statement.execute();
ResultSet keys = statement.getGeneratedKeys();
while (keys.next()) {
log.debug("当前数据生成的NAME是:{}", keys.getString("NAME"));
}
ResultSet select = connection.createStatement().executeQuery("SELECT * FROM USER");
while (select.next()) {
System.out.print("查询结果:");
System.out.print(String.format("id=%d,", select.getInt("ID")));
System.out.print(String.format("name=%s,", select.getString("NAME")));
System.out.println(String.format("role_id=%d,", select.getInt("ROLE_ID")));
}
}
日志数据:
...省略...
DEBUG [main] - 当前数据生成的NAME是:Panda3
查询结果:id=1,name=Panda1,role_id=1,
查询结果:id=2,name=Panda2,role_id=2,
查询结果:id=3,name=Panda3,role_id=1,
...省略...
现在调整一下,让他返回主键:
@Test
@SneakyThrows
public void noSpecifyTheReturnedDataColumnTest(){
// 获取连接
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
@Cleanup
Connection connection = sqlSession.getConnection();
assert connection.getMetaData().supportsGetGeneratedKeys();
// 执行插入
PreparedStatement statement = connection.prepareStatement("insert into USER ( name, role_id)\n" +
"values ('Panda3', 1);",Statement.RETURN_GENERATED_KEYS);
statement.execute();
ResultSet keys = statement.getGeneratedKeys();
while (keys.next()) {
log.debug("当前数据生成的ID是:{}", keys.getInt("ID"));
}
ResultSet select = connection.createStatement().executeQuery("SELECT * FROM USER");
while (select.next()) {
System.out.print("查询结果:");
System.out.print(String.format("id=%d,", select.getInt("ID")));
System.out.print(String.format("name=%s,", select.getString("NAME")));
System.out.println(String.format("role_id=%d,", select.getInt("ROLE_ID")));
}
}
日志数据:
...省略...
DEBUG [main] - 当前数据生成的ID是:3
查询结果:id=1,name=Panda1,role_id=1,
查询结果:id=2,name=Panda2,role_id=2,
查询结果:id=3,name=Panda3,role_id=1,
...省略...
useGeneratedKeys属性的使用
了解了useGeneratedKeys,keyProperty以及keyColumn属性之后,我们通过实际操作来看一下他们的效果.
新建一个简单的映射配置:
insert into USER (name, role_id)
values (#{name}, #{roleId})
在这个映射配置中,我们启用了useGeneratedKeys,同时指定了表的主键对应着User对象的id属性.
因此,从理论上讲,mybatis在执行完insert语句之后,需要将新增数据的id值回填到入参的User对象的id属性上.
针对这个理论,我们提供一个简单的单元测试:
@Test
public void insertTest() {
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
Mapper mapper = sqlSession.getMapper(Mapper.class);
// 新建用户
User user = new User();
user.setName("panda2");
user.setRoleId(2);
// 执行数据库操作
int count = mapper.insert(user);
assert count > 0;
assert user.getId() != null;
log.debug("新增用户ID为:{}",user.getId());
}
单元测试成功运行,同时在运行完insert方法之后,user对象的id属性被赋值为3.
理论验证通过,这是关键运行日志:
...省略...
DEBUG [main] - 新增用户ID为:3
...省略...
接下来,我们修改上面的映射配置,为其添加keyColumn属性配置,为了确定keyColumn属性的作用,这里我们将其配置为name:
insert into USER (name, role_id)
values (#{name}, #{roleId})
再次运行上面的单元测试,我们会得到一条异常信息:
incompatible data type in conversion: from SQL type VARCHAR to java.lang.Integer, value: panda2
很明显,报错信息中的panda2是我们为user对象的name属性配置的值,这表明我们配置的keyColumn属性生效了.
selectKey子元素
除了useGeneratedKeys之外,我们还可以通过配置selectKey元素来获取数据库主键.
selectKey元素的用法有点像是一个阉割版的select元素,他可以配置一个简单的查询语句,mybatis会通过该查询语句来获取指定数据列的值.:
KeyGenerator接口定义
在mybatis中,无论是useGeneratedKeys属性配置还是selectKey元素配置,最终都会被转换成KeyGenerator接口的实现,该接口用于在执行指定sql之前或者之后,通过执行一些额外的操作,获取并处理指定数据列的值.
/**
* 主键生成器
*
* @author Clinton Begin
*/
public interface KeyGenerator {
/**
* 前置生成主要只要用户oracle等使用序列机制的ID生成方式
*
* @param executor SQL执行器
* @param ms 映射的声明语句
* @param stmt 声明语句
* @param parameter 参数
*/
void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter);
/**
* 后置生成主要用于mysql等使用自增机制的ID生成方式
*
* @param executor SQL执行器
* @param ms 映射的声明语句
* @param stmt 声明语句
* @param parameter 参数
*/
void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter);
}
KeyGenerator接口中定义了两个方法,其中processBefore()方法在执行指定sql之前被调用,processAfter()方法在执行指定sql之后调用.
在selectKey元素中,有一个比较特别的order属性,该属性有BEFORE和AFTER两个取值,就分别对应着上面的两个方法.
mybatis默认为KeyGenerator接口提供了三种实现:
其中Jdbc3KeyGenerator是针对useGeneratedKeys属性配置的实现,SelectKeyGenerator是针对selectKey元素配置的实现,NoKeyGenerator是默认的空实现.
关于
KeyGenertor实现类的更多细节,我们会在后面的文章给出.
selectKey元素的使用
selecetKey元素的用法并不复杂,它的大部分属性定义,我们在其他元素中都已经有所了解,现在让我们来体验一下它的实际使用效果.
select max(id) + 1 from USER
insert into USER
(name, role_id)
values (#{name}, #{roleId})
我们在insertWithSelectKey中通过配置selectKey指定了一条查询语句来为id属性赋值,同时通过selectKey元素的order属性配置了赋值行为在执行insert语句之前完成.
在数据库初始化脚本中,我们已经插入了两条记录,所以select max(id) + 1 from USER的返回值为3.
所以针对下面的单元测试,理论新增用户ID和实际新增用户ID应该是一致的:
@Test
public void insertWithSelectKey() {
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
Mapper mapper = sqlSession.getMapper(Mapper.class);
User user = new User();
user.setName("panda2");
user.setRoleId(2);
int count = mapper.insertWithSelectKey(user);
assert count > 0;
assert user.getId() != null;
log.debug("理论新增用户ID为:{}", user.getId());
List users = mapper.selectAll();
users.stream().max(Comparator.comparingInt(User::getId)).ifPresent((u) -> {
log.debug("实际新增用户ID为:{}", u.getId());
});
}
在实际运行中,两个ID也的确是一致的,均为3:
...省略...
DEBUG [main] - ==> Preparing: select max(id) + 1 from USER
DEBUG [main] - ==> Parameters:
DEBUG [main] - <== Total: 1
DEBUG [main] - ==> Preparing: insert into USER (name, role_id) values (?, ?)
DEBUG [main] - ==> Parameters: panda2(String), 2(Integer)
DEBUG [main] - <== Updates: 1
DEBUG [main] - 理论新增用户ID为:3
DEBUG [main] - ==> Preparing: SELECT * FROM USER
DEBUG [main] - ==> Parameters:
DEBUG [main] - <== Total: 3
DEBUG [main] - 实际新增用户ID为:3
...省略...
仔细看上面的日志信息,很明显select max(id) + 1 from USER语句先执行,insert into USER (name, role_id) values (?, ?)语句后执行.
如果我们调整上面selectKey元素的order属性配置为AFTER:
...省略...
DEBUG [main] - ==> Preparing: insert into USER (name, role_id) values (?, ?)
DEBUG [main] - ==> Parameters: panda2(String), 2(Integer)
DEBUG [main] - <== Updates: 1
DEBUG [main] - ==> Preparing: select max(id) + 1 from USER
DEBUG [main] - ==> Parameters:
DEBUG [main] - <== Total: 1
DEBUG [main] - 理论新增用户ID为:4
DEBUG [main] - ==> Preparing: SELECT * FROM USER
DEBUG [main] - ==> Parameters:
DEBUG [main] - <== Total: 3
DEBUG [main] - 实际新增用户ID为:3
...省略...
insert into USER (name, role_id) values (?, ?)语句将会在select max(id) + 1 from USER语句之前执行,这时候我们就得到了一个错误的用户ID数据.
因此,当使用selectKey元素的时候,我们需要正确配置其order属性.
selectKey元素也拥有keyProperty和keyColumn两个属性定义,在运行过程中,mybatis将会从selectKey元素对应的查询结果对象中取出keyColumn指定的属性,并将其赋值给通过keyProperty属性来指定的方法入参对象的属性.
上面这句话可能比较绕,我们通过一个测试代码来看一下:
select id, name +'_suffix' as name ,role_id as roleId from USER ORDER BY id DESC LIMIT 0,1
insert into USER
(name, role_id)
values (#{name}, #{roleId})
单元测试类:
@Test
public void insertWithSelectKeyAndKeyColumn() {
@Cleanup
SqlSession sqlSession = sqlSessionFactory.openSession();
Mapper mapper = sqlSession.getMapper(Mapper.class);
User param = new User();
param.setName("panda2");
param.setRoleId(2);
log.debug("原始param对象数据为:{}",param);
assert mapper.insertWithSelectKeyAndKeyColumn(param) >0;
log.debug("语句执行后对象数据为:{}",param);
}
单元测试的关键运行日志如下:
DEBUG [main] - 原始param对象数据为:User(id=null, name=panda2, roleId=2)
DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Setting autocommit to false on JDBC Connection [org.hsqldb.jdbc.JDBCConnection@1cf2fed4]
DEBUG [main] - ==> Preparing: insert into USER (name, role_id) values (?, ?)
DEBUG [main] - ==> Parameters: panda2(String), 2(Integer)
DEBUG [main] - <== Updates: 1
DEBUG [main] - ==> Preparing: select id, name +'_suffix' as name ,role_id as roleId from USER ORDER BY id DESC LIMIT 0,1
DEBUG [main] - ==> Parameters:
DEBUG [main] - <== Total: 1
DEBUG [main] - 语句执行后对象数据为:User(id=3, name=panda2_suffix, roleId=2)
在上面的单元测试中,我们创建了一个名为param的User对象:
| id | name | roleId |
|---|---|---|
null |
panda2 | 2 |
并将该对象作为入参传递给了insertWithSelectKeyAndKeyColumn()方法,在方法执行完毕之后,我们的param对象数据发生了变化,不仅被填充了id属性,就连name属性的值也和原来不同了:
| id | name | roleId |
|---|---|---|
| 3 | panda2_suffix | 2 |
这其中究竟发生了什么呢?
注意看上面insertWithSelectKeyAndKeyColumn()方法的xml配置,根据其中selectKey元素的配置,在insert语句执行完毕之后,将会执行select语句来获取id最大的User记录,并把该记录转换为User对象,这里将查询到的User对象称之为selectKeyUser.
select语句:
select id, name +'_suffix' as name ,role_id as roleId from USER ORDER BY id DESC LIMIT 0,1
selectKeyUser的数据记录:
| id | name | roleId |
|---|---|---|
| 3 | panda2_suffix | 2 |
之后根据selectKey元素的keyProperty和keyColumn属性的配置,selectKeyUser对象的id,name,roleId这三个属性的值,将会赋给param对象中的同名属性:
因此,当insertWithSelectKeyAndKeyColumn()方法执行完成之后,param对象的数据就发生了奇妙的变化:
delete元素
相对而言,delete元素的DTD定义比insert/update还要简单一些:
delete元素用于配置删除语句,通常来说,完成数据删除操作之后,我们并不需要获取被删除数据的主键信息,因此delete元素不支持用于配置主键的属性.
除此之外,delete元素和insert/update元素并无不同之处.
总结
这篇文章,我们了解了insert,update以及delete元素的属性及其用法,内容不算多,相对而言,比较好理解.
最近工作比较忙,因此博客的更新间隔稍微有些长.
加油~
最后附上完整的思维导图: