浅谈利用Spring的AbstractRoutingDataSource解决多数据源的问题

在互联网的服务端开发的时候，我们很经常要在一个项目中去调用不同的数据库。在这种情况下，必然要涉及到多数据源问题。那么，我们该如何解决多数据源问题呢？有没有一种方法来动态切换数据源呢？

答案是有的。万能的spring已经给了我们解决方案——利用abstractroutingdatasource。在 abstractroutingdatasource 类中，发现 getconnection() 方法，从名字上可以知道它是获得connection连接的。跟踪 getconnection() 方法， determinetargetdatasource() 就这么进入我们的视线，继续下去，我们发现了重点—— determinecurrentlookupkey() 。 determinecurrentlookupkey 方法是一个抽象方法，它的返回值就是我们要用到的数据源datasource的key，然后根据这个key从 resolveddatasources 这个map中取出datasource，如果找不到就使用默认的datasource。

知道了这些，我们就来用代码实现吧！以下的代码是基于spring boot，所以需要建立一个spring boot项目，然后引入spring-boot-starter-jdbc。项目中又有用到aop，肯定的，我们必须引入spring-boot-starter-aop。

接下来，我们需要建一个dynamicdatasource。

public class dynamicdatasourceextends abstractroutingdatasource{

  @override
  protectedobjectdeterminecurrentlookupkey(){
    string datasourcename = dynamicdatasourcecontextholder.getdatasourcename();
    return datasourcename;
  }
}

dynamicdatasource 继承了抽象类 abstractroutingdatasource ，实现了 determinecurrentlookupkey() 。在 dynamicdatasourcecontextholder 中，我们使用threadlocal维护 datasoucename 这个变量。这样，每一个线程都可以独立改变自己的副本，而不会影响其他线程所对应的副本。

/**
 * 动态数据源上下文
 */
public class dynamicdatasourcecontextholder{

  private static final threadlocal<string> contextholder = new threadlocal<>();
  public static list<string> datasourcenames = new arraylist<>();

  public static void setdatasourcename(string name){
    contextholder.set(name);
  }

  public staticstringgetdatasourcename(){
    return contextholder.get();
  }

  public static void cleardatasourcename(){
    contextholder.remove();
  }

  public static boolean containsdatasource(string datasourcename){
    return datasourcenames.contains(datasourcename);
  }

}

ok，我们已经有了动态数据源dynamicdatasource，也有了dynamicdatasourcecontextholder，我们怎么使用呢？让我们看下 datasourceconfig 。

@configuration
public class datasourceconfig{

  @bean(name = "primarydatasource")
  @configurationproperties(prefix = "spring.datasource.primary")
  @primary
  publicdatasourceprimarydatasource(){
    return datasourcebuilder.create().build();
  }

  @bean(name = "secondarydatasource")
  @configurationproperties(prefix = "spring.datasource.secondary")
  publicdatasourcesecondarydatasource(){
    return datasourcebuilder.create().build();
  }

  @autowired
  @qualifier("primarydatasource")
  private datasource primarydatasource;

  @autowired
  @qualifier("secondarydatasource")
  private datasource secondarydatasource;

  @bean
  publicdynamicdatasourcedatasource(){

    map<object, object> targetdatasources = new hashmap<>();
    targetdatasources.put("primarydatasource", primarydatasource);
    targetdatasources.put("secondarydatasource", secondarydatasource);

    dynamicdatasourcecontextholder.datasourcenames.add("primarydatasource");
    dynamicdatasourcecontextholder.datasourcenames.add("secondarydatasource");

    dynamicdatasource datasource = new dynamicdatasource();
    //设置数据源映射
    datasource.settargetdatasources(targetdatasources);
    //设置默认数据源，当无法映射到数据源时会使用默认数据源
    datasource.setdefaulttargetdatasource(primarydatasource);
    datasource.afterpropertiesset();

    return datasource;
  }

}

当然，上面的 datasourceconfig 还得搭配 application.properties 配置文件。

#
spring.datasource.primary.jdbcurl=jdbc:mysql://localhost/test1?usessl=false
spring.datasource.primary.username=root
spring.datasource.primary.password=root
spring.datasource.primary.driver-class-name=com.mysql.jdbc.driver
#
spring.datasource.secondary.jdbcurl=jdbc:mysql://localhost/test2?usessl=false
spring.datasource.secondary.username=root
spring.datasource.secondary.password=root
spring.datasource.secondary.driver-class-name=com.mysql.jdbc.driver

到现在为止，我们已经配置了动态的数据源，将我们的多个数据源设置给了dynamicdatasource。这样，我们就可以在service或者是dao中使用 dynamicdatasourcecontextholder.setdatasourcename("primarydatasource") 方法来动态切换数据源了。但是，这样的写法会不会感到很不爽呢？其实，我们可以在方法上使用注解来切换数据源。

自定义一个注解targetdatasource：

/**
 * 在方法上使用，用于指定使用哪个数据源
 */
@target({elementtype.method, elementtype.type})
@retention(retentionpolicy.runtime)
@documented
public @interface targetdatasource {

  stringvalue();

}

这样，我们就可以在service上如以下使用：

@targetdatasource(value = "primarydatasource")
publiclist<customer>findall(){
  //todo
  return null;
}

@targetdatasource(value = "secondarydatasource")
public void addcustomer(string name, string email){

}

很明显的，到目前为止还不能完成我们的切换需求。我们还需要一段代码，来实现动态调用 dynamicdatasourcecontextholder.setdatasourcename("xxx") ，比较好的实现就是aop啦。

@aspect
@component
@order(-1)// 保证该aop在@transactional之前执行
public class dynamicdatasourcechangeaspect{

  private static final logger logger = loggerfactory.getlogger(dynamicdatasourcechangeaspect.class);

  @before("@annotation(targetdatasource)")
  public void changedatasource(joinpoint joinpoint, targetdatasource targetdatasource){
    string dsname = targetdatasource.value();
    if (!dynamicdatasourcecontextholder.containsdatasource(dsname)) {
      system.err.println("数据源[{}]不存在，使用默认数据源 > {}" + targetdatasource.value() + joinpoint.getsignature());
    } else {
      dynamicdatasourcecontextholder.setdatasourcename(targetdatasource.value()); //设置到动态数据源上下文中
    }
  }

  @after("@annotation(targetdatasource)")
  public void restoredatasource(joinpoint point, targetdatasource targetdatasource){
    //方法执行完毕之后，销毁当前数据源信息，进行垃圾回收。
    dynamicdatasourcecontextholder.cleardatasourcename();
  }
}

到现在为止，我们就实现了动态切换数据源了。

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