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

 更新时间:2017年08月11日 08:51:16   作者:Hing Kwan  
本篇文章主要介绍了浅谈利用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();
  }
}

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

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

相关文章

  • 基于IntelliJ IDEA的类注释和方法注释操作

    基于IntelliJ IDEA的类注释和方法注释操作

    这篇文章主要介绍了基于IntelliJ IDEA的类注释和方法注释操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • Spring Boot 如何正确读取配置文件属性

    Spring Boot 如何正确读取配置文件属性

    这篇文章主要介绍了Spring Boot 如何正确读取配置文件属性,项目中经常会经常读取配置文件中的属性的值,Spring Boot提供了很多注解读取配置文件属性,那么如何正确使用呢,下文一起来参考下面文章内容吧
    2022-04-04
  • Spring Boot创建可执行jar包的实例教程

    Spring Boot创建可执行jar包的实例教程

    这篇文章主要介绍了Spring Boot创建可执行jar包的实例教程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • Java 使用多线程调用类的静态方法的示例

    Java 使用多线程调用类的静态方法的示例

    这篇文章主要介绍了Java 使用多线程调用类的静态方法的示例,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-10-10
  • IDEA 单元测试覆盖技巧分享

    IDEA 单元测试覆盖技巧分享

    这篇文章主要介绍了IDEA 单元测试覆盖技巧分享,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • Java在Word中添加多行图片水印

    Java在Word中添加多行图片水印

    这篇文章主要介绍了Java在Word中添加多行图片,图文讲解的很清晰,有对于这方面不懂得同学可以跟着研究下
    2021-02-02
  • Java 文件上传的实例详解

    Java 文件上传的实例详解

    这篇文章主要介绍了Java 文件上传的实例详解的相关资料,希望通过本文大家能掌握这部分内容,使用几种文件上传的方法,需要的朋友可以参考下
    2017-09-09
  • Java windows环境构建图文教程

    Java windows环境构建图文教程

    这篇文章主要为大家介绍了Java windows环境构建图文教程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪<BR>
    2023-12-12
  • POI导出之Excel实现单元格的背景色填充问题

    POI导出之Excel实现单元格的背景色填充问题

    这篇文章主要介绍了POI导出之Excel实现单元格的背景色填充问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Java小白第一次就能看懂的网络编程

    Java小白第一次就能看懂的网络编程

    网络编程是指编写运行在多个设备(计算机)的程序,这些设备都通过网络连接起来。本文介绍了一些网络编程基础的概念,并用Java来实现TCP和UDP的Socket的编程,来让读者更好的了解其原理
    2021-08-08

最新评论