mybatis 多數據源動態切換
筆者主要從事c#開發，近期因為項目需要，搭建了一套spring-cloud微服務框架，集成了eureka服務註冊中心、
gateway網關過濾、admin服務監控、auth授權體系驗證，集成了redis、swagger、jwt、mybatis多數據源等各項功能。
具體搭建過程後續另寫Podcast介紹。具體結構如下：
在搭建過程集成mybatis的時候，考慮到單一數據源無法滿足實際業務需要，故結合c#的開發經驗，進行多數據源動態集成。
mybatis的多數據源可以採用兩種方式進行，第一種是分包方式實現，這種方式靈活性不高，而且較為繁瑣，故不做過多介紹。
另一種方式是採用AOP的思想，進行註解動態切換，參考網上教程，核心思想是依靠 繼承AbstractRoutingDataSource，
重寫determineCurrentLookupKey()方法，在該方法中使用DatabaseContextHolder獲取當前執行緒的dataSource。
但是網上方法大都是首先定義好各個datasource，比如有三個數據源，就需要實現定義好三個datasource，筆者感覺這種方法，在我
目前這套框架中不夠靈活，因為筆者採用的是微服務框架，考慮到各個服務都有可能使用不同的數據源，而多數據源動態切換
是放在公共方法中實現的，如果每有新的數據源就要定義一個，對程式碼的侵入性太高，在c#中，選擇數據源很容易,根據連接名
稱就可以切換過去，
如下所示：
<connectionStrings>
<add name="test1" connectionString="server=127.0.0.1;user id=root;password=123456;database=db1;charset=utf8" providerName="MySql.Data.MySqlClient" />
<add name="test2" connectionString="server=127.0.0.1;user id=root;password=123456;database=db2;charset=utf8" providerName="MySql.Data.MySqlClient" />
<add name="test3" connectionString="server=127.0.0.1;user id=root;password=123456;database=db3;charset=utf8" providerName="MySql.Data.MySqlClient" />
<connectionStrings>
能不能像c#這樣根據連接名稱就自動選擇呢，筆者的連接配置如下所示：
spring:
application:
name: csg-auth
datasource:
kbase:
- driverClassName: com.kbase.jdbc.Driver
jdbcUrl: jdbc:kbase://127.0.0.1
username: DBOWN
password:
jdbc:
- driverClassName: com.mysql.cj.jdbc.Driver
jdbcUrl: jdbc:mysql://localhost:3306/nacos?serverTimezone=GMT%2B8&useUnicode=false&characterEncoding=utf8&useSSL=false
username: root
password: 123456
connName: nacos
- driverClassName: com.mysql.cj.jdbc.Driver
jdbcUrl: jdbc:mysql://localhost:3306/tpi?serverTimezone=GMT%2B8&useUnicode=false&characterEncoding=utf8&useSSL=false
username: root
password: 123456
connName: tpi
其中kbase不用理會，是我們公司自己的資料庫，jdbc是維護的連接集合，其中connName就是我們自定義的連接名稱，
根據connName就可以自動切換到對應數據源。
筆者實現程式碼如下：
第一步
首先，編寫DynamicDataSource類集成AbstractRoutingDataSource，重寫determineCurrentLookupKey方法，該方法主要作用是選擇數據源的key
程式碼如下：
/**
* 動態數據源
* */
public class DynamicDataSource extends AbstractRoutingDataSource {
@Override
protected Object determineCurrentLookupKey() {
return DataSourceHolder.getDataSource();
}
}
第二步
第二部編寫DataSourceHolder類，提供設置、獲取、情況數據源的方法，如下所示：
public class DataSourceHolder {
/**
* 執行緒本地環境
*/
private static final ThreadLocal<String> dataSources = new ThreadLocal<String>();
/**
* 設置數據源
*/
public static void setDataSources(String connName) {
dataSources.set(connName);
}
/**
* 獲取數據源
*/
public static String getDataSource() {
return dataSources.get();
}
/**
* 清楚數據源
*/
public static void clearDataSource() {
dataSources.remove();
}
}
第三步
第三步,編寫DataSourceConfig類，該類主要作用是讀取配置文件中的數據源連接集合，以及維護項目數據源的Bean對象，
程式碼如下：
@Component
@ConfigurationProperties("spring.datasource")
public class DataSourceConfig {
private List<DataSourceModel> jdbc;
public Map<Object, Object> getDataSourceMap(){
Map<Object, Object>map=new HashMap<>();
if (jdbc!=null&&jdbc.size()>0){
for (int i = 0; i < jdbc.size() ; i++) {
DataSourceBuilder dataSourceBuilder=DataSourceBuilder.create();
dataSourceBuilder.driverClassName(jdbc.get(i).getDriverClassName());
dataSourceBuilder.password(jdbc.get(i).getPassword());
dataSourceBuilder.username(jdbc.get(i).getUsername());
dataSourceBuilder.url(jdbc.get(i).getJdbcUrl());
map.put(jdbc.get(i).getConnName(),dataSourceBuilder.build());
}
}
return map;
}
@Bean
public DataSource csgDataSource(){
DynamicDataSource dynamicDataSource=new DynamicDataSource();
Map<Object,Object>dataSourceMap=getDataSourceMap();
dynamicDataSource.setTargetDataSources(dataSourceMap);
Object object= dataSourceMap.values().toArray()[0];
dynamicDataSource.setDefaultTargetDataSource(object);
return dynamicDataSource;
}
public void setJdbc(List<DataSourceModel> jdbc) {
this.jdbc = jdbc;
}
public List<DataSourceModel> getJdbc(){
return this.jdbc;
}
}
其中，getDataSourceMap()方法，作用是根據配置的連接集合，生成AbstractRoutingDataSource所需要的resolvedDataSources。
而csgDataSource()方法，添加了@Bean註解，作用是讓mybatis的SqlSessionFactory，能夠使用咱們維護的數據源。
第四部
編寫MyBatisConfig類，該類主要作用是 配置好mybatis的數據源。
@Configuration
public class MyBatisConfig {
@Autowired
private DataSource csgDataSource;
@Bean
public SqlSessionFactory sqlSessionFactory() throws Exception {
SqlSessionFactoryBean sqlSessionFactoryBean=new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(csgDataSource);
sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver()
.getResources("classpath:mapper/**/*.xml"));
return sqlSessionFactoryBean.getObject();
}
@Bean
public PlatformTransactionManager platformTransactionManager(){
return new DataSourceTransactionManager(csgDataSource);
}
}
可以看到，這裡選擇的是我們定義好的csgDataSource，其作用也是如此。
第五步
編寫TargetDataSource註解
/**
* 註解標籤
* 作用於 方法、介面、類、枚舉、註解
* */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD,ElementType.TYPE})
public @interface TargetDataSource {
String connName();
}
其中connName，就是我們需要使用的數據源
第六步
編寫DataSourceExchange，改類為切面，作用於TargetDataSource註解，故使用TargetDataSource註解的時候，
會根據connName自動選擇數據源。
@Aspect
@Component
public class DataSourceExchange {
@Before("@annotation(TargetDataSource)")
public void before(JoinPoint joinPoint){
MethodSignature sign = (MethodSignature) joinPoint.getSignature();
Method method = sign.getMethod();
boolean isMethodAop= method.isAnnotationPresent(TargetDataSource.class);
if (isMethodAop){
TargetDataSource datasource = method.getAnnotation(TargetDataSource.class);
DataSourceHolder.setDataSources(datasource.connName());
}else {
if (joinPoint.getTarget().getClass().isAnnotationPresent(TargetDataSource.class)){
TargetDataSource datasource = joinPoint.getTarget().getClass().getAnnotation(TargetDataSource.class);
DataSourceHolder.setDataSources(datasource.connName());
}
}
}
@After("@annotation(TargetDataSource)")
public void after(){
DataSourceHolder.clearDataSource();
}
}
改切面作用於方法運行前後，負責選擇、取消數據源。
第七部
開始驗證，使用方法如下：
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
@Override
@TargetDataSource(connName = "nacos")
public List<UserEntity> getList() {
List<UserEntity> list= userMapper.selectUserList();
return list;
}
}
在service中，在需要進行資料庫操作的方法上，添加TargetDataSource註解，即可自動切換到所需要的數據源。
至此，mybatis就可以動態切換數據源了。
筆者從事java開發工作不多，改方法可能不是太好，也請各位看官勿噴~
