使用Spring的AbstractRoutingDataSource实现多数据源切换示例
最近因为项目需要在做两个项目间数据同步的需求,具体是项目1的数据通过消息队列同步到项目2中,因为这个更新操作还涉及到更新多个库的数据,所以就需要多数据源切换的操作。下面就讲讲在spring中如何进行数据源切换。这里是使用abstractroutingdatasource类来完成具体的操作,abstractroutingdatasource是spring2.0后增加的。
实现数据源切换的功能就是自定义一个类扩展abstractroutingdatasource抽象类,其实该相当于数据源datasourcer的路由中介,可以实现在项目运行时根据相应key值切换到对应的数据源datasource上。先看看abstractroutingdatasource的源码:
public abstract class abstractroutingdatasource extends abstractdatasource implements initializingbean { /* 只列出部分代码 */ private map<object, object> targetdatasources; private object defaulttargetdatasource; private boolean lenientfallback = true; private datasourcelookup datasourcelookup = new jndidatasourcelookup(); private map<object, datasource> resolveddatasources; private datasource resolveddefaultdatasource; @override public connection getconnection() throws sqlexception { return determinetargetdatasource().getconnection(); } @override public connection getconnection(string username, string password) throws sqlexception { return determinetargetdatasource().getconnection(username, password); } 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; } protected abstract object determinecurrentlookupkey(); }
从源码可以看出abstractroutingdatasource继承了abstractdatasource并实现了initializingbean,abstractroutingdatasource的getconnection()方法调用了determinetargetdatasource()的该方法,这里重点看determinetargetdatasource()方法代码,方法里使用到了determinecurrentlookupkey()方法,它是abstractroutingdatasource类的抽象方法,也是实现数据源切换要扩展的方法,该方法的返回值就是项目中所要用的datasource的key值,拿到该key后就可以在resolveddatasource中取出对应的datasource,如果key找不到对应的datasource就使用默认的数据源。
自定义类扩展abstractroutingdatasource类时就是要重写determinecurrentlookupkey()方法来实现数据源切换功能。下面是自定义的扩展abstractroutingdatasource类的实现:
/** * 获得数据源 */ public class multipledatasource extends abstractroutingdatasource{ @override protected object determinecurrentlookupkey() { return dynamicdatasourceholder.getroutekey(); } }
dynamicdatasourceholder类如下,实现对数据源的操作功能:
/** * 数据源操作类 */ public class dynamicdatasourceholder { private static threadlocal<string> routekey = new threadlocal<string>(); /** * 获取当前线程的数据源路由的key */ public static string getroutekey() { string key = routekey.get(); return key; } /** * 绑定当前线程数据源路由的key * 使用完成后必须调用removeroutekey()方法删除 */ public static void setroutekey(string key) { routekey.set(key); } /** * 删除与当前线程绑定的数据源路由的key */ public static void removeroutekey() { routekey.remove(); } }
下面在xml文件中配置多个数据源:
<!-- 数据源 --> <bean id="datasource1" class="org.apache.commons.dbcp.basicdatasource"> <property name="driverclassname" value="net.sourceforge.jtds.jdbc.driver"> </property> <property name="url" value="jdbc:jtds:sqlserver://127.0.0.1;databasename=test"> </property> <property name="username" value="***"></property> <property name="password" value="***"></property> </bean> <bean id="datasource2" class="org.apache.commons.dbcp.basicdatasource"> <property name="driverclassname" value="net.sourceforge.jtds.jdbc.driver"> </property> <property name="url" value="jdbc:jtds:sqlserver://127.0.0.2:1433;databasename=test"> </property> <property name="username" value="***"></property> <property name="password" value="***"></property> </bean> <!-- 配置多数据源映射 --> <bean id="multipledatasource" class="multipledatasource" > <property name="targetdatasources"> <map key-type="java.lang.string"> <entry value-ref="datasource1" key="datasource1"></entry> <entry value-ref="datasource2" key="datasource2"></entry> </map> </property> <!-- 默认数据源 --> <property name="defaulttargetdatasource" ref="datasource1" > </property> </bean>
到这里基本的配置就完成了,下面只要在需要切换数据源的地方调用方法就行了,一般是在dao层操作数据库前进行切换的,只需在数据库操作前加上如下代码即可:
dynamicdatasourceholder.setroutekey("datasource2");
上面介绍的是在dao层当需要切换数据源时手动加上切换数据源的代码,也可以使用aop的方式,把配置的数据源类型都设置成注解标签,在dao层中需要切换数据源操作的方法或类上写上注解标签,这样实现起来可操作性也更强。
@datasourcekey("datasource1") public interface testentitymapper extends mssqlmapper<testentity> { public void inserttest(testentity testentity); }
datasourcekey注解代码如下:
@target({elementtype.type,elementtype.method}) @retention(retentionpolicy.runtime) @documented public @interface datasourcekey { string value() default ""; }
注解配置完后就要写一个实现数据源切换的类,如下:
public class multipledatasourceexchange { /** * 拦截目标方法,获取由@datasource指定的数据源标识,设置到线程存储中以便切换数据源 */ public void beforedaomethod(joinpoint point) throws exception { class<?> target = point.gettarget().getclass(); methodsignature signature = (methodsignature) point.getsignature(); // 默认使用目标类型的注解,如果没有则使用其实现接口的注解类 for (class<?> cls : target.getinterfaces()) { resetdatasource(cls, signature.getmethod()); } resetdatasource(target, signature.getmethod()); } /** * 提取目标对象方法注解和类注解中的数据源标识 */ private void resetdatasource(class<?> cls, method method) { try { class<?>[] types = method.getparametertypes(); // 默认使用类注解 if (cls.isannotationpresent(datasourcekey.class)) { datasourcekey source = cls.getannotation(datasourcekey.class); dynamicdatasourceholder.setroutekey(source.value()); } // 方法注解可以覆盖类注解 method m = cls.getmethod(method.getname(), types); if (m != null && m.isannotationpresent(datasourcekey.class)) { datasourcekey source = m.getannotation(datasourcekey.class); dynamicdatasourceholder.setroutekey(source.value()); } } catch (exception e) { system.out.println(cls + ":" + e.getmessage()); } } }
代码写完后就要在xml配置文件上添加配置了(只列出部分配置):
<bean id="multipledatasourceexchange" class="multipledatasourceexchange "/> <bean id="txmanager" class="org.springframework.jdbc.datasource.datasourcetransactionmanager"> <property name="datasource" ref="multipledatasource" /> </bean> <tx:advice id="txadvice" transaction-manager="txmanager"> <tx:attributes> <tx:method name="insert*" propagation="nested" rollback-for="exception"/> <tx:method name="add*" propagation="nested" rollback-for="exception"/> ... </tx:attributes> </tx:advice> <aop:config> <aop:pointcut id="service" expression="execution(* com.datasource..*.service.*.*(..))"/> <!-- 注意切换数据源操作要比持久层代码先执行 --> <aop:advisor advice-ref="multipledatasourceexchange" pointcut-ref="service" order="1"/> <aop:advisor advice-ref="txadvice" pointcut-ref="service" order="2"/> </aop:config>
到此就完成使用aop的方式实现多数据源的动态切换了。
下一篇: Yii2框架实现数据库常用操作总结
推荐阅读
-
使用Spring的AbstractRoutingDataSource实现多数据源切换示例
-
Spring(AbstractRoutingDataSource)实现动态数据源切换示例
-
使用Spring Data JDBC实现DDD聚合的示例代码
-
使用Spring的AbstractRoutingDataSource实现多数据源切换示例
-
Spring(AbstractRoutingDataSource)实现动态数据源切换示例
-
使用Spring boot 的profile功能实现多环境配置自动切换
-
Spring配置多个数据源并实现动态切换示例
-
Spring配置多个数据源并实现动态切换示例
-
使用Spring boot 的profile功能实现多环境配置自动切换
-
Spring Security OAuth2实现使用JWT的示例代码