基于mybatis?plus實現數據源動態添加、刪除、切換,自定義數據源的示例代碼

 更新時間:2022年03月10日 12:01:33   作者:※星光※  
這篇文章主要介紹了基于mybatis?plus實現數據源動態添加、刪除、切換,自定義數據源,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

簡介

基于springboot,mybatis plus集成了一套多數據源的解決方案,在使用時引入相應的插件dynamic-datasource-spring-boot-starter,可以實現數據源的動態添加、刪除等功能,對于多租戶或者分庫等操作可以根據AOP切面代理到不同的數據源、實現單一系統數據隔離的目的。

代碼示例

mavne依賴

<!--mybatis-plus-->
<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>mybatis-plus-boot-starter</artifactId>
	<version>3.4.3.4</version>
</dependency>
 
<!--dynamic-datasource-->
<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
	<version>3.4.1</version>
</dependency>

數據源增加、移除

@RestController
@RequestMapping("/datasources")
public class DataSourceController {
 
    @Resource
    private DataSource dataSource;
    @Resource
    private DefaultDataSourceCreator dataSourceCreator;
    
 
    @GetMapping("list")
    public Set<String> list() {
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        return ds.getDataSources().keySet();
    }
 
    @PostMapping("add")
    public Set<String> add(@Validated @RequestBody 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();
    }
 
    @DeleteMapping("remove")
    public void remove(String name) {
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        ds.removeDataSource(name);
    }
}

默認的數據源連接池加載順序為: druid>hikaricp>beecp>dbcp>spring basic

數據源切換

基于AOP切換

添加注解,排除不做切換的接口

package com.starsray.dynamic.datasource.annotation;
 
import java.lang.annotation.*;
 
/**
 * <p>
 * 用戶標識僅可以使用默認數據源
 * </p>
 *
 * @author starsray
 * @since 2021-11-10
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DefaultDs {
}

切面具體實現

package com.starsray.dynamic.datasource.interceptor;
 
import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;
import com.starsray.dynamic.datasource.annotation.DefaultDs;
import com.starsray.dynamic.datasource.exception.ExceptionEnum;
import com.starsray.dynamic.datasource.exception.GlobalException;
import lombok.RequiredArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.HandlerInterceptor;
 
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
 
/**
 * <p>
 * 數據源選擇器切面
 * </p>
 *
 * @author starsray
 * @since 2021-11-10
 */
@Aspect
@Component
@RequiredArgsConstructor(onConstructor_ = @Autowired)
public class DsInterceptor implements HandlerInterceptor {
 
    @Pointcut("execution(public * com.starsray.dynamic.datasource.controller.*.*(..))")
    public void datasourcePointcut() {
    }
 
    /**
     * 前置操作,攔截具體請求,獲取header里的數據源id,設置線程變量里,用于后續切換數據源
     */
    @Before("datasourcePointcut()")
    public void doBefore(JoinPoint joinPoint) {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
 
        // 排除不可切換數據源的方法
        DefaultDs annotation = method.getAnnotation(DefaultDs.class);
        if (null != annotation) {
            DynamicDataSourceContextHolder.push("master");
        } else {
            RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
            ServletRequestAttributes attributes = (ServletRequestAttributes) requestAttributes;
            assert attributes != null;
            HttpServletRequest request = attributes.getRequest();
            String header = request.getHeader("tenantName");
            if (StringUtils.isNotBlank(header)) {
                DynamicDataSourceContextHolder.push(header);
            } else {
                throw new GlobalException(ExceptionEnum.NOT_TENANT);
            }
        }
    }
 
    /**
     * 后置操作,設置回默認的數據源id
     */
    @AfterReturning("datasourcePointcut()")
    public void doAfter() {
        DynamicDataSourceContextHolder.push("master");
    }
 
}

基于重寫處理器

mybatis plus提供了默認處理器來決定使用的數據源,可以重寫處理器實現自定義參數,比如從請求header里面獲取參數切換數據源。

@DS("#header.tenantId")

自定義處理器

public class HeaderProcessor extends DsProcessor {
 
    private static final String HEADER = "#header";
 
    @Override
    public boolean matches(String key) {
        return key.startsWith(HEADER);
    }
 
    @Override
    public String doDetermineDatasource(MethodInvocation invocation, String key) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        return request.getHeader(key.substring(8));
    }
}

注冊自定義處理器

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

如果有場景需要手動切換數據源,可以使用組件提供的工具來實現。

DynamicDataSourceContextHolder.push("master");

自定義數據源

mybatis plus提供了一個接口來加載數據源信息。

public interface DynamicDataSourceProvider {
    Map<String, DataSource> loadDataSources();
}

這個接口有一個抽象實現類AbstractDataSourceProvider,通過模板方法定義了加載數據源來源的方式,mybatis plus通過YmlDynamicDataSourceProvider實現了讀取yml文件配置來初始化數據源的方式。

public abstract class AbstractDataSourceProvider implements DynamicDataSourceProvider {
    private static final Logger log = LoggerFactory.getLogger(AbstractDataSourceProvider.class);
    @Autowired
    private DefaultDataSourceCreator defaultDataSourceCreator;
 
    public AbstractDataSourceProvider() {
    }
 
    protected Map<String, DataSource> createDataSourceMap(Map<String, DataSourceProperty> dataSourcePropertiesMap) {
        Map<String, DataSource> dataSourceMap = new HashMap(dataSourcePropertiesMap.size() * 2);
        Iterator var3 = dataSourcePropertiesMap.entrySet().iterator();
 
        while(var3.hasNext()) {
            Entry<String, DataSourceProperty> item = (Entry)var3.next();
            String dsName = (String)item.getKey();
            DataSourceProperty dataSourceProperty = (DataSourceProperty)item.getValue();
            String poolName = dataSourceProperty.getPoolName();
            if (poolName == null || "".equals(poolName)) {
                poolName = dsName;
            }
 
            dataSourceProperty.setPoolName(poolName);
            dataSourceMap.put(dsName, this.defaultDataSourceCreator.createDataSource(dataSourceProperty));
        }
        return dataSourceMap;
    }
}

