Spring Boot數(shù)據(jù)源加載及其多數(shù)據(jù)源的示例分析

這篇文章將為大家詳細(xì)講解有關(guān)Spring Boot數(shù)據(jù)源加載及其多數(shù)據(jù)源的示例分析，小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲。

業(yè)務(wù)需求

• 提供所有微服務(wù)數(shù)據(jù)源的圖形化維護(hù)功能

• 代碼生成可以根據(jù)選擇的數(shù)據(jù)源加載表等源信息

• 數(shù)據(jù)源管理要支持動(dòng)態(tài)配置，實(shí)時(shí)生效

附錄效果圖

實(shí)現(xiàn)思路

本文提供方法僅供類似簡(jiǎn)單業(yè)務(wù)場(chǎng)景，在生產(chǎn)環(huán)境和復(fù)雜的業(yè)務(wù)場(chǎng)景 請(qǐng)使用分庫分表的中間件（例如mycat）或者框架 sharding-sphere （一直在用）等

先來看Spring 默認(rèn)的數(shù)據(jù)源注入策略，如下代碼默認(rèn)的事務(wù)管理器在初始化時(shí)回去加載數(shù)據(jù)源實(shí)現(xiàn)。這里就是我們動(dòng)態(tài)數(shù)據(jù)源的入口

// 默認(rèn)的事務(wù)管理器
ppublic class DataSourceTransactionManager extends AbstractPlatformTransactionManager
  implements ResourceTransactionManager, InitializingBean {
 
 // 啟動(dòng)時(shí)候注入一個(gè)數(shù)據(jù)源
 public void setDataSource(@Nullable DataSource dataSource) {
  if (dataSource instanceof TransactionAwareDataSourceProxy) {
   this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource();
  }
  else {
   this.dataSource = dataSource;
  }
 }
」

通過注入一個(gè)新的DataSourceTransactionManager 實(shí)現(xiàn)，并且給它設(shè)置多個(gè) DataSource 來實(shí)現(xiàn)多數(shù)據(jù)源實(shí)現(xiàn)

看下Spring 默認(rèn)提供的路由數(shù)據(jù)源字段

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {
 
 // 用戶設(shè)置的全部的數(shù)據(jù)源配置
 @Nullable
 private Map<Object, Object> targetDataSources;
 // 為空默認(rèn)的數(shù)據(jù)源配置
 @Nullable
 private Object defaultTargetDataSource;
 
 // 路由鍵查找實(shí)現(xiàn)
 private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();
 
 // 最終有效的數(shù)據(jù)源配置（一般清空對(duì)應(yīng)上邊用戶的設(shè)置）
 @Nullable
 private Map<Object, DataSource> resolvedDataSources;
}

開始動(dòng)手

實(shí)現(xiàn)AbstractRoutingDataSource，定一個(gè)動(dòng)態(tài)數(shù)據(jù)源實(shí)現(xiàn)，只需要實(shí)現(xiàn)他的路由key 查找方法即可。

這里的路由key 對(duì)應(yīng)其實(shí)是resolvedDataSources Map 的key喲

@Slf4j
public class DynamicDataSource extends AbstractRoutingDataSource {

 /**
  * 指定路由Key,這里很簡(jiǎn)單 獲取 threadLocal 中目標(biāo)key 即可
  *
  * @return
  */
 @Override
 protected Object determineCurrentLookupKey() {
  return DynamicDataSourceContextHolder.getDataSourceType();
 }
}

把我們動(dòng)態(tài)數(shù)據(jù)源實(shí)現(xiàn)注入到Spring 的事務(wù)管理器,去數(shù)據(jù)庫查詢出來全部的數(shù)據(jù)源信息，定義一個(gè)個(gè)具體的數(shù)據(jù)源實(shí)現(xiàn) 我這里使用的HikariDataSource 給他賦值等等

@Slf4j
@Configuration
@AllArgsConstructor
public class DynamicDataSourceConfig implements TransactionManagementConfigurer {
 private final Map<Object, Object> dataSourceMap = new HashMap<>(8);
 private final DataSourceProperties dataSourceProperties;

 @Bean("dynamicDataSource")
 public DynamicDataSource dataSource() {
  JdbcTemplate(dds).queryForList(DataSourceConstant.QUERY_DS_SQL);
  log.info("開始 -> 初始化動(dòng)態(tài)數(shù)據(jù)源");
  Optional.of(dbList).ifPresent(list -> list.forEach(db -> {
   log.info("數(shù)據(jù)源:{}", db.get(DataSourceConstant.DS_NAME));
   HikariDataSource ds = new HikariDataSource();
   dataSourceMap.put(db.get(DataSourceConstant.DS_ROUTE_KEY), ds);
  }));
  
  DynamicDataSource ds = new DynamicDataSource();
  ds.setTargetDataSources(dataSourceMap);
  return ds;
 }

 @Bean
 public PlatformTransactionManager txManager() {
  return new DataSourceTransactionManager(dataSource());
 }

 @Override
 public PlatformTransactionManager annotationDrivenTransactionManager() {
  return txManager();
 }

}

怎么使用

只需要根據(jù)用戶前臺(tái)選擇的數(shù)據(jù)源key ，在業(yè)務(wù)類保存到TTL 即可，會(huì)自動(dòng)根據(jù)選擇路由數(shù)據(jù)源

DynamicDataSourceContextHolder.setDataSourceType（key）

這里當(dāng)然也可以根據(jù)AOP 自定義注解等實(shí)現(xiàn)。

如何動(dòng)態(tài)數(shù)據(jù)源動(dòng)態(tài)配置

上邊其實(shí)已經(jīng)完成了 我們想要的需求功能，但是有什么問題呢？
我們?cè)跀?shù)據(jù)源管理面維護(hù)了數(shù)據(jù)源，動(dòng)態(tài)去修改這個(gè) dataSourceMap 其實(shí)是無效的，不能做到實(shí)時(shí)刷新

