Spring动态注册多数据源的实现方法

2023-09-17 18:40:05 48

最近在做SaaS应用，数据库采用了单实例多schema的架构（详见参考资料1），每个租户有一个独立的schema，同时整个数据源有一个共享的schema，因此需要解决动态增删、切换数据源的问题。

在网上搜了很多文章后，很多都是讲主从数据源配置，或都是在应用启动前已经确定好数据源配置的，甚少讲在不停机的情况如何动态加载数据源，所以写下这篇文章，以供参考。

使用到的技术

Java8
Spring+SpringMVC+MyBatis
Druid连接池
Lombok
（以上技术并不影响思路实现，只是为了方便浏览以下代码片段）

思路

当一个请求进来的时候，判断当前用户所属租户，并根据租户信息切换至相应数据源，然后进行后续的业务操作。

代码实现

TenantConfigEntity（租户信息）
@EqualsAndHashCode(callSuper=false)
@Data
@FieldDefaults(level=AccessLevel.PRIVATE)
publicclassTenantConfigEntity{
/**
*租户id
**/
IntegertenantId;
/**
*租户名称
**/
StringtenantName;
/**
*租户名称key
**/
StringtenantKey;
/**
*数据库url
**/
StringdbUrl;
/**
*数据库用户名
**/
StringdbUser;
/**
*数据库密码
**/
StringdbPassword;
/**
*数据库public_key
**/
StringdbPublicKey;
}
DataSourceUtil（辅助工具类，非必要）
publicclassDataSourceUtil{
privatestaticfinalStringDATA_SOURCE_BEAN_KEY_SUFFIX="_data_source";
privatestaticfinalStringJDBC_URL_ARGS="?useUnicode=true&characterEncoding=UTF-8&useOldAliasMetadataBehavior=true&zeroDateTimeBehavior=convertToNull";
privatestaticfinalStringCONNECTION_PROPERTIES="config.decrypt=true;config.decrypt.key=";
/**
*拼接数据源的springbeankey
*/
publicstaticStringgetDataSourceBeanKey(StringtenantKey){
if(!StringUtils.hasText(tenantKey)){
returnnull;
}
returntenantKey+DATA_SOURCE_BEAN_KEY_SUFFIX;
}
/**
*拼接完整的JDBCURL
*/
publicstaticStringgetJDBCUrl(StringbaseUrl){
if(!StringUtils.hasText(baseUrl)){
returnnull;
}
returnbaseUrl+JDBC_URL_ARGS;
}
/**
*拼接完整的Druid连接属性
*/
publicstaticStringgetConnectionProperties(StringpublicKey){
if(!StringUtils.hasText(publicKey)){
returnnull;
}
returnCONNECTION_PROPERTIES+publicKey;
}
}

DataSourceContextHolder

使用ThreadLocal保存当前线程的数据源keyname，并实现set、get、clear方法；

publicclassDataSourceContextHolder{
privatestaticfinalThreadLocaldataSourceKey=newInheritableThreadLocal<>();
publicstaticvoidsetDataSourceKey(StringtenantKey){
dataSourceKey.set(tenantKey);
}
publicstaticStringgetDataSourceKey(){
returndataSourceKey.get();
}
publicstaticvoidclearDataSourceKey(){
dataSourceKey.remove();
}
}

DynamicDataSource（重点）

继承AbstractRoutingDataSource（建议阅读其源码，了解动态切换数据源的过程），实现动态选择数据源；

publicclassDynamicDataSourceextendsAbstractRoutingDataSource{
@Autowired
privateApplicationContextapplicationContext;
@Lazy
@Autowired
privateDynamicDataSourceSummonersummoner;
@Lazy
@Autowired
privateTenantConfigDAOtenantConfigDAO;
@Override
protectedStringdetermineCurrentLookupKey(){
StringtenantKey=DataSourceContextHolder.getDataSourceKey();
returnDataSourceUtil.getDataSourceBeanKey(tenantKey);
}
@Override
protectedDataSourcedetermineTargetDataSource(){
StringtenantKey=DataSourceContextHolder.getDataSourceKey();
StringbeanKey=DataSourceUtil.getDataSourceBeanKey(tenantKey);
if(!StringUtils.hasText(tenantKey)||applicationContext.containsBean(beanKey)){
returnsuper.determineTargetDataSource();
}
if(tenantConfigDAO.exist(tenantKey)){
summoner.registerDynamicDataSources();
}
returnsuper.determineTargetDataSource();
}
}

DynamicDataSourceSummoner（重点中的重点）

从数据库加载数据源信息，并动态组装和注册springbean，

