業務需求
- 提供所有微服務資料來源的圖形化維護功能
- 程式碼生成可以根據選擇的資料來源載入表等源資訊
- 資料來源管理要支援動態配置，實時生效
附錄效果圖
實現思路
本文提供方法僅供類似簡單業務場景，在生產環境和複雜的業務場景 請使用分庫分表的中介軟體（例如mycat）或者框架 sharding-sphere （一直在用）等
- 先來看Spring 預設的資料來源注入策略，如下程式碼預設的事務管理器在初始化時回去載入資料來源實現。這裡就是我們動態資料來源的入口
// 預設的事務管理器
ppublic class DataSourceTransactionManager extends AbstractPlatformTransactionManager
implements ResourceTransactionManager, InitializingBean {
// 啟動時候注入一個資料來源
public void setDataSource(@Nullable DataSource dataSource) {
if (dataSource instanceof TransactionAwareDataSourceProxy) {
this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource();
}
else {
this.dataSource = dataSource;
}
}
」
複製程式碼- 通過注入一個新的DataSourceTransactionManager 實現，並且給它設定多個 DataSource 來實現多資料來源實現
- 看下Spring 預設提供的路由資料來源欄位
public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {
// 使用者設定的全部的資料來源配置
@Nullable
private Map<Object, Object> targetDataSources;
// 為空預設的資料來源配置
@Nullable
private Object defaultTargetDataSource;
// 路由鍵查詢實現
private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();
// 最終有效的資料來源配置（一般清空對應上邊使用者的設定）
@Nullable
private Map<Object, DataSource> resolvedDataSources;
}
複製程式碼開始動手
- 實現AbstractRoutingDataSource，定一個動態資料來源實現，只需要實現他的路由key 查詢方法即可。 這裡的路由key 對應其實是resolvedDataSources Map 的key喲
@Slf4j
public class DynamicDataSource extends AbstractRoutingDataSource {
/**
* 指定路由Key,這裡很簡單 獲取 threadLocal 中目標key 即可
*
* @return
*/
@Override
protected Object determineCurrentLookupKey() {
return DynamicDataSourceContextHolder.getDataSourceType();
}
}
複製程式碼- 把我們動態資料來源實現注入到Spring 的事務管理器,去資料庫查詢出來全部的資料來源資訊，定義一個個具體的資料來源實現 我這裡使用的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("開始 -> 初始化動態資料來源");
Optional.of(dbList).ifPresent(list -> list.forEach(db -> {
log.info("資料來源:{}", 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();
}
}
複製程式碼怎麼使用
只需要根據使用者前臺選擇的資料來源key ，在業務類儲存到TTL 即可，會自動根據選擇路由資料來源
DynamicDataSourceContextHolder.setDataSourceType（key）
複製程式碼這裡當然也可以根據AOP 自定義註解等實現。
如何動態資料來源動態配置
上邊其實已經完成了 我們想要的需求功能，但是有什麼問題呢？
我們在資料來源管理面維護了資料來源，動態去修改這個 dataSourceMap 其實是無效的，不能做到實時重新整理
我們來看下 AbstractRoutingDataSource 的載入map 資料來源的原始碼，只有在初始化的時候呼叫 afterPropertiesSet 去初始資料來源map.
那我們只要獲取當前的DynamicDataSource bean 手動呼叫afterPropertiesSet 即可。 整個程式碼如下
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;
}
/**
* 組裝預設配置的資料來源，查詢資料庫配置
*/
@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("開始 -> 初始化動態資料來源");
Optional.of(dbList).ifPresent(list -> list.forEach(db -> {
log.info("資料來源:{}", 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("完畢 -> 初始化動態資料來源,共計 {} 條", dataSourceMap.size());
}
/**
* 重新載入資料來源配置
*/
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();
}
複製程式碼總結
歡迎關注我們獲得更多的好玩JavaEE實踐