y0ngb1n

Aben Blog

欢迎来到我的技术小黑屋ヾ(◍°∇°◍)ノ゙
github

Spring Boot 配置多資料源

項目已托管於 GitHub:y0ngb1n/spring-boot-samples,歡迎 Star, Fork 😘


注意事項#

不同數據源的配置要分開

在 Spring 中,我們需要將兩個不同數據源的配置分開。如我們有一個 foo-datasource 和另一個 bar-datasource,那將這兩個 DataSource 的所有配置都要分開,不要將它們放在一起,就算它們除了 url 以外其它配置都相同,也建議你將它們分開配置,這樣會方便我們以後的配置管理。

關注每次使用的數據源

  • 有多個 DataSource 時系統如何判斷
  • 對應的設施(事務、ORM 等)如何選擇 DataSource

在編程的時候,我們要格外地注意當前在操作哪一個數據源,要告訴我們的系統要使用哪一個數據源,事務管理應該啟在哪個數據源上面;同時地我們也要告訴相關 ORM(像 Hibernate、MyBatis 類似的設施)此時是在操作哪一個數據源,因為這些框架並沒有幫我們考慮得這麼周全,所以在編碼時一定要格外地小心。

多數據源配置#

手工配置兩組 DataSource 及相關內容

如果我們完全地靠手工的配置,排除掉整個 Spring Boot 相關的依賴,全部都交由自己來配置肯定是可以的。

如果還是想與 Spring Boot 結合在一起的話可以參考下面的兩種方式。

與 Spring Boot 協同工作(二選一)

  • 方式一:配置 @Primary 類型的 Bean
  • 方式二:排除 Spring Boot 的自動配置
    • DataSourceAutoConfiguration
    • DataSourceTransactionManagerAutoConfiguration
    • JdbcTemplateAutoConfiguration

方式一:Spring 會把配置了 @Primary 的 Bean 作為主要的 Bean,在後面 Spring Boot 相關的自動配置都會環繞這個標誌了 @Primary 的 DataSource 進行配置。

方式二:如果你覺得這兩個 Bean 是沒有主次之分、這兩個 DataSource 都同等重要的,那麼我們可以排除掉方式二所列舉的 Bean。把它們排除掉之後,我們可以在代碼中自己來控制它,可參考如下代碼:

Step 01:排除 Spring Boot 的自動配置

@SpringBootApplication(exclude = {
  DataSourceAutoConfiguration.class,
  DataSourceTransactionManagerAutoConfiguration.class,
  JdbcTemplateAutoConfiguration.class
})
public class MultiDataSourceApplication {

  public static void main(String[] args) {
    SpringApplication.run(MultiDataSourceApplication.class, args);
  }
}

Step 02:添加 foobar 數據源配置

# Foo DataSource
foo:
  datasource:
    url: jdbc:h2:mem:foo
    username: sa
    password:

# Bar DataSource
bar:
  datasource:
    url: jdbc:h2:mem:bar
    username: sa
    password:

Step 03: 分別為 foo-datasourcebar-datasource 添加配置,及對應的事務管理器

@Slf4j
@Configuration
public class MultiDataSourceConfig {

  //---------------------------------------------------------------------
  // Config Foo DataSource
  //---------------------------------------------------------------------

  @Bean
  @ConfigurationProperties("foo.datasource")
  public DataSourceProperties fooDataSourceProperties() {
    return new DataSourceProperties();
  }

  @Bean
  public DataSource fooDataSource() {
    DataSourceProperties dataSourceProperties = fooDataSourceProperties();
    log.info("foo datasource: {}", dataSourceProperties.getUrl());
    return dataSourceProperties.initializeDataSourceBuilder().build();
  }

  @Bean
  @Resource
  public PlatformTransactionManager fooTxManager(DataSource fooDataSource) {
    return new DataSourceTransactionManager(fooDataSource);
  }
  
  //---------------------------------------------------------------------
  // Config Bar DataSource
  //---------------------------------------------------------------------

  @Bean
  @ConfigurationProperties("bar.datasource")
  public DataSourceProperties barDataSourceProperties() {
    return new DataSourceProperties();
  }

  @Bean
  public DataSource barDataSource() {
    DataSourceProperties dataSourceProperties = barDataSourceProperties();
    log.info("bar datasource: {}", dataSourceProperties.getUrl());
    return dataSourceProperties.initializeDataSourceBuilder().build();
  }

  @Bean
  @Resource
  public PlatformTransactionManager barTxManager(DataSource barDataSource) {
    return new DataSourceTransactionManager(barDataSource);
  }
}

Step 04: 檢驗是否配置成功

$ mvn spring-boot:run
...
2019-09-18 23:57:21.649  INFO 15826 --- [           main] i.g.y.s.m.config.MultiDataSourceConfig   : foo datasource: jdbc:h2:mem:foo
2019-09-18 23:57:21.708  INFO 15826 --- [           main] i.g.y.s.m.config.MultiDataSourceConfig   : bar datasource: jdbc:h2:mem:bar
...
$ curl -s http://localhost:8080/actuator/beans | jq
{
  "contexts": {
    "application": {
      "beans": {

        ...
        "fooDataSourceProperties": {
          "aliases": [],
          "scope": "singleton",
          "type": "org.springframework.boot.autoconfigure.jdbc.DataSourceProperties",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": []
        },
        "fooDataSource": {
          "aliases": [],
          "scope": "singleton",
          "type": "com.zaxxer.hikari.HikariDataSource",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": [
            "fooDataSourceProperties"
          ]
        },
        "fooTxManager": {
          "aliases": [],
          "scope": "singleton",
          "type": "org.springframework.jdbc.datasource.DataSourceTransactionManager",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": [
            "fooDataSource"
          ]
        },

        ...
        "barDataSourceProperties": {
          "aliases": [],
          "scope": "singleton",
          "type": "org.springframework.boot.autoconfigure.jdbc.DataSourceProperties",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": []
        },
        "barDataSource": {
          "aliases": [],
          "scope": "singleton",
          "type": "com.zaxxer.hikari.HikariDataSource",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": [
            "barDataSourceProperties"
          ]
        },
        "barTxManager": {
          "aliases": [],
          "scope": "singleton",
          "type": "org.springframework.jdbc.datasource.DataSourceTransactionManager",
          "resource": "class path resource [io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": [
            "barDataSource"
          ]
        },

        ...
        "multiDataSourceConfig": {
          "aliases": [],
          "scope": "singleton",
          "type": "io.github.y0ngb1n.samples.multidatasource.config.MultiDataSourceConfig$$EnhancerBySpringCGLIB$$63c24bed",
          "resource": "file [/Users/yangbin/workspace/coding/Java/spring-boot-samples/spring-boot-samples-multi-datasource/target/classes/io/github/y0ngb1n/samples/multidatasource/config/MultiDataSourceConfig.class]",
          "dependencies": []
        },
        ...
      },
      "parentId": null
    }
  }
}

上面可以查看到 Spring 中各 Bean 的依賴關係。

這樣就完成了 Spring Boot 中多數據源的配置。如果我們還有更多的數據源的話,配置也是類似的,參考上面的配置即可。


參考鏈接#

載入中......
此文章數據所有權由區塊鏈加密技術和智能合約保障僅歸創作者所有。