@Slf4j
@Component
publicclassDynamicDataSourceSummonerimplementsApplicationListener{
//跟spring-data-source.xml的默认数据源id保持一致
privatestaticfinalStringDEFAULT_DATA_SOURCE_BEAN_KEY="defaultDataSource";
@Autowired
privateConfigurableApplicationContextapplicationContext;
@Autowired
privateDynamicDataSourcedynamicDataSource;
@Autowired
privateTenantConfigDAOtenantConfigDAO;
privatestaticbooleanloaded=false;
/**
*Spring加载完成后执行
*/
@Override
publicvoidonApplicationEvent(ContextRefreshedEventevent){
//防止重复执行
if(!loaded){
loaded=true;
try{
registerDynamicDataSources();
}catch(Exceptione){
log.error("数据源初始化失败,Exception:",e);
}
}
}
/**
*从数据库读取租户的DB配置,并动态注入Spring容器
*/
publicvoidregisterDynamicDataSources(){
//获取所有租户的DB配置
ListtenantConfigEntities=tenantConfigDAO.listAll();
if(CollectionUtils.isEmpty(tenantConfigEntities)){
thrownewIllegalStateException("应用程序初始化失败,请先配置数据源");
}
//把数据源bean注册到容器中
addDataSourceBeans(tenantConfigEntities);
}
/**
*根据DataSource创建bean并注册到容器中
*/
privatevoidaddDataSourceBeans(ListtenantConfigEntities){
MaptargetDataSources=Maps.newLinkedHashMap();
DefaultListableBeanFactorybeanFactory=(DefaultListableBeanFactory)applicationContext.getAutowireCapableBeanFactory();
for(TenantConfigEntityentity:tenantConfigEntities){
StringbeanKey=DataSourceUtil.getDataSourceBeanKey(entity.getTenantKey());
//如果该数据源已经在spring里面注册过,则不重新注册
if(applicationContext.containsBean(beanKey)){
DruidDataSourceexistsDataSource=applicationContext.getBean(beanKey,DruidDataSource.class);
if(isSameDataSource(existsDataSource,entity)){
continue;
}
}
//组装bean
AbstractBeanDefinitionbeanDefinition=getBeanDefinition(entity,beanKey);
//注册bean
beanFactory.registerBeanDefinition(beanKey,beanDefinition);
//放入map中，注意一定是刚才创建bean对象
targetDataSources.put(beanKey,applicationContext.getBean(beanKey));
}
//将创建的map对象set到targetDataSources；
dynamicDataSource.setTargetDataSources(targetDataSources);
//必须执行此操作，才会重新初始化AbstractRoutingDataSource中的resolvedDataSources，也只有这样，动态切换才会起效
dynamicDataSource.afterPropertiesSet();
}
/**
*组装数据源springbean
*/
privateAbstractBeanDefinitiongetBeanDefinition(TenantConfigEntityentity,StringbeanKey){
BeanDefinitionBuilderbuilder=BeanDefinitionBuilder.genericBeanDefinition(DruidDataSource.class);
builder.getBeanDefinition().setAttribute("id",beanKey);
//其他配置继承defaultDataSource
builder.setParentName(DEFAULT_DATA_SOURCE_BEAN_KEY);
builder.setInitMethodName("init");
builder.setDestroyMethodName("close");
builder.addPropertyValue("name",beanKey);
builder.addPropertyValue("url",DataSourceUtil.getJDBCUrl(entity.getDbUrl()));
builder.addPropertyValue("username",entity.getDbUser());
builder.addPropertyValue("password",entity.getDbPassword());
builder.addPropertyValue("connectionProperties",DataSourceUtil.getConnectionProperties(entity.getDbPublicKey()));
returnbuilder.getBeanDefinition();
}
/**
*判断Spring容器里面的DataSource与数据库的DataSource信息是否一致
*备注:这里没有判断public_key,因为另外三个信息基本可以确定唯一了
*/
privatebooleanisSameDataSource(DruidDataSourceexistsDataSource,TenantConfigEntityentity){
booleansameUrl=Objects.equals(existsDataSource.getUrl(),DataSourceUtil.getJDBCUrl(entity.getDbUrl()));
if(!sameUrl){
returnfalse;
}
booleansameUser=Objects.equals(existsDataSource.getUsername(),entity.getDbUser());
if(!sameUser){
returnfalse;
}
try{
StringdecryptPassword=ConfigTools.decrypt(entity.getDbPublicKey(),entity.getDbPassword());
returnObjects.equals(existsDataSource.getPassword(),decryptPassword);
}catch(Exceptione){
log.error("数据源密码校验失败,Exception:{}",e);
returnfalse;
}
}
}

spring-data-source.xml

DynamicDataSourceAspectAdvice

利用AOP自动切换数据源，仅供参考；

@Slf4j
@Aspect
@Component
@Order(1)//请注意：这里order一定要小于tx:annotation-driven的order，即先执行DynamicDataSourceAspectAdvice切面，再执行事务切面，才能获取到最终的数据源
@EnableAspectJAutoProxy(proxyTargetClass=true)
publicclassDynamicDataSourceAspectAdvice{
@Around("execution(*a.b.c.*.controller.*.*(..))")
publicObjectdoAround(ProceedingJoinPointjp)throwsThrowable{
ServletRequestAttributessra=(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequestrequest=sra.getRequest();
HttpServletResponseresponse=sra.getResponse();
StringtenantKey=request.getHeader("tenant");
//前端必须传入tenantheader,否则返回400
if(!StringUtils.hasText(tenantKey)){
WebUtils.toHttp(response).sendError(HttpServletResponse.SC_BAD_REQUEST);
returnnull;
}
log.info("当前租户key:{}",tenantKey);
DataSourceContextHolder.setDataSourceKey(tenantKey);
Objectresult=jp.proceed();
DataSourceContextHolder.clearDataSourceKey();
returnresult;
}
}

总结

以上所述是小编给大家介绍的Spring动态注册多数据源的实现方法，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！

Spring动态注册多数据源的实现方法

热门推荐

随机推荐