如果有需要從數據庫加載數據源信息,可以重寫AbstractJdbcDataSourceProvider中的executeStmt方法來加載數據庫配置信息。示例:

package com.digital.cnzz.dynamic.ds.provider;
 
import com.baomidou.dynamic.datasource.provider.AbstractJdbcDataSourceProvider;
import com.baomidou.dynamic.datasource.provider.DynamicDataSourceProvider;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import com.digital.cnzz.dynamic.ds.config.DefaultDsConfig;
import com.digital.cnzz.dynamic.ds.constant.DsDriverEnum;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
 
import javax.annotation.Resource;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashMap;
import java.util.Map;
 
@Primary
@Configuration
public class DsProvider {
 
    @Resource
    private DefaultDsConfig defaultDsConfig;
 
    @Bean
    public DynamicDataSourceProvider jdbcDynamicDataSourceProvider() {
        return new AbstractJdbcDataSourceProvider(defaultDsConfig.getDriverClassName(), defaultDsConfig.getUrl(), defaultDsConfig.getUsername(), defaultDsConfig.getPassword()) {
            @Override
            protected Map<String, DataSourceProperty> executeStmt(Statement statement) {
                Map<String, DataSourceProperty> dataSourcePropertiesMap = null;
                ResultSet rs = null;
                try {
                    dataSourcePropertiesMap = new HashMap<>();
                    rs = statement.executeQuery("SELECT * FROM DYNAMIC_DATASOURCE_INSTANCE");
                    while (rs.next()) {
                        String name = rs.getString("name");
                        DataSourceProperty property = new DataSourceProperty();
                        property.setDriverClassName(rs.getString("driver"));
                        property.setUrl(rs.getString("url"));
                        property.setUsername(rs.getString("username"));
                        property.setPassword(rs.getString("password"));
                        dataSourcePropertiesMap.put(name, property);
                    }
                } catch (SQLException e) {
                    e.printStackTrace();
                } finally {
                    try {
                        if (rs != null) {
                            rs.close();
                        }
                    } catch (SQLException e) {
                        e.printStackTrace();
                    }
                    try {
                        statement.close();
                    } catch (SQLException e) {
                        e.printStackTrace();
                    }
                }
                return dataSourcePropertiesMap;
            }
        };
    }
}

通過讀取源碼可以發現,如果還有其他需要自定義加載數據源的方式,只需要繼承AbstractDataSourceProvider抽象類,實現DynamicDataSourceProvider接口,重寫loadDataSources方法就可以實現自定義數據源。

完整代碼示例:https://gitee.com/starsray/dynamic-datasource

到此這篇關于基于mybatis plus實現數據源動態添加、刪除、切換,自定義數據源的文章就介紹到這了,更多相關mybatis plus自定義數據源內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家!

相關文章

  • Intellij IDEA 關閉和開啟自動更新的提示?

    Intellij IDEA 關閉和開啟自動更新的提示?

    這篇文章主要介紹了Intellij IDEA 關閉和開啟自動更新的提示操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2021-04-04
  • eclipse中自動生成javadoc文檔的方法

    eclipse中自動生成javadoc文檔的方法

    這篇文章主要介紹了eclipse中自動生成javadoc文檔的方法,是實用eclipse開發Java程序時非常實用的技巧,對于進行Java項目開發具有一定的參考借鑒價值,需要的朋友可以參考下
    2014-12-12
  • Java基礎學習之字符串知識總結

    Java基礎學習之字符串知識總結

    今天帶著大家復習一下Java基礎知識-字符串,文中介紹的非常詳細,對初步學習Java或者復習Java的小伙伴們都很有幫助喲,需要的朋友可以參考下
    2021-05-05
  • java實現簡單掃雷游戲

    java實現簡單掃雷游戲

    這篇文章主要為大家詳細介紹了java實現簡單掃雷游戲,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2020-04-04
  • java中申請不定長度數組ArrayList的方法

    java中申請不定長度數組ArrayList的方法

    今天小編就為大家分享一篇java中申請不定長度數組ArrayList的方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2018-07-07
  • prometheus監控springboot應用簡單使用介紹詳解

    prometheus監控springboot應用簡單使用介紹詳解

    這篇文章主要介紹了prometheus監控springboot應用簡單使用介紹詳解,小編覺得挺不錯的,現在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2019-05-05
  • Kotlin與java8的SAM轉換對比(進階)

    Kotlin與java8的SAM轉換對比(進階)

    這篇文章主要介紹了Kotlin與java8的SAM轉換對比,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
    2020-05-05
  • springboot如何讀取自定義屬性

    springboot如何讀取自定義屬性

    大家好,本篇文章主要講的是springboot如何讀取自定義屬性,感興趣的同學趕快來看一看吧,對你有幫助的話記得收藏一下
    2022-02-02
  • Spring AspectJ AOP框架注解原理解析

    Spring AspectJ AOP框架注解原理解析

    這篇文章主要介紹了Spring AspectJ AOP框架注解原理解析,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
    2020-09-09
  • java面向對象設計原則之里氏替換原則示例詳解

    java面向對象設計原則之里氏替換原則示例詳解

    這篇文章主要為大家介紹了java面向對象設計原則之里氏替換原則示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步早日升職加薪
    2021-10-10

最新評論

免费人成视频在线观看