mybatis-plus的批量新增insertBatchSomeColumn

Posted 2023-03-30 暗武逢天

MyBatis-Plus 是基于 MyBatis 进行封装的一套优秀的持久层框架，它提供了丰富的便捷操作方法和强大的代码生成器，大大简化了 MyBatis 的使用。在 MyBatis-Plus 中，我们可以使用 insertBatchSomeColumn 方法来实现批量新增指定字段的操作。

mybatis-plus的 IService接口 默认提供 saveBatch批量插入，也是唯一一个默认批量插入，在数据量不是很大的情况下可以直接使用，但这种是一条一条执行的效率上会有一定的瓶颈，在这里先看下saveBatch的执行情况

 

 

 

可以看到sql语句是一条一条执行的,插入多少条数据就相当于执行了多少次的插入sql, 点进saveBatch方法，看看内部是怎么实现的

 

 注意看，方法有一个事务注解，说明插入整批数据会作为一个事务进行,

默认1000条一次，怪不得执行时每隔1000条会处于一个准备执行状态，等待几秒后才会往下执行（这里等待的时间就是1000个单条的insert语句执行的时间）

再往下点是一个saveBatch接口，参数分别是插入的对象集合、插入批次数量也就是默认的1000

这里也有一个事务的注解，这是因为saveBatch是一个重载方法，插入的时候也可以指定插入批次数量调用

继续往下进入executeBatch

 

 

这里就是真正执行的方法了，idxLimit会对比DEFAULT_BATCH_SIZE和集合长度两个数中的最小数，作为批量大小，也就是说当集合长度不够1000，那么执行的时候批量大小就是集合的长度，就执行一次。

for循环中的consumer：对应的类型是一个函数式接口，代表一个接受两个输入参数且不返回任何内容的操作符。意思是给定两个参数sqlSession、循环中当前element对象，执行一次传递过来的consumer匿名函数。也就是上边源码里的插入匿名函数。
 

当i == indLimit时：执行一次预插入，并重新计算idxLimit的值

if中idxLimit计算规则：当前idxLimit加batchSize(默认1000) 和 集合长度 取最小值，计算出来的结果肯定不会超过集合的长度，最后的批次时idxLimit等于集合的长度，将这个值作为下一次执行预插入的时间点。

sqlSession.flushStatements()：当有处于事务中的时候，起到一种预插入的作用，执行了这行代码之后,要插入的数据会锁定数据库的一行记录,并把数据库默认返回的主键赋值给插入的对象,这样就可以把该对象的主键赋值给其他需要的对象中去了，这里不是事务提交啊。

最后方法执行完后@Transactional注解会默认提交事务，如果调用的方法上还有@Transactional注解，默认的事务传播类型是Propagation.REQUIRED，不会新开启事务，如果没有@Transactional注解才会新开起事务

下面我们使用真正的批量新增方法insertBatchSomeColumn,看看两者的区别

1. 什么是批量新增指定字段

批量新增指定字段是指在一次 SQL 语句中执行多条 INSERT 语句，但是只插入指定的字段。批量新增指定字段可以提高数据操作效率，减少数据库与应用程序之间的网络传输次数，减轻数据库服务器的压力，提高系统的并发性能。

2. MyBatis-Plus 批量新增指定字段的方法的使用

mybatis-plus提供了InsertBatchSomeColumn批量insert方法。通过SQL 自动注入器接口 ISqlInjector注入通用方法 SQL 语句 然后继承 BaseMapper 添加自定义方法，全局配置 sqlInjector 注入 MP 会自动将类所有方法注入到 mybatis 容器中。我们需要通过这种方式注入下。
 

/**
 * 自定义Sql注入
 *
 */

public class EasySqlInjector extends DefaultSqlInjector 
    
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) 
        // 注意：此SQL注入器继承了DefaultSqlInjector(默认注入器)，调用了DefaultSqlInjector的getMethodList方法，保留了mybatis-plus的自带方法
        List<AbstractMethod> methodList = super.getMethodList(mapperClass, tableInfo);
        methodList.add(new InsertBatchSomeColumn(i -> i.getFieldFill() != FieldFill.UPDATE));
        return methodList;
    

 自定义EasyBaseMapper

/**
 * @author 武天
 * @date 2023/3/22 18:19
 */
public interface EasyBaseMapper<T> extends BaseMapper<T> 
    /**
     * 批量插入 仅适用于mysql
     *
     * @param entityList 实体列表
     * @return 影响行数
     */
    Integer insertBatchSomeColumn(Collection<T> entityList);

 mapper继承的这里改为继承刚书写的自定义mapper

/**
 * 
 * 
 * @author wutian
 * @email $email
 * @date 2022-10-03 22:12:06
 */
@Mapper
public interface BreakDownCluesDao extends EasyBaseMapper<ExcelBreakdownClues> 

调用测试

 

可以看到明显的区别,sql只执行了一条,后面都是入参逗号相隔的形式,耗时也有所优化,这是插入数量不是很多的情况,如果是上万条或者上千万条数据,这种形式的优越性就体现出来了 

3. 批量新增指定字段的注意事项

在使用 MyBatis-Plus 进行批量新增指定字段时，需要注意以下几点：

• 每次新增的数据量不要过大，建议每批次新增的数据量控制在 1000 条以内。
• 要新增的指定字段不能为 null，需要手动设置默认值。
• 如果要新增的指定字段在实体类中有对应的字段值，会被忽略。

MyBatis-plus 新增实例，主键ID从很大的数字开始

mybatis-plus是mybatis增强版，用mybatis-plus可以省去很多DAO层代码和数据库操作语句的编写。但是需要我们配置好条件。

情景：

　　向数据库新增一条实例，我们要调用 insert(T t)方法；向数据库批量新增实例，我们调用inserBatch(List<T> list)方法。

当然，这些都是mybatis-plus已经封装好的，我们直接用，DAO层代码和xml文件不用自己编写。但是，我们数据库新增实例，主键ID一般都是自增长的，不用人工给它赋值。

那么mybatis-plus在新增的时候，会出现主键ID从很大的数字开始（example ‘17629802347414’），而不是从1开始的。原因就在于，mybatis-plus在新增的时候，会给一个主键ID，

并且这个数字不规范，还不连续。这时候我们需要忽略掉这一点，不需要mybatis-plus给我们ID。

配置Bean对象：

 

 给主键ID属性，加上一个Type，设置为自动，这样mybatis-plus就会忽略掉主键，转而用数据库自己的自增长模式。