MyBatis-Flex 的增删改功能

MyBatis-Flex 内置了一个名为 BaseMapper 的接口，它实现了基本的增删改查功能以及分页查询功能。

MyBatis-Flex 的 代码生成器 生成的所有 Mapper 辅助类，都是继承 BaseMapper。

新增数据

BaseMapper 的接口提供了 insert 和 insertBatch 方法，用于新增数据；

• insert(entity)：插入实体类数据，不忽略 null 值。
• insertSelective(entity)：插入实体类数据，但是忽略 null 的数据，只对有值的内容进行插入。这样的好处是数据库已经配置了一些默认值，这些默认值才会生效。
• insert(entity, ignoreNulls)：插入实体类数据。
• insertWithPk(entity)：插入带有主键的实体类，不忽略 null 值。
• insertSelectiveWithPk(entity)：插入带有主键的实体类，忽略 null 值。
• insertWithPk(entity, ignoreNulls)：带有主键的插入，此时实体类不会经过主键生成器生成主键。
• insertBatch(entities)：批量插入实体类数据，只会根据第一条数据来构建插入的字段内容。
• insertBatch(entities, size)：批量插入实体类数据，按 size 切分。
• insertOrUpdate(entity)：插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都不会忽略 null 值。
• insertOrUpdateSelective(entity)：插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都会忽略 null 值。
• insertOrUpdate(entity, ignoreNulls)：插入或者更新，若主键有值，则更新，若没有主键值，则插入。

用 UpdateWrapper 新增数据 ^ v1.5.8

在某些场景下，我们希望在新增数据时，新增数据字段内容是数据库的某个 函数 或者 SQL片段 生成的内容，而非我们手动设置的内容。 例如，我们希望执行的 SQL 如下：

INSERT INTO `tb_account`(`user_name`,  `birthday`)
VALUES (?, now())

以上 SQL 中，birthday 是由 now() 函数生成的内容。

那么，java 代码如下：

@Test
public void testInsertWithRaw() {
    Account account = new Account();
    account.setUserName("michael");

    Account newAccount = UpdateWrapper.of(account)
//       .setRaw("birthday", "now()")
//       .setRaw(ACCOUNT.BIRTHDAY, "now()")
        .setRaw(Account::getBirthday, "now()")
        .toEntity();

    accountMapper.insert(newAccount);
}

或者复杂一点的：

@Test
public void testInsertWithRaw() {
    Account account = new Account();
    account.setUserName("michael");

    Account newAccount = UpdateWrapper.of(account)
        .setRaw(Account::getBirthday, "(select xxx from ...)")
        .toEntity();

    accountMapper.insert(newAccount);
}

其生成的 SQL 如下：

INSERT INTO `tb_account`(`user_name`,  `birthday`)
VALUES (?, (select xxx from ...))

注意，通过 UpdateWrapper.setRaw() 的设置，会覆盖注解 @Column.onUpdateValue 配置的内容。

删除数据

BaseMapper 的接口提供了 deleteById、deleteBatchByIds、deleteByMap、deleteByQuery 方法，用于删除数据；

• deleteById(id)：根据主键删除数据。如果是多个主键的情况下，需要传入数组，例如：new Integer[]{100,101}。
• delete(entity)：根据实体主键来删除数据。相比deleteById(id)，此方法更便于对复合主键实体类的删除。
• deleteBatchByIds(ids)：根据多个主键批量删除数据。
• deleteBatchByIds(ids, size)：根据多个主键批量删除数据。
• deleteByMap(whereConditions)：根据 Map 构建的条件来删除数据。
• deleteByCondition(whereConditions)：根据查询条件来删除数据。
• deleteByQuery(queryWrapper)：根据查询条件来删除数据。

deleteByQuery(queryWrapper) 方法示例：

QueryWrapper queryWrapper = QueryWrapper.create();
queryWrapper.where(ACCOUNT.ID.ge(100));

//通过 queryWrapper 删除
accountMapper.deleteByQuery(queryWrapper);

deleteByCondition(condition) 方法示例：

accountMapper.deleteByCondition(ACCOUNT.ID.ge(100));

以上的代码，会删除所有 id >= 100 的数据，其执行的 Sql 如下：

delete from tb_account where id >= 100;

tip: QueryWrapper 非常灵活，也是 MyBatis-Flex 的特色之一，更多关于 QueryWrapper 的 请看 QueryWrapper 章节。

更新数据

BaseMapper 的接口提供了 update、updateByMap、updateByQuery 方法，用于更新数据；

• update(entity)：根据主键来更新数据，若实体类属性数据为 null，该属性不会更新到数据库。
• update(entity, ignoreNulls)：根据主键来更新数据到数据库。
• updateByMap(entity, whereConditions)：根据 Map 构建的条件来更新数据。
• updateByMap(entity, ignoreNulls, whereConditions)：根据 Map 构建的条件来更新数据。
• updateByCondition(entity, whereConditions)：根据查询条件来更新数据。
• updateByCondition(entity, ignoreNulls, whereConditions)：根据查询条件来更新数据。
• updateByQuery(entity, queryWrapper)：根据查询条件来更新数据。
• updateByQuery(entity, ignoreNulls, queryWrapper)：根据查询条件来更新数据。
• updateNumberAddByQuery(fieldName, value, queryWrapper)：执行类似 update table set field = field + 1 where ... 的场景。
• updateNumberAddByQuery(column, value, queryWrapper)：执行类似 update table set field = field + 1 where ... 的场景。
• updateNumberAddByQuery(fn, value, queryWrapper)：执行类似 update table set field = field + 1 where ... 的场景。

