JeecgBoot 3.6.1中MyBatisPlus IService接口深度解析与应用场景实战

JeecgBoot 3.6.1中MyBatisPlus IService接口深度解析与应用场景实战

我们以下示例解析与应用场景以User为例，假设我们有一个User实体类，包含id（主键）、username（用户名）、password（密码）等属性，并且已经在MyBatis-Plus中配置了相关映射关系

一、插入一条记录（选择字段，策略插入）

1、接口代码示例

    /**
     * 默认批次提交数量
     */
    int DEFAULT_BATCH_SIZE = 1000;

    /**
     * 插入一条记录（选择字段，策略插入）
     *
     * @param entity 实体对象
     */
    default boolean save(T entity) {
   
        return SqlHelper.retBool(getBaseMapper().insert(entity));
    }

2、变量解释

DEFAULT_BATCH_SIZE：这是默认的批量处理数据的数量，例如在进行批量插入、更新等操作时，如果未指定批次大小，则会使用这个默认值，下面的代码中出现此变量则对此不作赘述。

3、方法解析

这个方法是针对泛型T（这里的T为User）的一个插入方法。在具体应用中，当你有一个User对象需要持久化到数据库时，可以直接调用此方法。
getBaseMapper()：这是MyBatis-Plus中的一个方法，用于获取当前实体类（如User）对应的通用Mapper接口，该接口提供了基本的CRUD操作。
insert(entity)：在获取到的BaseMapper中调用insert方法，将传入的User对象插入到数据库中。由于是“策略插入”，框架会根据User类的注解信息（如@TableField注解标记的主键策略等）智能决定插入方式。

4、应用场景实战

User user = new User();
user.setUsername("testUser");
user.setPassword("testPassword");

// 调用save方法插入新用户
boolean isSuccess = userService.save(user);

在这段代码中，userService是一个注入了UserMapper接口的对象，而UserMapper继承自BaseMapper，因此可以调用save方法。通过这个方法，我们就能便捷地将一个新创建的User对象插入到数据库中，无需关心具体的SQL语句编写和执行。同时，SqlHelper.retBool会对执行结果进行处理，返回一个布尔值表示插入是否成功。

二、插入（批量）

1、接口示例代码

    /**
     * 插入（批量）
     *
     * @param entityList 实体对象集合
     */
    @Transactional(rollbackFor = Exception.class)
    default boolean saveBatch(Collection<T> entityList) {
   
        return saveBatch(entityList, DEFAULT_BATCH_SIZE);
    }

    /**
     * 插入（批量）
     *
     * @param entityList 实体对象集合
     * @param batchSize  插入批次数量
     */
    boolean saveBatch(Collection<T> entityList, int batchSize);

2、方法解析

方法一：

@Transactional(rollbackFor = Exception.class)
default boolean saveBatch(Collection<T> entityList) {
   
    return saveBatch(entityList, DEFAULT_BATCH_SIZE);
}

此方法接收一个实体对象集合作为参数，它默认按照DEFAULT_BATCH_SIZE定义的批次大小进行插入。@Transactional注解表明该方法在一个事务中执行，如果在批量插入过程中发生任何异常，整个事务将会回滚，确保数据的一致性。如果插入过程中出现Exception异常，事务会自动回滚。

方法二：

boolean saveBatch(Collection<T> entityList, int batchSize);

这个方法同样接收一个实体对象集合作为参数，但多了一个batchSize参数，允许开发者自定义每个批次插入的数据量。当需要控制每次插入的数据量或者优化数据库性能时，可以使用这个方法。

3、应用场景实战

// 创建一组User对象
List<User> userList = new ArrayList<>();
for (int i = 0; i < 5000; i++) {
   
    User user = new User();
    user.setUsername("user" + i);
    user.setPassword("password");
    userList.add(user);
}

// 使用默认批次大小插入
boolean result1 = userService.saveBatch(userList);

// 或者，自定义批次大小插入
int customBatchSize = 500;
boolean result2 = userService.saveBatch(userList, customBatchSize);

在这段示例代码中，首先创建了5000个User对象，然后分别使用默认批次大小和自定义批次大小进行批量插入。这样能有效避免一次性执行大量SQL语句导致数据库压力过大，提高程序性能。

三、批量修改插入

