Mybatis-Plus自定义SQL注入器实现批量插入功能

背景介绍

Mybatis-Plus作为Mybatis的增强工具，提供了许多便捷的CRUD操作方法。但在实际开发中，我们经常需要扩展一些自定义的SQL操作方法。本文将详细介绍如何在Mybatis-Plus中通过自定义SQL注入器来实现批量插入功能。

核心概念

SQL注入器(SqlInjector)

SQL注入器是Mybatis-Plus中负责向Mapper接口注入SQL方法的组件。DefaultSqlInjector是默认实现，包含了Mybatis-Plus提供的所有基础CRUD方法。

自定义方法(AbstractMethod)

AbstractMethod是Mybatis-Plus中所有SQL方法的抽象基类，我们需要继承它来实现自定义的SQL逻辑。

实现步骤

1. 创建自定义SQL方法类

首先需要创建一个继承自AbstractMethod的类，实现批量插入逻辑：

public class InsertBatchSomeColumn extends AbstractMethod {
    
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        // 这里实现SQL语句构建逻辑
        String sql = "<script>INSERT INTO %s %s VALUES %s</script>";
        // 具体实现省略...
        return this.addInsertMappedStatement(mapperClass, modelClass, "insertBatchSomeColumn", sql, tableInfo);
    }
}

2. 扩展默认SQL注入器

创建自定义的SQL注入器，将我们的批量插入方法添加到方法列表中：

@Component
public class InsertBatchSqlInjector extends DefaultSqlInjector {
    
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) {
        // 保留原有的方法
        List<AbstractMethod> methodList = super.getMethodList(mapperClass, tableInfo);
        // 添加自定义方法
        methodList.add(new InsertBatchSomeColumn());
        return methodList;
    }
}

3. 创建基础Mapper接口

定义一个扩展了BaseMapper的接口，声明我们的批量插入方法：

public interface MyBaseMapper<T> extends BaseMapper<T> {
    
    /**
     * 批量插入方法
     * @param batchList 实体对象集合
     * @return 影响行数
     */
    int insertBatchSomeColumn(Collection<T> batchList);
}

4. 业务Mapper继承自定义接口

在实际的业务Mapper中继承我们自定义的基础Mapper：

public interface DemoMapper extends MyBaseMapper<Demo> {
    // 可以添加其他业务方法
}

注意事项

1. 配置自动生效：在Spring Boot环境中，只要将自定义的SqlInjector声明为Spring组件(@Component)，Mybatis-Plus会自动发现并使用它，无需手动配置。

2. 方法命名：自定义方法名需要与MappedStatement中的id保持一致，否则会出现"Invalid bound statement"错误。

3. SQL注入：在实现自定义SQL方法时，要注意防止SQL注入风险，特别是处理动态SQL时。

4. 性能考虑：批量操作时要注意数据量大小，避免单次操作数据量过大导致性能问题。

常见问题解决

如果在使用过程中遇到"Invalid bound statement"错误，可以检查以下几点：

1. 确认自定义方法是否正确定义在Mapper接口中
2. 检查SqlInjector是否被正确加载
3. 验证方法名是否在MappedStatement中保持一致
4. 确保没有重复配置SqlInjector

通过以上步骤，我们就可以在Mybatis-Plus中成功扩展自定义的批量插入方法，既保留了框架原有的便捷性，又满足了特定业务场景的需求。