mybatis-plus動態(tài)數(shù)據源讀寫分離方式

更新時間：2024年10月23日 09:00:58 作者：楊村你喜哥l

在分布式項目開發(fā)中,動態(tài)數(shù)據源的配置與使用至關重要,通過創(chuàng)建DynamicDatasourceService,實現(xiàn)數(shù)據源的動態(tài)添加與調用,有效管理主從庫操作,減輕數(shù)據庫壓力,此外,通過配置類與@DS注解,實現(xiàn)了靈活的分庫查詢功能,為高效處理數(shù)據提供了強有力的支持

1、背景

在實際項目的開發(fā)過程中，一定會存在主庫與從庫的分布式模式，主庫進行增刪改，從庫進行查詢。

這樣可以保證對不同的數(shù)據庫進行操作，減少對數(shù)據庫的壓力。

2、動態(tài)數(shù)據源

創(chuàng)建DynamicDatasourceService

import com.jiuqi.grid.collection.entity.datasource.DataSourceDTO;
import java.util.Set;
public interface DynamicDatasourceService {


    /**
     * 獲取所有數(shù)據源
     *
     * @return
     */
    Set<String> datasources();


    /**
     * 添加數(shù)據源
     *
     * @param dto 數(shù)據源信息
     * @return
     */
    Set<String> add(DataSourceDTO dto);


    /**
     * 移除數(shù)據源
     *
     * @param name 連接池名稱
     */
    void remove(String name);
}

實現(xiàn)DynamicDatasourceService

package com.jiuqi.grid.collection.service.impl;

import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import com.baomidou.dynamic.datasource.creator.DefaultDataSourceCreator;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import com.jiuqi.grid.collection.entity.datasource.DataSourceDTO;
import com.jiuqi.grid.collection.service.DynamicDatasourceService;
import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service;

import javax.sql.DataSource;
import java.util.Set;

@Service
public class DynamicDatasourceServiceImpl implements DynamicDatasourceService {


    private final DataSource dataSource;

    private final DefaultDataSourceCreator dataSourceCreator;

    public DynamicDatasourceServiceImpl(
            DataSource dataSource, DefaultDataSourceCreator dataSourceCreator) {
        this.dataSource = dataSource;
        this.dataSourceCreator = dataSourceCreator;
    }


    /**
     * 獲取所有數(shù)據源
     *
     * @return
     */
    @Override
    public Set<String> datasources() {
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        return ds.getDataSources().keySet();
    }


    /**
     * 添加數(shù)據源
     *
     * @param dto
     * @return
     */
    @Override
    public Set<String> add(DataSourceDTO dto) {
        DataSourceProperty dataSourceProperty = new DataSourceProperty();
        BeanUtils.copyProperties(dto, dataSourceProperty);
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        DataSource dataSource = dataSourceCreator.createDataSource(dataSourceProperty);
        ds.addDataSource(dto.getPollName(), dataSource);
        return ds.getDataSources().keySet();
    }


    /**
     * 刪除數(shù)據源
     *
     * @param name
     */
    @Override
    public void remove(String name) {
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        ds.removeDataSource(name);
    }

}

2.1添加數(shù)據源

我這里是讀取的配置文件里的用戶名、密碼等數(shù)據源的鏈接

 public void addDatasource(String tenant) {
        if (dynamicDatasourceService.datasources().contains(tenant)) {
            return;
        }
        DataSourceDTO datasourceDTO = new DataSourceDTO();
        //庫名
        datasourceDTO.setPollName(tenant);
        //鏈接信息 讀取配置文件的主庫信息
        datasourceDTO.setDriverClassName(sqlDataSource.getDriverClassName());
        //替換數(shù)據庫
        if (StringUtils.isEmpty(sqlDataSource.getUrl())) {
            throw new RuntimeException("配置文件讀取失敗");
        }
        String url = sqlDataSource.getUrl();
        url = url.replace("grid_test", tenant);
        datasourceDTO.setUrl(url);
        datasourceDTO.setUsername(sqlDataSource.getUsername());
        datasourceDTO.setPassword(sqlDataSource.getPassword());
        dynamicDatasourceService.add(datasourceDTO);
    }

2.2數(shù)據源