我們來看下 AbstractRoutingDataSource 的加載map 數(shù)據(jù)源的源碼，只有在初始化的時(shí)候調(diào)用 afterPropertiesSet 去初始數(shù)據(jù)源map.

那我們只要獲取當(dāng)前的DynamicDataSource bean 手動(dòng)調(diào)用afterPropertiesSet 即可。

整個(gè)代碼如下

public class DynamicDataSourceConfig implements TransactionManagementConfigurer {
 private final Map<Object, Object> dataSourceMap = new HashMap<>(8);
 private final DataSourceProperties dataSourceProperties;
 private final StringEncryptor stringEncryptor;

 @Bean("dynamicDataSource")
 public DynamicDataSource dataSource() {
  DynamicDataSource ds = new DynamicDataSource();
  HikariDataSource cads = new HikariDataSource();
  cads.setJdbcUrl(dataSourceProperties.getUrl());
  cads.setDriverClassName(dataSourceProperties.getDriverClassName());
  cads.setUsername(dataSourceProperties.getUsername());
  cads.setPassword(dataSourceProperties.getPassword());
  ds.setDefaultTargetDataSource(cads);
  dataSourceMap.put(0, cads);
  ds.setTargetDataSources(dataSourceMap);
  return ds;
 }

 /**
  * 組裝默認(rèn)配置的數(shù)據(jù)源，查詢數(shù)據(jù)庫配置
  */
 @PostConstruct
 public void init() {
  DriverManagerDataSource dds = new DriverManagerDataSource();
  dds.setUrl(dataSourceProperties.getUrl());
  dds.setDriverClassName(dataSourceProperties.getDriverClassName());
  dds.setUsername(dataSourceProperties.getUsername());
  dds.setPassword(dataSourceProperties.getPassword());

  List<Map<String, Object>> dbList = new JdbcTemplate(dds).queryForList(DataSourceConstant.QUERY_DS_SQL);
  log.info("開始 -> 初始化動(dòng)態(tài)數(shù)據(jù)源");
  Optional.of(dbList).ifPresent(list -> list.forEach(db -> {
   log.info("數(shù)據(jù)源:{}", db.get(DataSourceConstant.DS_NAME));
   HikariDataSource ds = new HikariDataSource();
   ds.setJdbcUrl(String.valueOf(db.get(DataSourceConstant.DS_JDBC_URL)));
   ds.setDriverClassName(Driver.class.getName());
   ds.setUsername((String) db.get(DataSourceConstant.DS_USER_NAME));

   String decPwd = stringEncryptor.decrypt((String) db.get(DataSourceConstant.DS_USER_PWD));
   ds.setPassword(decPwd);
   dataSourceMap.put(db.get(DataSourceConstant.DS_ROUTE_KEY), ds);
  }));

  log.info("完畢 -> 初始化動(dòng)態(tài)數(shù)據(jù)源,共計(jì) {} 條", dataSourceMap.size());
 }

 /**
  * 重新加載數(shù)據(jù)源配置
  */
 public Boolean reload() {
  init();
  DynamicDataSource dataSource = dataSource();
  dataSource.setTargetDataSources(dataSourceMap);
  dataSource.afterPropertiesSet();
  return Boolean.FALSE;
 }


 @Bean
 public PlatformTransactionManager txManager() {
  return new DataSourceTransactionManager(dataSource());
 }

 @Override
 public PlatformTransactionManager annotationDrivenTransactionManager() {
  return txManager();
 }

關(guān)于“Spring Boot數(shù)據(jù)源加載及其多數(shù)據(jù)源的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，使各位可以學(xué)到更多知識(shí)，如果覺得文章不錯(cuò)，請(qǐng)把它分享出去讓更多的人看到。