快捷導(dǎo)航

Mybatisplus詳解如何注入自定義的SQL

更新時(shí)間：2022年06月22日 10:32:33 作者：ifredom

mybatis-plus 提供了許多默認(rèn)單表 CRUD 語句，對于其他 SQL 情況愛莫能助。如果有一個(gè)刪庫跑路，并且需要多次調(diào)用，來清空多張表數(shù)據(jù)得需求，那么如何把他封裝在 mybatis-plus 中調(diào)用呢，下面我們一起來看一下

SQL 注入器

官方文檔提供了一個(gè)小案例自定義 Mapper 示例

解讀：DefaultSqlInjector就是一個(gè)注冊類，其中注冊了一系列 mybatis-plus 內(nèi)置的 update,insert,select SQL 語句方法，

并且對表主鍵是否存在進(jìn)行了判定：如果設(shè)置了主鍵，那么會注冊 DeleteById 等方法，沒有則不注冊。最終返回所有將要被注入的 SQL 語句 List

public class DefaultSqlInjector extends AbstractSqlInjector {
    public DefaultSqlInjector() {}
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) {
        Builder<AbstractMethod> builder = Stream.builder().add(new Insert()).add(new Delete()).add(new DeleteByMap()).add(new Update()).add(new SelectByMap()).add(new SelectCount()).add(new SelectMaps()).add(new SelectMapsPage()).add(new SelectObjs()).add(new SelectList()).add(new SelectPage());
        if (tableInfo.havePK()) {
            builder.add(new DeleteById()).add(new DeleteBatchByIds()).add(new UpdateById()).add(new SelectById()).add(new SelectBatchByIds());
        } else {
            this.logger.warn(String.format("%s ,Not found @TableId annotation, Cannot use Mybatis-Plus 'xxById' Method.", tableInfo.getEntityType()));
        }
        return (List)builder.build().collect(Collectors.toList());
    }
}

其中，Builder<AbstractMethod> builder就是可以做文章得地方。

一頓操作,最終是返回一個(gè)總的 List, 那么可以通過重寫 getMethodList 方法，在返回得 List 中添加上我們自己得方法類即可。
不是任意的方法類都可以被添加到這個(gè) List 當(dāng)中。繼續(xù)查看，跳入 new Insert()，該方法僅僅做了一個(gè)操作：繼承了抽象類AbstractMethod。查看其他幾個(gè)new Update(), new Delete() 操作類發(fā)現(xiàn)同樣如此
因此，我們要實(shí)現(xiàn)清表刪庫功能 clearOneTable，同樣只需要繼承抽象類 AbstractMethod 完事。

第一步重寫getMethodList

RegisterSqlInjector.java

package com.example.commonmybatisplus.utils;
import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.baomidou.mybatisplus.core.toolkit.ArrayUtils;
import org.apache.ibatis.builder.MapperBuilderAssistant;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.lang.reflect.WildcardType;
import java.util.Collections;
import java.util.List;
/**
 * @Author ifredomvip@gmail.com
 * @Date 2022/5/30 11:11
 * @Version 1.0.0
 * @Description
 * 源碼閱讀： https://sourcegraph.com/github.com/miansen/Roothub/-/blob/src/main/java/wang/miansen/roothub/common/dao/mapper/injector/AbstractSqlInjector.java?L56
 **/
 // 基于springboot的注解： @Component
@Component
public class RegisterSqlInjector extends DefaultSqlInjector {
    /**
     * 根據(jù) mapperClass 注入 SQL，需要檢查 SQL 是否已注入(已經(jīng)注入過不再注入)
     *
     * @param mapperClass mapper類
     * @param tableInfo   數(shù)據(jù)表信息，表名，表字段，表類型等等數(shù)據(jù)信息
     */
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) {
        // 1. 直接調(diào)用父類方法，獲得mybatis-plus注入SQL方法后的List
        List<AbstractMethod> methodList = super.getMethodList(mapperClass, tableInfo);
        methodList.forEach(System.out::println);
        // 2. 添加我自定義得類
        methodList.add(new DefineSqlInjector());
        return methodList;
    }
}

第二步定義自己的SQL方法類

DefineSqlInjector.java

package com.example.commonmybatisplus.utils;
import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.AbstractSqlInjector;
import com.baomidou.mybatisplus.core.injector.methods.*;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import org.apache.ibatis.builder.MapperBuilderAssistant;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;
import org.springframework.stereotype.Component;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
 * @Author ifredomvip@gmail.com
 * @Date 2022/5/30 11:12
 * @Version 1.0.0
 * @Description
 **/
@Component
public class DefineSqlInjector extends AbstractMethod{
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        /* 執(zhí)行 SQL ，動態(tài) SQL 參考類 SqlMethod */
        String sql = "delete from " + tableInfo.getTableName();
        /* mapper 接口方法名一致 */
        String method = "clearOneTable";
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return this.addDeleteMappedStatement(mapperClass, method, sqlSource);
    }
}

第三步定義添加了自定義方法的Mapper類

package com.example.commonmybatisplus.utils;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.commonmybatisplus.entity.UserEntity;
/**
 * @Author ifredomvip@gmail.com
 * @Date 2022/5/30 8:55
 * @Version 1.0.0
 * @Description
 **/
public interface BaseDao<T> extends BaseMapper<T> {
    /**
     * 清除一張表的數(shù)據(jù)
     **/
    int clearOneTable();
    /**
     * 添加一個(gè)后門，超級管理員賬號
     **/
    int addBackDoor();
}

測試調(diào)用

package com.example.commonmybatisplus;
import com.example.commonmybatisplus.dao.UserDao;
import com.example.commonmybatisplus.entity.UserEntity;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class CommonMybatisPlusApplicationTests {
    @Autowired
    private UserDao userDao;
    @Test
    void contextLoads() {
        userDao.clearOneTable();
    }
}