業務需求
- 提供所有微服務數據源的圖形化維護功能
- 代碼生成可以根據選擇的數據源加載表等源信息
- 數據源管理要支持動態配置，實時生效
附錄效果圖
實現思路
本文提供方法僅供類似簡單業務場景，在生產環境和複雜的業務場景 請使用分庫分表的中間件（例如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 實踐