1、接口示例代码

    /**
     * 批量修改插入
     *
     * @param entityList 实体对象集合
     */
    @Transactional(rollbackFor = Exception.class)
    default boolean saveOrUpdateBatch(Collection<T> entityList) {
   
        return saveOrUpdateBatch(entityList, DEFAULT_BATCH_SIZE);
    }

    /**
     * 批量修改插入
     *
     * @param entityList 实体对象集合
     * @param batchSize  每次的数量
     */
    boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);

2、方法解析

这两个方法是针对批量修改或插入操作的实现，在MyBatis-Plus等ORM框架中常见，主要用于处理大批量数据时，既能够更新已存在记录，又能插入新记录的操作。

方法一：

@Transactional(rollbackFor = Exception.class)
default boolean saveOrUpdateBatch(Collection<T> entityList) {
   
    return saveOrUpdateBatch(entityList, DEFAULT_BATCH_SIZE);
}

此方法接收一个实体对象集合作为参数，并使用默认批次大小DEFAULT_BATCH_SIZE进行批量修改或插入操作。若实体对象集合中的某个对象在数据库中有对应的主键（即已存在的记录），则执行更新操作；若无对应主键记录，则执行插入操作。同时，整个方法被@Transactional注解包裹，意味着在遇到异常时会触发事务回滚，保证数据一致性。

方法二：

boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);

此方法与第一个方法类似，不同之处在于允许开发者自定义批次大小。根据给定的batchSize参数，将实体对象集合按批处理，每批执行一定数量的修改或插入操作。

3、应用场景实战

// 创建一组User对象，其中部分已在数据库中存在（具有唯一标识符如ID）
List<User> userList = new ArrayList<>();
for (int i = 0; i < 5000; i++) {
   
    User user = new User();
    if (i % 2 == 0) {
    // 假设有偶数ID的用户已存在于数据库
        user.setId(i);
    }
    user.setUsername("user" + i);
    user.setPassword("password");
    userList.add(user);
}

// 使用默认批次大小进行批量修改或插入
boolean result1 = userService.saveOrUpdateBatch(userList);

// 或者，自定义批次大小进行批量修改或插入
int customBatchSize = 500;
boolean result2 = userService.saveOrUpdateBatch(userList, customBatchSize);

在这段示例代码中，创建了5000个User对象，其中一半（偶数ID）假设已经在数据库中存在。通过调用saveOrUpdateBatch方法，系统会根据实体对象中的ID判断是执行更新操作还是插入操作，从而实现批量修改或插入功能。同时，可以根据实际需求调整批次大小，优化数据库操作效率。

四、删除

1、接口示例代码

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     */
    default boolean removeById(Serializable id) {
   
        return SqlHelper.retBool(getBaseMapper().deleteById(id));
    }

    /**
     * 根据 ID 删除
     *
     * @param id      主键(类型必须与实体类型字段保持一致)
     * @param useFill 是否启用填充(为true的情况,会将入参转换实体进行delete删除)
     * @return 删除结果
     * @since 3.5.0
     */
    default boolean removeById(Serializable id, boolean useFill) {
   
        throw new UnsupportedOperationException("不支持的方法!");
    }

    /**
     * 根据实体(ID)删除
     *
     * @param entity 实体
     * @since 3.4.4
     */
    default boolean removeById(T entity) {
   
        return SqlHelper.retBool(getBaseMapper().deleteById(entity));
    }

    /**
     * 根据 columnMap 条件，删除记录
     *
     * @param columnMap 表字段 map 对象
     */
    default boolean removeByMap(Map<String, Object> columnMap) {
   
        Assert.notEmpty(columnMap, "error: columnMap must not be empty");
        return SqlHelper.retBool(getBaseMapper().deleteByMap(columnMap));
    }

    /**
     * 根据 entity 条件，删除记录
     *
     * @param queryWrapper 实体包装类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     */
    default boolean remove(Wrapper<T> queryWrapper) {
   
        return SqlHelper.retBool(getBaseMapper().delete(queryWrapper));
    }

    /**
     * 删除（根据ID 批量删除）
     *
     * @param list 主键ID或实体列表
     */
    default boolean removeByIds(Collection<?> list) {
   
        if (CollectionUtils.isEmpty(list)) {
   
            return false;
        }
        return SqlHelper.