SpringBoot實現多數據源的切換實踐

Posted on 2022-03-03 by WalkonNet

前言

我們在進行軟件開發的過程中，剛開始的時候因為無法估量系統後期的訪問量和並發量，所以一開始會采用單體架構，後期如果網站流量變大，並發量變大，那麼就可能會將架構擴展為微服務架構，各個微服務對應一個數據庫，不過這樣的成本就有點大瞭，可能隻是有些模塊用的人比較多，有些模塊沒什麼人用，如果都進行服務拆分，其實也沒那個必要，如果有些模塊用的人比較多，那麼我們可以采用讀寫分離來減輕壓力，這樣的話，可以在一定程度上提升系統的用戶體驗，不過這隻是在數據庫的I/O上面做方案，如果系統的壓力很大，那麼肯定要做負載均衡，我們今天就先說實現數據庫的讀寫分離。我們要在代碼層面實現數據庫的讀寫分離，那麼核心就是數據源的切換，本文基於AOP來實現數據源的切換。

工程結構

└─com
    └─steak
        └─transaction
            │  TransactionDemoApplication.java
            │  
            ├─datasource
            │  │  DatasourceChooser.java
            │  │  DatasourceConfiguration.java
            │  │  DatasourceContext.java
            │  │  DatasourceScope.java
            │  │  DynamicDatasourceAspect.java
            │  │  
            │  └─properties
            │          DynamicDatasourceProperties.java
            │          MainDatasourceProperties.java
            │          
            ├─execute
            │      PlaceOrderExecute.java
            │      
            ├─rest
            │      PlaceOrderApi.java
            │      
            ├─result
            │      R.java
            │      
            └─service
                    IntegralService.java
                    OrderService.java
                    StockService.java

在下面的實現中，我們一個有三個數據源，其中有一個是默認的，如果不指定具體的數據源，那麼就使用默認的，我們是基於申明式的方式來切換數據源，隻需要在具體的接口上加上註解便能實現數據源的切換。

編碼實現

yml文件

主數據源直接使用spring的配置，其他數據源采用自定義的方式，這裡采用一個map結構來定義，方便進行解析，可以在yml文件裡進行添加多個，在代碼邏輯層面不用改動。

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      username: root
      password: 123456
      url: jdbc:mysql://127.0.0.1:3306/db?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC
      driver-class-name: com.mysql.cj.jdbc.Driver

dynamic:
  datasource: {
    slave1: {
      username: 'root',
      password: '123456',
      url: ' url: jdbc:mysql://127.0.0.1:3306/db?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC',
      driver-class-name: 'com.mysql.cj.jdbc.Driver'
    },
    slave2: {
      username: 'root',
      password: '123456',
      url: ' url: jdbc:mysql://127.0.0.1:3306/db?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC',
      driver-class-name: 'com.mysql.cj.jdbc.Driver'
    }
  }

主數據源MainDatasourceProperties

對於主數據源，我們單獨拿出來放在一個類裡面，不過其實也可以放到dynamic裡面，隻是需要做一定的處理，我們就簡單的放幾個連接屬性。

/**
 * @author 劉牌
 * @date 2022/3/220:14
 */
@Component
@ConfigurationProperties(prefix = "spring.datasource.druid")
@Data
public class MainDatasourceProperties {
    private String username;
    private String password;
    private String url;
    private String driverClassName;
}

其他數據源DynamicDatasourceProperties

其他數據源使用一個Map來接受yml文件中的數據源配置

/**
 * @author 劉牌
 * @date 2022/3/213:47
 */
@Component
@ConfigurationProperties(prefix = "dynamic")
@Data
public class DynamicDatasourceProperties {
    private Map<String,Map<String,String>> datasource;
}

數據源配置類DatasourceConfiguration

配置類中主要對DataSource進行配置，主數據源我們按照正常的bean來定義連接屬性，而其他數據數據源則使用反射的方式來進行連接屬性的配置，因為主數據源一般是不會變動的，但是其他數據源可能會發生變動，可能會添加，這時候如果通過硬編碼取配置，那麼每增加一個數據源，就需要增加一個配置，顯然不太行，所以就使用反射來進行賦值。

/**
 * @author 劉牌
 * @date 2022/3/111:34
 */
@Configuration
@AllArgsConstructor
public class DatasourceConfiguration {

    final MainDatasourceProperties mainDatasourceProperties;
    final DynamicDatasourceProperties dynamicDatasourceProperties;