調用上面的addDatasource()方法，數(shù)據源就會創(chuàng)建成功，這里要注意的是，每一次增刪改查都需要調用此方法，以防數(shù)據源不存在。

3、分庫查詢

創(chuàng)建新的數(shù)據源目的就是為了可以進行分庫操作。

分庫操作步驟如下：

3.1添加配置類

package com.jiuqi.grid.collection.dsprocessor;

import com.baomidou.dynamic.datasource.processor.DsHeaderProcessor;
import com.baomidou.dynamic.datasource.processor.DsProcessor;
import com.baomidou.dynamic.datasource.processor.DsSessionProcessor;
import com.baomidou.dynamic.datasource.processor.DsSpelExpressionProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 注冊動態(tài)數(shù)據源解析器
 */
@Configuration
public class MyDynamicDataSourceConfig {

  @Bean
  public DsProcessor dsProcessor() {
    DsMapProcessor mapProcessor = new DsMapProcessor();
    DsHeaderProcessor headerProcessor = new DsHeaderProcessor();
    DsSessionProcessor sessionProcessor = new DsSessionProcessor();
    DsSpelExpressionProcessor spelExpressionProcessor = new DsSpelExpressionProcessor();
    mapProcessor.setNextProcessor(headerProcessor);
    headerProcessor.setNextProcessor(sessionProcessor);
    sessionProcessor.setNextProcessor(spelExpressionProcessor);
    return mapProcessor;
  }
}

package com.jiuqi.grid.collection.dsprocessor;

import com.baomidou.dynamic.datasource.processor.DsProcessor;
import java.util.Map;
import com.jiuqi.grid.collection.consts.SQLConstants;
import com.jiuqi.grid.collection.dto.common.Address3DTO;
import com.jiuqi.grid.collection.dto.data.CollectionDataPageParam;
import com.jiuqi.grid.collection.entity.CollectionDataDO;
import org.aopalliance.intercept.MethodInvocation;

/**
 * 通過params map中獲取數(shù)據源標識
 *
 * @author songlude
 */
public class DsMapProcessor extends DsProcessor {

    /**
     * 抽象匹配條件 匹配才會走當前執(zhí)行器否則走下一級執(zhí)行器
     *
     * @param key DS注解里的內容
     * @return 是否匹配
     */
    @Override
    public boolean matches(String key) {
        return key.equals("#" + SQLConstants.EXEC_DATASOURCE);
    }

    /**
     * 抽象最終決定數(shù)據源
     *
     * @param invocation 方法執(zhí)行信息
     * @param key        DS注解里的內容
     * @return 數(shù)據源名稱
     */
    @Override
    public String doDetermineDatasource(MethodInvocation invocation, String key) {
        Object[] arguments = invocation.getArguments();
        Object argument = arguments[0];

        if (argument instanceof Map) {
            Map<String, Object> params = (Map<String, Object>) argument;
            Object value = params.get(SQLConstants.EXEC_DATASOURCE);
            return value == null ? null : value.toString();
        } else if (argument instanceof CollectionDataPageParam) {
            CollectionDataPageParam collectionDataPageParam = (CollectionDataPageParam) argument;
            return collectionDataPageParam.getGRID_DATASOURCE();
        } else if (argument instanceof CollectionDataDO) {
            CollectionDataDO collectionDataDO = (CollectionDataDO) argument;
            return collectionDataDO.getGRID_DATASOURCE();
        } else if (argument instanceof Address3DTO) {
            Address3DTO address3DTO = (Address3DTO) argument;
            return address3DTO.getGRID_DATASOURCE();
        }
        return null;
    }
}

這里要注意需要把“argument”進行類型的判斷，argument 就是你查詢Mapper的參數(shù)，這里我獲取的是argument[0]，則Mapper參數(shù)的位置在第一個。

3.2 添加數(shù)據源查詢

通過@DS注解來指定數(shù)據源，在配置類中指定了以#開頭

 @DS("#GRID_DATASOURCE")
    @UpdateProvider(type = QueryProvider.class, method = "createDatabase")
    void createDatabase(Map<String, Object> params);

這樣就可以開啟你的動態(tài)數(shù)據源，分庫查詢啦。