最近項目中需要配置兩個數(shù)據(jù)源攀唯，并且在不同的包下動態(tài)切換，為此媚朦，參考網(wǎng)上動態(tài)切換數(shù)據(jù)源的博客氧敢，實現(xiàn)了滿足項目的數(shù)據(jù)源動態(tài)切換功能。
- 1询张、Spring的開發(fā)者還是挺有先見之明的孙乖，為我們提供了擴展Spring的AbstractRoutingDataSource抽象類，我們來看它的源碼
/**
* Retrieve the current target DataSource. Determines the
* {@link #determineCurrentLookupKey() current lookup key}, performs
* a lookup in the {@link #setTargetDataSources targetDataSources} map,
* falls back to the specified
* {@link #setDefaultTargetDataSource default target DataSource} if necessary.
* @see #determineCurrentLookupKey()
*/
protected DataSource determineTargetDataSource() {
Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");
Object lookupKey = determineCurrentLookupKey();
DataSource dataSource = this.resolvedDataSources.get(lookupKey);
if (dataSource == null && (this.lenientFallback || lookupKey == null)) {
dataSource = this.resolvedDefaultDataSource;
}
if (dataSource == null) {
throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");
}
return dataSource;
}
/**
* Determine the current lookup key. This will typically be
* implemented to check a thread-bound transaction context.
* <p>Allows for arbitrary keys. The returned key needs
* to match the stored lookup key type, as resolved by the
* {@link #resolveSpecifiedLookupKey} method.
*/
protected abstract Object determineCurrentLookupKey();
源碼注釋解釋的很清楚份氧，determineTargetDataSource 方法通過數(shù)據(jù)源的標(biāo)識獲取當(dāng)前數(shù)據(jù)源唯袄；determineCurrentLookupKey方法則是獲取數(shù)據(jù)源標(biāo)識。（作為英語彩筆蜗帜，有道詞典這種翻譯軟件還是特別好使的）
所以恋拷，我們實現(xiàn)動態(tài)切換數(shù)據(jù)源，需要實現(xiàn)determineCurrentLookupKey方法厅缺，動態(tài)提供數(shù)據(jù)源標(biāo)識即可蔬顾。
- 2宴偿、自定義DynamicDataSource類，繼承AbstractRoutingDataSource诀豁，并實現(xiàn)determineCurrentLookupKey方法窄刘。
public class DynamicDataSource extends AbstractRoutingDataSource {
@Override
protected Object determineCurrentLookupKey() {
/**
* DynamicDataSourceContextHolder代碼中使用setDataSource
* 設(shè)置當(dāng)前的數(shù)據(jù)源，在路由類中使用getDataSource進行獲取舷胜，
* 交給AbstractRoutingDataSource進行注入使用都哭。
*/
return DynamicDataSourceContextHolder.getDataSource();
}
}
- 3、創(chuàng)建統(tǒng)一數(shù)據(jù)源管理類DynamicDataSourceContextHolder
public class DynamicDataSourceContextHolder {
// 線程本地環(huán)境
private static final ThreadLocal<String> dataSources = new ThreadLocal<String>();
// 管理所有的數(shù)據(jù)源Id
public static List<String> dataSourceIds = new ArrayList<String>();
public static void setDataSource(String dataSource) {
dataSources.set(dataSource);
}
public static String getDataSource() {
return dataSources.get();
}
public static void clearDataSource() {
dataSources.remove();
}
// 判斷指定的DataSource當(dāng)前是否存在
public static boolean containsDataSource(String dataSourceId) {
return dataSourceIds.contains(dataSourceId);
}
}
- 4逞带、重點來了，創(chuàng)建動態(tài)數(shù)據(jù)源注冊器DynamicDataSourceRegister
public class DynamicDataSourceRegister implements ImportBeanDefinitionRegistrar, EnvironmentAware {
// 默認(rèn)數(shù)據(jù)連接池
public static final Object DATASOURCE_TYPE_DEFAULT = "org.apache.tomcat.jdbc.pool.DataSource";
private Class<? extends DataSource> dataSourceType;
// 默認(rèn)數(shù)據(jù)源
private DataSource defaultDataSource;
private Map<String, DataSource> dataSourceMaps = new HashMap<String, DataSource>();
/**
* 加載多數(shù)據(jù)源配置
* @param environment
*/
@Override
public void setEnvironment(Environment environment) {
initDefaultDataSource(environment);
}
/**
* 初始化默認(rèn)數(shù)據(jù)源
* @param environment
*/
private void initDefaultDataSource(Environment environment) {
RelaxedPropertyResolver propertyResolver = new RelaxedPropertyResolver(environment, "spring.datasource.");
try {
if(propertyResolver.getProperty("type") == null) {
dataSourceType = (Class<? extends DataSource>)Class.forName(DATASOURCE_TYPE_DEFAULT.toString());
} else {
dataSourceType = (Class<? extends DataSource>)Class.forName(propertyResolver.getProperty("type"));
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
// 創(chuàng)建數(shù)據(jù)源
String jndiName = propertyResolver.getProperty("jndi-name");
String[] jndiNames = jndiName.split(",");
defaultDataSource = new JndiDataSourceLookup().getDataSource(jndiNames[0]);
dataSourceMaps.put("AAA", defaultDataSource);
DataSource dataSource1 = new JndiDataSourceLookup().getDataSource(jndiNames[1]);
dataSourceMaps.put("BBB", dataSource1);
}
@Override
public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
Map<String, Object> targetDataSources = new HashMap<String, Object>();
// 將主數(shù)據(jù)源添加到更多數(shù)據(jù)源中
targetDataSources.put("dataSource", defaultDataSource);
DynamicDataSourceContextHolder.dataSourceIds.add("dataSource");
// 添加更多數(shù)據(jù)源
targetDataSources.putAll(dataSourceMaps);
for(String key : dataSourceMaps.keySet()) {
DynamicDataSourceContextHolder.dataSourceIds.add(key);
}
// 創(chuàng)建DynamicDataSource
GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setBeanClass(DynamicDataSource.class);
beanDefinition.setSynthetic(true);
MutablePropertyValues mutablePropertyValues = beanDefinition.getPropertyValues();
mutablePropertyValues.addPropertyValue("defaultTargetDataSource", defaultDataSource);
mutablePropertyValues.addPropertyValue("targetDataSources", targetDataSources);
beanDefinitionRegistry.registerBeanDefinition("dataSource", beanDefinition);
}
}
好了纱新，這么一坨代碼丟在這兒展氓，相信讀者也看著費勁，接下來對動態(tài)數(shù)據(jù)源注冊器略作解釋
EnvironmentAware接口提供了一個setEnvironment(Environment environment)方法脸爱，通過這個方法我們可以從application.properties配置文件中獲取到所有數(shù)據(jù)源的配置信息遇汞，然后創(chuàng)建數(shù)據(jù)源并加載到內(nèi)存中
ImportBeanDefinitionRegistrar接口，光看接口名字大概都能猜到是做什么的簿废，對空入，就是注冊Bean的。該接口用于在系統(tǒng)處理@Configuration class時注冊更多的bean族檬。是bean定義級別的操作歪赢，而非@Bean method/instance級別的。該接口提供了registerBeanDefinitions方法单料，該方法是在Spring加載bean時被Spring調(diào)用埋凯。通過setEnvironment方法，已經(jīng)將配置文件中所有的數(shù)據(jù)源獲取到了扫尖，然后在registerBeanDefinitions方法中將所有數(shù)據(jù)源注冊到Spring容器中白对。
5、將動態(tài)數(shù)據(jù)源注冊器導(dǎo)入到Spring容器中
@SpringBootApplication
@Import({DynamicDataSourceRegister.class})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
需要注意的是换怖，使用@Import導(dǎo)入的類必須滿足符合以下的某一個條件：
- 導(dǎo)入的類使用@Configuration進行標(biāo)注
- 導(dǎo)入的類中至少有一個使用@Bean標(biāo)準(zhǔn)的方法
- 導(dǎo)入的類實現(xiàn)了ImportSelector接口
- 導(dǎo)入的類實現(xiàn)了ImportBeanDefinitionRegistrar接口
到這一步了甩恼，是不是就完了呢，當(dāng)然不是沉颂，以上這些步驟只是為切換數(shù)據(jù)源提供了基礎(chǔ)
- 6条摸、新建一個TargetDataSource注解
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {
String value();
}
此注解用來標(biāo)記當(dāng)前的方法的數(shù)據(jù)源的，在需要指定數(shù)據(jù)源的方法上標(biāo)記@TargetDataSource("AAA")注解即可兆览，還沒完屈溉，繼續(xù)往下看。
- 7抬探、新建數(shù)據(jù)源切換AOP切面
@Aspect
@Order(-1) //保證此AOP在@Transactional之前執(zhí)行
@Component
public class DynamicDataSourceAspect {
private transient static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceAspect.class);
// 通過注解切換數(shù)據(jù)源（細(xì)粒度）
@Around("@annotation(targetDataSource)")
public Object changeDataSource(ProceedingJoinPoint joinPoint, TargetDataSource targetDataSource) throws Throwable {
Object object = null;
String dataSourceId = targetDataSource.value();
if(DynamicDataSourceContextHolder.containsDataSource(dataSourceId)) {
logger.info("系統(tǒng)將使用{}數(shù)據(jù)源", dataSourceId);
DynamicDataSourceContextHolder.setDataSource(dataSourceId);
} else {
logger.debug("數(shù)據(jù)源{}不存在子巾，將使用默認(rèn)數(shù)據(jù)源{}", dataSourceId, joinPoint.getSignature());
}
object=joinPoint.proceed();
DynamicDataSourceContextHolder.clearDataSource();
return object;
}
}
解釋解釋帆赢，這個切面呢，就是切標(biāo)記了targetDataSource注解的方法线梗，根據(jù)targetDataSource注解的value值設(shè)置系統(tǒng)當(dāng)前的數(shù)據(jù)源椰于。使用注解方式算是一種細(xì)粒度的控制，可切換多個數(shù)據(jù)源仪搔；粗粒度的就是直接切某一個包路徑瘾婿，而且只能是兩個數(shù)據(jù)源互切。兩種方式各有各的好處烤咧，看業(yè)務(wù)需要偏陪。不過總的來說，能解決問題的方法就是好方法煮嫌。
最后附一下JNDI數(shù)據(jù)源在application.properties文件中的配置
spring.datasource.jndi-name=java:comp/env/jdbc/AAA,java:comp/env/jdbc/BBB
其實笛谦，JNDI數(shù)據(jù)源也可以直接配置到application.properties文件中，或者兩種模式都支持昌阿，此處不做累述饥脑。
------------------------------------------------華麗的分割線----------------------------------------------------
在項目的進展中，此數(shù)據(jù)源切換已被改造懦冰，增加了Druid數(shù)據(jù)源加密功能灶轰，因為是多數(shù)據(jù)源加密，和官網(wǎng)的有些不一樣刷钢，代碼就不一一累述笋颤，讀者若有需要，可自行研究或聯(lián)系博主獲取
關(guān)注我的微信公眾號：FramePower
我會不定期發(fā)布相關(guān)技術(shù)積累内地，歡迎對技術(shù)有追求椰弊、志同道合的朋友加入，一起學(xué)習(xí)成長瓤鼻！
