Java注解实现动态数据源切换的实例代码

2024-02-17 17:33:04 50

当一个项目中有多个数据源（也可以是主从库）的时候，我们可以利用注解在mapper接口上标注数据源，从而来实现多个数据源在运行时的动态切换。

实现原理

在Spring2.0.1中引入了AbstractRoutingDataSource,该类充当了DataSource的路由中介,能有在运行时,根据某种key值来动态切换到真正的DataSource上。

看下AbstractRoutingDataSource：


publicabstractclassAbstractRoutingDataSourceextendsAbstractDataSourceimplementsInitializingBean

AbstractRoutingDataSource继承了AbstractDataSource，获取数据源部分：

/**
*RetrievethecurrenttargetDataSource.Determinesthe
*{@link#determineCurrentLookupKey()currentlookupkey},performs
*alookupinthe{@link#setTargetDataSourcestargetDataSources}map,
*fallsbacktothespecified
*{@link#setDefaultTargetDataSourcedefaulttargetDataSource}ifnecessary.
*@see#determineCurrentLookupKey()
*/
protectedDataSourcedetermineTargetDataSource(){
Assert.notNull(this.resolvedDataSources,"DataSourcerouternotinitialized");
ObjectlookupKey=determineCurrentLookupKey();
DataSourcedataSource=this.resolvedDataSources.get(lookupKey);
if(dataSource==null&&(this.lenientFallback||lookupKey==null)){
dataSource=this.resolvedDefaultDataSource;
}
if(dataSource==null){
thrownewIllegalStateException("CannotdeterminetargetDataSourceforlookupkey["+lookupKey+"]");
}
returndataSource;
}

抽象方法determineCurrentLookupKey()返回DataSource的key值，然后根据这个key从resolvedDataSources这个map里取出对应的DataSource，如果找不到，则用默认的resolvedDefaultDataSource。

我们要做的就是实现抽象方法determineCurrentLookupKey()返回数据源的key值。

使用方法

定义注解：

/**
*Createdbyhuangyangquanon2016/11/30.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public@interfaceDataSource{

DataSourceTypevalue();

}

注解为数据源的名称，可定义一个枚举类表示：

/**
*Createdbyhuangyangquanon2016/11/30.
*/
publicenumDataSourceType{

MASTER,
SLAVE

}

注解定义好了，我们利用Spring的AOP根据注解内容对数据源进行选择，这里需要利用上面提到的AbstractRoutingDataSource类，该类是能够实现数据源切换的关键所在。

定义类DynamicDataSource继承AbstractRoutingDataSource，并实现determineCurrentLookupKey()，返回数据源的key值。

/**
*Createdbyhuangyangquanon2016/11/30.
*/
publicclassDynamicDataSourceextendsAbstractRoutingDataSource{

@Override
protectedObjectdetermineCurrentLookupKey(){
returnDynamicDataSourceHolder.getDataSourceType();
}

}

DynamicDataSourceHolder是我们管理DataSource的类，将一次数据库操作的数据源名称保存在DynamicDataSourceHolder中，以供后面的操作在此context中取数据源key，其中DataSourceType使用了线程本地变量来保证线程安全。

/**
*Createdbyhuangyangquanon2016/11/30.
*/
publicclassDynamicDataSourceHolder{

//线程本地环境
privatestaticfinalThreadLocalcontextHolder=newThreadLocal();

//设置数据源类型
publicstaticvoidsetDataSourceType(DataSourceTypedataSourceType){
Assert.notNull(dataSourceType,"DataSourceTypecannotbenull");
contextHolder.set(dataSourceType);
}

//获取数据源类型
publicstaticDataSourceTypegetDataSourceType(){
return(DataSourceType)contextHolder.get();
}

//清除数据源类型
publicstaticvoidclearDataSourceType(){
contextHolder.remove();
}

}

我们在Spring的配置文件中配置数据源key值得对应关系：

设置targetDataSources和defaultTargetDataSource。TEST-MASTER-DB和TEST-SLAVE-DB表示主库的从库，是我们的两个数据源。

接下来配置AOP切面：

以下是切面中before执行的DataSourceAspect的实现，主要实现的功能是获取方法上的注解，根据注解名称将值设置到DynamicDataSourceHolder中，这样在执行查询的时候，determineCurrentLookupKey()返回数据源的key值就是我们希望的那个数据源了。

/**
*Createdbyhuangyangquanon2016/11/30.
*/
publicclassDataSourceAspect{

privatestaticfinalLoggerLOG=LoggerFactory.getLogger(DataSourceAspect.class);

publicvoidbefore(JoinPointpoint){
Objecttarget=point.getTarget();
Stringmethod=point.getSignature().getName();
Class[]classz=target.getClass().getInterfaces();
Class[]parameterTypes=((MethodSignature)point.getSignature()).getMethod().getParameterTypes();
try{
Methodm=classz[0].getMethod(method,parameterTypes);
if(m!=null&&m.isAnnotationPresent(DataSource.class)){
//访问mapper中的注解
DataSourcedata=m.getAnnotation(DataSource.class);
switch(data.value()){
caseMASTER:
DynamicDataSourceHolder.setDataSourceType(DataSourceType.MASTER);
LOG.info("usingdataSource:{}",DataSourceType.MASTER);
break;
caseSLAVE:
DynamicDataSourceHolder.setDataSourceType(DataSourceType.SLAVE);
LOG.info("usingdataSource:{}",DataSourceType.SLAVE);
break;
}
}
}catch(Exceptione){
LOG.error("dataSourceannotationerror:{}",e.getMessage());
//若出现异常，手动设为主库
DynamicDataSourceHolder.setDataSourceType(DataSourceType.MASTER);
}
}

}

这样我们就实现了一个动态数据源切换的功能。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

Java注解实现动态数据源切换的实例代码

热门推荐

随机推荐