使用Spring的AbstractRoutingDataSource实现多数据源切换示例

使用Spring的AbstractRoutingDataSource实现多数据源切换示例

最近因为项目需要在做两个项目间数据同步的需求，具体是项目1的数据通过消息队列同步到项目2中，因为这个更新操作还涉及到更新多个库的数据，所以就需要多数据源切换的操作。下面就讲讲在Spring中如何进行数据源切换。这里是使用AbstractRoutingDataSource类来完成具体的操作，AbstractRoutingDataSource是Spring2.0后增加的。

实现数据源切换的功能就是自定义一个类扩展AbstractRoutingDataSource抽象类，其实该相当于数据源DataSourcer的路由中介，可以实现在项目运行时根据相应key值切换到对应的数据源DataSource上。先看看AbstractRoutingDataSource的源码：

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {

/* 只列出部分代码 */

private Map

private Object defaultTargetDataSource;

private boolean lenientFallback = true;

private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();

private Map

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 (http://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 routeKey = new ThreadLocal

/**

* 获取当前线程的数据源路由的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文件中配置多个数据源：

到这里基本的配置就完成了，下面只要在需要切换数据源的地方调用方法就行了，一般是在dao层操作数据库前进行切换的，只需在数据库操作前加上如下代码即可：

DynamicDataSourceHolder.setRouteKey("dataSource2");

上面介绍的是在dao层当需要切换数据源时手动加上切换数据源的代码，也可以使用AOP的方式，把配置的数据源类型都设置成注解标签，在dao层中需要切换数据源操作的方法或类上写上注解标签，这样实现起来可操作性也更强。

@DataSourceKey("dataSource1")

public interface TestEntityMapper extends MSSQLMapper {

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配置文件上添加配置了（只列出部分配置）：

...

到此就完成使用AOP的方式实现多数据源的动态切换了。

/**

* 获取当前线程的数据源路由的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文件中配置多个数据源：

到这里基本的配置就完成了，下面只要在需要切换数据源的地方调用方法就行了，一般是在dao层操作数据库前进行切换的，只需在数据库操作前加上如下代码即可：

DynamicDataSourceHolder.setRouteKey("dataSource2");

上面介绍的是在dao层当需要切换数据源时手动加上切换数据源的代码，也可以使用AOP的方式，把配置的数据源类型都设置成注解标签，在dao层中需要切换数据源操作的方法或类上写上注解标签，这样实现起来可操作性也更强。

@DataSourceKey("dataSource1")

public interface TestEntityMapper extends MSSQLMapper {

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配置文件上添加配置了（只列出部分配置）：

...

到此就完成使用AOP的方式实现多数据源的动态切换了。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。