tkMapper 通用mapper的批量更新 批量新增 官方实现 springboot项目 依赖引入

文章目录

• • 场景
  • 官方插件
  • 源码解析
  • 项目细节
  • 小结

场景

在许多业务场景下，需要对tkMapper的功能进行增强，需要用到批量新增和批量更新（这里是唯一主键去更新的），许多论文博客自己写的看起来并不行，我们这里就采用官方的模式，一次跑通

官方插件

这里是我通过中央仓库发现的一个宝库，平常对额外功能的增强需要自己常在中央仓库去逛逛看。

依赖地址：

<dependency>
     <groupId>tk.mybatis</groupId>
     <artifactId>mapper-spring-boot-starter</artifactId>
     <version>4.2.3</version>
</dependency>
<dependency>
     <groupId>tk.mybatis</groupId>
     <artifactId>mapper-extra</artifactId>
     <version>4.2.3</version>
</dependency>

starter是启动器，extra则是扩展插件，里面就有我们所需的功能

源码解析

我们来看看官方作者的实现方式到底是什么，看看这个具体的provider的实现原理，其实底层就是foreach

package tk.mybatis.mapper.additional.update.batch;

import java.util.List;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.UpdateProvider;
import tk.mybatis.mapper.annotation.RegisterMapper;

@RegisterMapper
public interface BatchUpdateMapper<T> {
    @UpdateProvider(
        type = BatchUpdateProvider.class,
        method = "dynamicSQL"
    )
    void batchUpdate(@Param("list") List<? extends T> recordList);
}

package tk.mybatis.mapper.additional.update.batch;

import org.apache.ibatis.mapping.MappedStatement;
import tk.mybatis.mapper.mapperhelper.MapperHelper;
import tk.mybatis.mapper.mapperhelper.MapperTemplate;
import tk.mybatis.mapper.mapperhelper.SqlHelper;

public class BatchUpdateProvider extends MapperTemplate {
    public BatchUpdateProvider(Class<?> mapperClass, MapperHelper mapperHelper) {
        super(mapperClass, mapperHelper);
    }

    public String batchUpdate(MappedStatement ms) {
        Class<?> entityClass = this.getEntityClass(ms);
        StringBuilder sql = new StringBuilder();
        sql.append("<foreach collection=\"list\" item=\"record\" separator=\";\" >");
        sql.append(SqlHelper.updateTable(entityClass, this.tableName(entityClass)));
        sql.append(SqlHelper.updateSetColumns(entityClass, "record", false, false));
        sql.append(SqlHelper.wherePKColumns(entityClass, "record", true));
        sql.append("</foreach>");
        return sql.toString();
    }

    public String batchUpdateSelective(MappedStatement ms) {
        Class<?> entityClass = this.getEntityClass(ms);
        StringBuilder sql = new StringBuilder();
        sql.append("<foreach collection=\"list\" item=\"record\" separator=\";\" >");
        sql.append(SqlHelper.updateTable(entityClass, this.tableName(entityClass)));
        sql.append(SqlHelper.updateSetColumns(entityClass, "record", true, this.isNotEmpty()));
        sql.append(SqlHelper.wherePKColumns(entityClass, "record", true));
        sql.append("</foreach>");
        return sql.toString();
    }
}

项目细节

我们通常在自己的项目，都要所有的mapper都是继承我们自定义的BaseMapper，这里我也给上我常用的，后续要扩展功能，只要在BaseMapper上扩展即可

import tk.mybatis.mapper.additional.idlist.IdListMapper;
import tk.mybatis.mapper.additional.update.batch.BatchUpdateMapper;
import tk.mybatis.mapper.annotation.RegisterMapper;
import tk.mybatis.mapper.common.IdsMapper;
import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.special.InsertListMapper;

/**
 * BaseMapper
 * TIP:basePackage的属性值 不能包含通用mapper所在的包,所以不能放在./mapper下，启动会报错
 *
 * @param <T>
 */
@RegisterMapper
public interface BaseMapper<T> extends Mapper<T>, IdListMapper<T, Long>, IdsMapper<T>, InsertListMapper<T>, BatchUpdateMapper<T> {

}

小结

希望能够帮到你，总之我知道要实现的什么功能最好去看看作者的作品