部分字段更新

在很多场景下，我们希望只更新部分字段，而更新的字段中，一些为 null，一些非 null。此时需要用到 UpdateEntity 工具类，以下是示例代码：

Account account = UpdateEntity.of(Account.class, 100);
//Account account = UpdateEntity.of(Account.class);
//account.setId(100);

account.setUserName(null);
account.setAge(10);

accountMapper.update(account);

以上的示例中，会把 id (主键)为 100 这条数据中的 user_name 字段更新为 null，age 字段更新为 10，其他字段不会被更新。

也就是说，通过 UpdateEntity 创建的对象，只会更新调用了 setter 方法的字段，若不调用 setter 方法，不管这个对象里的属性的值是什么，都不会更新到数据库。

其执行的 sql 内容如下：

update tb_account
set user_name = ?, age = ? where id = ?
#参数: null,10,100

注意：

Account account = UpdateEntity.of(Account.class, 100);

等同于：

Account account = UpdateEntity.of(Account.class);
account.setId(100);

部分字段更新（增强）

在以上的部分字段更新中，只能更新为用户传入的数据，但是有些时候我们想更新为数据库计算的数据，比如 SQL：

update tb_account
set user_name = ?, age = age + 1 where id = ?

此时，我们可以直接把 Account 强转为 UpdateWrapper 然后进行更新，例如：

Account account = UpdateEntity.of(Account.class, 100);

account.setUserName(null);

// 通过 UpdateWrapper 操作 account 数据
UpdateWrapper wrapper = UpdateWrapper.of(account);
wrapper.setRaw("age", "age + 1");

accountMapper.update(account);

其执行的 SQL 为：

update tb_account
set user_name = null, age = age + 1 where id = 100

更高级的用法

示例1：

Account account = UpdateEntity.of(Account.class, 100);

account.setUserName("Michael");

// 通过 UpdateWrapper 操作 account 数据
UpdateWrapper wrapper = UpdateWrapper.of(account);
wrapper.set(ACCOUNT.AGE, ACCOUNT.AGE.add(1));

accountMapper.update(account);

其执行的 SQL 为：

update tb_account
set user_name = "michael", age = age + 1 where id = 100

示例2：

Account account = UpdateEntity.of(Account.class, 100);

account.setUserName("Michael");

// 通过 UpdateWrapper 操作 account 数据
UpdateWrapper wrapper = UpdateWrapper.of(account);
wrapper.set(ACCOUNT.AGE, select().from(...));

accountMapper.update(account);

其执行的 SQL 为：

update tb_account
set user_name = "michael", age = (select ... from ... )
where id = 100

UpdateChain

UpdateChain 是一个对 UpdateEntity、UpdateWrapper 等进行封装的一个工具类，方便用户用于进行链式操作。

假设我们要更新 Account 的 userName 为 "张三"，更新年龄在之前的基础上加 1，更新代码如下：

@Test
public void testUpdateChain() {
    UpdateChain.of(Account.class)
        .set(Account::getUserName, "张三")
        .setRaw(Account::getAge, "age + 1")
        .where(Account::getId).eq(1)
        .update();
}

以上方法调用时，MyBatis-Flex 内部执行的 SQL 如下：

UPDATE `tb_account` SET `user_name` = '张三' , `age` = age + 1
WHERE `id` = 1

更多关于 链式操作，请点击这个 这里。

set() 和 setRaw() 的区别

在 Row、UpdateWrapper、UpdateChain 中，都提供了 set() 和 setRaw() 两个方法用于设置数据。 那么，他们有什么区别呢？

• set() 方法用于设置参数数据。
• setRaw() 用于设置 SQL 拼接数据。

例如：

UpdateChain.of(Account.class)
    .set(Account::getUserName, "张三")
    .where(Account::getId).eq(1)
    .update();

其执行的 SQL 如下：

UPDATE `tb_account` SET `user_name` = ? WHERE `id` = 1

如果是使用 setRaw() 方法：

UpdateChain.of(Account.class)
    .setRaw(Account::getUserName, "张三")
    .where(Account::getId).eq(1)
    .update();

以上代码执行时，参数 "张三" 会直接参与 SQL 拼接，可能会造成 SQL 错误，其 SQL 如下：

UPDATE `tb_account` SET `user_name` = 张三 WHERE `id` = 1

因此，需要用户 【特别注意!!!】，setRaw() 传入不恰当的参数时，可能会造成 SQL 注入的危险。 因此，调用 setRaw() 方法时，需要开发者自行对其参数进行 SQL 注入过滤。

setRaw() 经常使用的场景：

• 场景1： 用户充值，更新用户金额：

UpdateChain.of(Account.class)
    .setRaw(Account::getMoney, "money + 100")
    .where(Account::getId).eq(1)
    .update();

其执行的 SQL 如下：

UPDATE `tb_account` SET  `money` = money + 100
WHERE `id` = 1

• 场景2：执行某些特殊函数：

UpdateChain.of(Account.class)
    .setRaw(Account::getUserName, "UPPER(user_name)")
    .where(Account::getId).eq(1)
    .update();

其执行的 SQL 如下：

UPDATE tb_account SET  user_name = UPPER(user_name)
WHERE id = 1

或者

UpdateChain.of(Account.class)
    .setRaw(Account::getUserName, "utl_raw.cast_to_raw('some magic here')")
    .where(Account::getId).eq(1)
    .update();

其执行的 SQL 如下：

UPDATE tb_account SET  user_name = utl_raw.cast_to_raw('some magic here')
WHERE id = 1