1
This commit is contained in:
esacpe
@ -0,0 +1,19 @@
|
||||
package com.common.dynamic.datasource;
|
||||
|
||||
import java.lang.annotation.*;
|
||||
|
||||
/**
|
||||
* 切换数据注解 可以用于类或者方法级别 方法级别优先级 > 类级别
|
||||
*
|
||||
* @author kevin
|
||||
* @date 2022/4/29 8:59 上午
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Documented
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PARAMETER})
|
||||
public @interface DataSource {
|
||||
|
||||
String value() default "master";
|
||||
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
package com.common.dynamic.datasource;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.aspectj.lang.JoinPoint;
|
||||
import org.aspectj.lang.annotation.After;
|
||||
import org.aspectj.lang.annotation.Aspect;
|
||||
import org.aspectj.lang.annotation.Before;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Slf4j
|
||||
@Aspect
|
||||
@Component
|
||||
public class DynamicDataSourceAspect {
|
||||
|
||||
@Before("@annotation(ds)")
|
||||
public void changeDataSource(JoinPoint point, DataSource ds) throws Throwable {
|
||||
String dsId = ds.value();
|
||||
if (DynamicDataSourceContextHolder.dataSourceIds.contains(dsId)) {
|
||||
log.debug("Use DataSource :{} >", dsId, point.getSignature());
|
||||
} else {
|
||||
log.info("数据源[{}]不存在，使用默认数据源 >{}", dsId, point.getSignature());
|
||||
DynamicDataSourceContextHolder.setDataSourceRouterKey(dsId);
|
||||
}
|
||||
}
|
||||
|
||||
@After("@annotation(ds)")
|
||||
public void restoreDataSource(JoinPoint point, DataSource ds) {
|
||||
log.debug("Revert DataSource : " + ds.value() + " > " + point.getSignature());
|
||||
DynamicDataSourceContextHolder.removeDataSourceRouterKey();
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,55 @@
|
||||
package com.common.dynamic.datasource;
|
||||
|
||||
import com.alibaba.ttl.TransmittableThreadLocal;
|
||||
import com.google.common.collect.Lists;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* 动态数据源处理器
|
||||
* @author kevin
|
||||
* @date 2022/4/29 9:02 上午
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Slf4j
|
||||
public class DynamicDataSourceContextHolder {
|
||||
|
||||
/**
|
||||
* 存储已经注册的数据源的key
|
||||
*/
|
||||
public static List<String> dataSourceIds = new ArrayList<>();
|
||||
|
||||
/**
|
||||
* 使用{@link TransmittableThreadLocal} 进行存储，使用线程池等后还能获取到
|
||||
*/
|
||||
private static final ThreadLocal<String> HOLDER = TransmittableThreadLocal.withInitial(() -> null);
|
||||
|
||||
public static String getDataSourceRouterKey () {
|
||||
return HOLDER.get();
|
||||
}
|
||||
|
||||
public static void setDataSourceRouterKey (String dataSourceRouterKey) {
|
||||
log.info("切换至{}数据源", dataSourceRouterKey);
|
||||
HOLDER.set(dataSourceRouterKey);
|
||||
}
|
||||
|
||||
/**
|
||||
* 设置数据源之前一定要先移除
|
||||
*/
|
||||
public static void removeDataSourceRouterKey () {
|
||||
HOLDER.remove();
|
||||
}
|
||||
|
||||
/**
|
||||
* 判断指定DataSrouce当前是否存在
|
||||
*
|
||||
* @param dataSourceId
|
||||
* @return
|
||||
*/
|
||||
public static boolean containsDataSource(String dataSourceId){
|
||||
return dataSourceIds.contains(dataSourceId);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,175 @@
|
||||
package com.common.dynamic.datasource;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.beans.MutablePropertyValues;
|
||||
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
|
||||
import org.springframework.beans.factory.support.GenericBeanDefinition;
|
||||
import org.springframework.boot.context.properties.bind.Bindable;
|
||||
import org.springframework.boot.context.properties.bind.Binder;
|
||||
import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
|
||||
import org.springframework.boot.context.properties.source.ConfigurationPropertyNameAliases;
|
||||
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
|
||||
import org.springframework.boot.context.properties.source.MapConfigurationPropertySource;
|
||||
import org.springframework.context.EnvironmentAware;
|
||||
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.core.type.AnnotationMetadata;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* 动态数据源注册
|
||||
* 实现 ImportBeanDefinitionRegistrar 实现数据源注册
|
||||
* 实现 EnvironmentAware 用于读取application.yml配置
|
||||
*/
|
||||
@Slf4j
|
||||
public class DynamicDataSourceRegister implements ImportBeanDefinitionRegistrar, EnvironmentAware {
|
||||
|
||||
/**
|
||||
* 配置上下文（也可以理解为配置文件的获取工具）
|
||||
*/
|
||||
private Environment evn;
|
||||
|
||||
/**
|
||||
* 别名
|
||||
*/
|
||||
private final static ConfigurationPropertyNameAliases aliases = new ConfigurationPropertyNameAliases();
|
||||
|
||||
/**
|
||||
* 由于部分数据源配置不同，所以在此处添加别名，避免切换数据源出现某些参数无法注入的情况
|
||||
*/
|
||||
static {
|
||||
aliases.addAliases("url", new String[]{"jdbc-url"});
|
||||
aliases.addAliases("username", new String[]{"user"});
|
||||
}
|
||||
|
||||
/**
|
||||
* 存储我们注册的数据源
|
||||
*/
|
||||
private Map<String, DataSource> customDataSources = new HashMap<String, DataSource>();
|
||||
|
||||
/**
|
||||
* 参数绑定工具 springboot2.0新推出
|
||||
*/
|
||||
private Binder binder;
|
||||
|
||||
/**
|
||||
* ImportBeanDefinitionRegistrar接口的实现方法，通过该方法可以按照自己的方式注册bean
|
||||
*
|
||||
* @param annotationMetadata
|
||||
* @param beanDefinitionRegistry
|
||||
*/
|
||||
@Override
|
||||
public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
|
||||
// 获取所有数据源配置
|
||||
Map config, defauleDataSourceProperties;
|
||||
defauleDataSourceProperties = binder.bind("spring.datasource.master", Map.class).get();
|
||||
// 获取数据源类型
|
||||
String typeStr = evn.getProperty("spring.datasource.master.type");
|
||||
// 获取数据源类型
|
||||
Class<? extends DataSource> clazz = getDataSourceType(typeStr);
|
||||
// 绑定默认数据源参数 也就是主数据源
|
||||
DataSource consumerDatasource, defaultDatasource = bind(clazz, defauleDataSourceProperties);
|
||||
DynamicDataSourceContextHolder.dataSourceIds.add("master");
|
||||
log.info("注册默认数据源成功");
|
||||
// 获取其他数据源配置
|
||||
List<Map> configs = binder.bind("spring.datasource.cluster", Bindable.listOf(Map.class)).get();
|
||||
// 遍历从数据源
|
||||
for (int i = 0; i < configs.size(); i++) {
|
||||
config = configs.get(i);
|
||||
clazz = getDataSourceType((String) config.get("type"));
|
||||
defauleDataSourceProperties = config;
|
||||
// 绑定参数
|
||||
consumerDatasource = bind(clazz, defauleDataSourceProperties);
|
||||
// 获取数据源的key，以便通过该key可以定位到数据源
|
||||
String key = config.get("key").toString();
|
||||
customDataSources.put(key, consumerDatasource);
|
||||
// 数据源上下文，用于管理数据源与记录已经注册的数据源key
|
||||
DynamicDataSourceContextHolder.dataSourceIds.add(key);
|
||||
log.info("注册数据源{}成功", key);
|
||||
}
|
||||
// bean定义类
|
||||
GenericBeanDefinition define = new GenericBeanDefinition();
|
||||
// 设置bean的类型，此处DynamicRoutingDataSource是继承AbstractRoutingDataSource的实现类
|
||||
define.setBeanClass(DynamicRoutingDataSource.class);
|
||||
// 需要注入的参数
|
||||
MutablePropertyValues mpv = define.getPropertyValues();
|
||||
// 添加默认数据源，避免key不存在的情况没有数据源可用
|
||||
mpv.add("defaultTargetDataSource", defaultDatasource);
|
||||
// 添加其他数据源
|
||||
mpv.add("targetDataSources", customDataSources);
|
||||
// 将该bean注册为datasource，不使用springboot自动生成的datasource
|
||||
beanDefinitionRegistry.registerBeanDefinition("datasource", define);
|
||||
log.info("注册数据源成功，一共注册{}个数据源", customDataSources.keySet().size() + 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* 通过字符串获取数据源class对象
|
||||
*
|
||||
* @param typeStr
|
||||
* @return
|
||||
*/
|
||||
private Class<? extends DataSource> getDataSourceType(String typeStr) {
|
||||
Class<? extends DataSource> type = null;
|
||||
try {
|
||||
if (StringUtils.hasLength(typeStr)) {
|
||||
// 字符串不为空则通过反射获取class对象
|
||||
type = (Class<? extends DataSource>) Class.forName(typeStr);
|
||||
} else {
|
||||
// 默认为hikariCP数据源，与springboot默认数据源保持一致
|
||||
// type = HikariDataSource.class;
|
||||
}
|
||||
return type;
|
||||
} catch (Exception e) {
|
||||
throw new IllegalArgumentException("can not resolve class with type: " + typeStr); //无法通过反射获取class对象的情况则抛出异常，该情况一般是写错了，所以此次抛出一个runtimeexception
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 绑定参数，以下三个方法都是参考DataSourceBuilder的bind方法实现的，目的是尽量保证我们自己添加的数据源构造过程与springboot保持一致
|
||||
*
|
||||
* @param result
|
||||
* @param properties
|
||||
*/
|
||||
private void bind(DataSource result, Map properties) {
|
||||
ConfigurationPropertySource source = new MapConfigurationPropertySource(properties);
|
||||
Binder binder = new Binder(new ConfigurationPropertySource[]{source.withAliases(aliases)});
|
||||
// 将参数绑定到对象
|
||||
binder.bind(ConfigurationPropertyName.EMPTY, Bindable.ofInstance(result));
|
||||
}
|
||||
|
||||
private <T extends DataSource> T bind(Class<T> clazz, Map properties) {
|
||||
ConfigurationPropertySource source = new MapConfigurationPropertySource(properties);
|
||||
Binder binder = new Binder(new ConfigurationPropertySource[]{source.withAliases(aliases)});
|
||||
// 通过类型绑定参数并获得实例对象
|
||||
return binder.bind(ConfigurationPropertyName.EMPTY, Bindable.of(clazz)).get();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param clazz
|
||||
* @param sourcePath 参数路径，对应配置文件中的值，如: spring.datasource
|
||||
* @param <T>
|
||||
* @return
|
||||
*/
|
||||
private <T extends DataSource> T bind(Class<T> clazz, String sourcePath) {
|
||||
Map properties = binder.bind(sourcePath, Map.class).get();
|
||||
return bind(clazz, properties);
|
||||
}
|
||||
|
||||
/**
|
||||
* EnvironmentAware接口的实现方法，通过aware的方式注入，此处是environment对象
|
||||
*
|
||||
* @param environment
|
||||
*/
|
||||
@Override
|
||||
public void setEnvironment(Environment environment) {
|
||||
log.info("开始注册数据源");
|
||||
this.evn = environment;
|
||||
// 绑定配置器
|
||||
binder = Binder.get(evn);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
package com.common.dynamic.datasource;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
|
||||
|
||||
/**
|
||||
* @Auther: yukong
|
||||
* @Date: 2018/8/15 10:47
|
||||
* @Description: 动态数据源路由配置
|
||||
*/
|
||||
@Slf4j
|
||||
public class DynamicRoutingDataSource extends AbstractRoutingDataSource {
|
||||
|
||||
|
||||
@Override
|
||||
protected Object determineCurrentLookupKey() {
|
||||
String dataSourceName = DynamicDataSourceContextHolder.getDataSourceRouterKey();
|
||||
log.info("当前数据源是：{}", dataSourceName);
|
||||
return DynamicDataSourceContextHolder.getDataSourceRouterKey();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user