    @Bean
    public DataSource datasource(){
        Map<Object,Object> datasourceMap = new HashMap<>();
        DatasourceChooser datasourceChooser = new DatasourceChooser();
        /**
         * main database
         */
        DruidDataSource mainDataSource = new DruidDataSource();
        mainDataSource.setUsername(mainDatasourceProperties.getUsername());
        mainDataSource.setPassword(mainDatasourceProperties.getPassword());
        mainDataSource.setUrl(mainDatasourceProperties.getUrl());
        mainDataSource.setDriverClassName(mainDatasourceProperties.getDriverClassName());
        datasourceMap.put("main",mainDataSource);
        /**
         * other database
         */
        Map<String, Map<String, String>> sourceMap = dynamicDatasourceProperties.getDatasource();
        sourceMap.forEach((datasourceName,datasourceMaps) -> {
            DruidDataSource dataSource = new DruidDataSource();
            datasourceMaps.forEach((K,V) -> {
                String setField = "set" + K.substring(0, 1).toUpperCase() + K.substring(1);
                //轉換yml文件中帶有-符號的屬性
                String[] strings = setField.split("");
                StringBuilder newStr = new StringBuilder();
                for (int i = 0; i < strings.length; i++) {
                    if (strings[i].equals("-")) strings[i + 1] = strings[i + 1].toUpperCase();
                    if (!strings[i].equals("-")) newStr.append(strings[i]);
                }
                try {
                    DruidDataSource.class.getMethod(newStr.toString(),String.class).invoke(dataSource,V);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            });
            datasourceMap.put(datasourceName,dataSource);
        });
        //設置目標數據源
        datasourceChooser.setTargetDataSources(datasourceMap);
        //設置默認數據源
        datasourceChooser.setDefaultTargetDataSource(mainDataSource);
        return datasourceChooser;
    }
}

上面使用數據源配置類中使用反射對其他數據源進行連接屬性的設置，然後設置目標數據源和默認數據源，裡面有一個DatasourceChooser。

DatasourceChooser

DatasourceChooser繼承自AbstractRoutingDataSource，AbstractRoutingDataSource可以實現數據源的切換，它裡面的 determineCurrentLookupKey()方法需要我們返回一個數據源的名稱，它會自動給我們匹配上數據源。

/**
 * @author 劉牌
 * @date 2022/3/112:21
 */
public class DatasourceChooser extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DatasourceContext.getDatasource();
    }
}

如下是AbstractRoutingDataSource的部分源碼，我們可以看出數據源是一個Map結構，可以通過數據源名稱查找到對應的數據源。

package org.springframework.jdbc.datasource.lookup;

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {
    @Nullable
    private Map<Object, DataSource> resolvedDataSources;
    public AbstractRoutingDataSource() {
    }
    protected DataSource determineTargetDataSource() {
        Object lookupKey = this.determineCurrentLookupKey();
        DataSource dataSource = (DataSource)this.resolvedDataSources.get(lookupKey);
    }

    @Nullable
    protected abstract Object determineCurrentLookupKey();
}

DatasourceContext

DatasourceContext內部是一個ThreadLocal，主要是用來存儲每一個線程的數據源名稱和獲取數據源名稱，而數據源的名稱我們用過AOP切面來獲取。

/**
 * @author 劉牌
 * @date 2022/3/112:22
 */
public class DatasourceContext {
    private static final ThreadLocal<String> threadLocal = new ThreadLocal<>();
    public static void setDatasource(String key){
        threadLocal.set(key);
    }
    public static String getDatasource(){
        return threadLocal.get();
    }
}

數據源註解DatasourceScope

DatasourceScope標準在方法上面，通過scope來指定數據源，不指定默認為主數據源main。

/**
 * @author 劉牌
 * @date 2022/3/111:22
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DatasourceScope {
    String scope() default "main";
}

數據源切面DynamicDatasourceAspect

我們在訪問每一個帶有DatasourceScope註解的方法時，都會經過數據源切面DynamicDatasourceAspect，獲取到註解上面的 scope的值後，通過DatasourceContext設置數據源名稱，便可實現對數據源的切換。

/**
 * @author 劉牌
 * @date 2022/3/111:34
 */
@Aspect
@Component
public class DynamicDatasourceAspect {

    @Pointcut("@annotation(dataSourceScope)")
    public void dynamicPointcut(DatasourceScope dataSourceScope){}

    @Around(value = "dynamicPointcut(dataSourceScope)", argNames = "joinPoint,dataSourceScope")
    public Object dynamicAround(ProceedingJoinPoint joinPoint , DatasourceScope dataSourceScope) throws Throwable {
        String scope = dataSourceScope.scope();
        DatasourceContext.setDatasource(scope);
        return joinPoint.proceed();
    }
}

使用

隻需要在具體的方法上面標註數據源註解@DatasourceScope，並指定scope的值，便可實現切換，如果不指定，那麼就使用主數據源。

/**
 * @author 劉牌
 * @date 2022/3/19:49
 */
@Service
@AllArgsConstructor
public class OrderService {
    
    private JdbcTemplate jdbcTemplate;
    
    @DatasourceScope(scope = "slave1")
    public R saveOrder(Integer userId , Integer commodityId){
        String sql = "INSERT INTO `order`(user_id,commodity_id) VALUES("+userId+","+commodityId+")";
        jdbcTemplate.execute(sql);
        return R.builder().code(200).msg("save order success").build();
    }
}

到此這篇關於SpringBoot實現多數據源的切換實踐的文章就介紹到這瞭,更多相關SpringBoot多數據源切換內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

SpringBoot實現多數據源的切換實踐

目錄

前言

工程結構

編碼實現

yml文件

主數據源MainDatasourceProperties

其他數據源DynamicDatasourceProperties

數據源配置類DatasourceConfiguration

DatasourceChooser

DatasourceContext

數據源註解DatasourceScope

數據源切面DynamicDatasourceAspect

使用

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

前言

工程結構

編碼實現

yml文件

主數據源MainDatasourceProperties

其他數據源DynamicDatasourceProperties

數據源配置類DatasourceConfiguration

DatasourceChooser

DatasourceContext

數據源註解DatasourceScope

數據源切面DynamicDatasourceAspect

使用

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