Spring Boot與多數據源那點事兒~

時間  2021-08-12
標籤 java mysql web spring sql 數據庫 apache markdown session mybatis 欄目 Spring 简体版
原文   原文鏈接

目錄

  • 前言
  • 寫這篇文章的目的
  • 什麼是多數據源？
  • 什麼時候用到多數據源？
  • 整合單一的數據源
  • 整合Mybatis
  • 多數據源如何整合？
    • 什麼是動態數據源？
    • 數據源切換如何保證線程隔離？
    • 如何構造一個動態數據源？
    • 定義一個註解
    • 如何與Mybatis整合？
    • 演示
  • 總結

前言

大約在19年的這個時候，老同事公司在作醫療系統，須要和HIS系統對接一些信息，好比患者、醫護、醫囑、科室等信息。可是起初並不知道如何與HIS無縫對接，因而向我取經。java

最終通過討論採用了視圖對接的方式，大體就是HIS系統提供視圖，他們進行對接。mysql

寫這篇文章的目的

這篇文章將會涉及到Spring Boot 與Mybatis、數據庫整合，相似於整合Mybatis與數據庫的文章其實網上不少，做者此前也寫過一篇文章詳細的介紹了一些整合的套路：Spring Boot 整合多點套路，少走點彎路~，有興趣的能夠看看。web

什麼是多數據源？

最多見的單一應用中最多涉及到一個數據庫，便是一個數據源（Datasource）。那麼顧名思義，多數據源就是在一個單一應用中涉及到了兩個及以上的數據庫了。spring

其實在配置數據源的時候就已經很明確這個定義了，如如下代碼：sql

@Bean(name = "dataSource")
    public DataSource dataSource() {
        DruidDataSource druidDataSource = new DruidDataSource();
        druidDataSource.setUrl(url);
        druidDataSource.setUsername(username);
        druidDataSource.setDriverClassName(driverClassName);
        druidDataSource.setPassword(password);
        return druidDataSource;
    }
複製代碼

url、username、password這三個屬性已經惟一肯定了一個數據庫了，DataSource則是依賴這三個建立出來的。則多數據源便是配置多個DataSource（暫且這麼理解）。數據庫

什麼時候用到多數據源？

正如前言介紹到的一個場景，相信大多數作過醫療系統的都會和HIS打交道，爲了簡化護士以及醫生的操做流程，必需要將必要的信息從HIS系統對接過來，據我瞭解的大體有兩種方案以下：apache

  1. HIS提供視圖，好比醫護視圖、患者視圖等，而此時其餘系統只須要定時的從HIS視圖中讀取數據同步到本身數據庫中便可。
  2. HIS提供接口，不管是webService仍是HTTP形式都是可行的，此時其餘系統只須要按照要求調接口便可。

很明顯第一種方案涉及到了至少兩個數據庫了，一個是HIS數據庫，一個本身系統的數據庫，在單一應用中必然須要用到多數據源的切換才能達到目的。markdown

固然多數據源的使用場景仍是有不少的，以上只是簡單的一個場景。session

整合單一的數據源

本文使用阿里的數據庫鏈接池druid，添加依賴以下：mybatis

<!--druid鏈接池-->
<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>druid-spring-boot-starter</artifactId>
   <version>1.1.9</version>
</dependency>
複製代碼

阿里的數據庫鏈接池很是強大，好比數據監控、數據庫加密等等內容，本文僅僅演示與Spring Boot整合的過程，一些其餘的功能後續能夠本身研究添加。

Druid鏈接池的starter的自動配置類是DruidDataSourceAutoConfigure，類上標註以下一行註解：

@EnableConfigurationProperties({DruidStatProperties.class, DataSourceProperties.class})
複製代碼

@EnableConfigurationProperties這個註解使得配置文件中的配置生效而且映射到指定類的屬性。

DruidStatProperties中指定的前綴是spring.datasource.druid，這個配置主要是用來設置鏈接池的一些參數。

DataSourceProperties中指定的前綴是spring.datasource，這個主要是用來設置數據庫的url、username、password等信息。

所以咱們只須要在全局配置文件中指定數據庫的一些配置以及鏈接池的一些配置信息便可，前綴分別是spring.datasource.druid、spring.datasource，如下是我的隨便配置的(application.properties)：

spring.datasource.url=jdbc\:mysql\://120.26.101.xxx\:3306/xxx?useUnicode\=true&characterEncoding\=UTF-8&zeroDateTimeBehavior\=convertToNull&useSSL\=false&allowMultiQueries\=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=xxxx
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#初始化鏈接大小
spring.datasource.druid.initial-size=0
#鏈接池最大使用鏈接數量
spring.datasource.druid.max-active=20
#鏈接池最小空閒
spring.datasource.druid.min-idle=0
#獲取鏈接最大等待時間
spring.datasource.druid.max-wait=6000
spring.datasource.druid.validation-query=SELECT 1
#spring.datasource.druid.validation-query-timeout=6000
spring.datasource.druid.test-on-borrow=false
spring.datasource.druid.test-on-return=false
spring.datasource.druid.test-while-idle=true
#配置間隔多久才進行一次檢測，檢測須要關閉的空閒鏈接，單位是毫秒
spring.datasource.druid.time-between-eviction-runs-millis=60000
#置一個鏈接在池中最小生存的時間，單位是毫秒
spring.datasource.druid.min-evictable-idle-time-millis=25200000
#spring.datasource.druid.max-evictable-idle-time-millis=
#打開removeAbandoned功能,多少時間內必須關閉鏈接
spring.datasource.druid.removeAbandoned=true
#1800秒，也就是30分鐘
spring.datasource.druid.remove-abandoned-timeout=1800
#<!-- 1800秒，也就是30分鐘 -->
spring.datasource.druid.log-abandoned=true
spring.datasource.druid.filters=mergeStat
複製代碼

在全局配置文件application.properties文件中配置以上的信息便可注入一個數據源到Spring Boot中。其實這僅僅是一種方式，下面介紹另一種方式。

在自動配置類中DruidDataSourceAutoConfigure中有以下一段代碼：

@Bean(initMethod = "init")
    @ConditionalOnMissingBean
    public DataSource dataSource() {
        LOGGER.info("Init DruidDataSource");
        return new DruidDataSourceWrapper();
    }
複製代碼

@ConditionalOnMissingBean和@Bean這兩個註解的結合，意味着咱們能夠覆蓋，只須要提早在IOC中注入一個DataSource類型的Bean便可。

所以咱們在自定義的配置類中定義以下配置便可：

/** * @Bean：向IOC容器中注入一個Bean * @ConfigurationProperties：使得配置文件中以spring.datasource爲前綴的屬性映射到Bean的屬性中 * @return */
    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean
    public DataSource dataSource(){
        //作一些其餘的自定義配置，好比密碼加密等......
        return new DruidDataSource();
    }
複製代碼

以上介紹了兩種數據源的配置方式，第一種比較簡單，第二種適合擴展，按需選擇。

整合Mybatis

Spring Boot 整合Mybatis其實很簡單，簡單的幾步就搞定，首先添加依賴：

<dependency>
     <groupId>org.mybatis.spring.boot</groupId>
     <artifactId>mybatis-spring-boot-starter</artifactId>
     <version>2.0.0</version>
</dependency>
複製代碼

第二步找到自動配置類MybatisAutoConfiguration，有以下一行代碼：

@EnableConfigurationProperties(MybatisProperties.class)
複製代碼

老套路了，全局配置文件中配置前綴爲mybatis的配置將會映射到該類中的屬性。

可配置的東西不少，好比XML文件的位置、類型處理器等等，以下簡單的配置：

mybatis.type-handlers-package=com.demo.typehandler
mybatis.configuration.map-underscore-to-camel-case=true
複製代碼

若是須要經過包掃描的方式注入Mapper，則須要在配置類上加入一個註解：@MapperScan，其中的value屬性指定須要掃描的包。

直接在全局配置文件配置各類屬性是一種比較簡單的方式，其實的任何組件的整合都有很多於兩種的配置方式，下面來介紹下配置類如何配置。

MybatisAutoConfiguration自動配置類有以下一斷代碼：

@Bean
  @ConditionalOnMissingBean
  public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {}
複製代碼

@ConditionalOnMissingBean和@Bean真是老搭檔了，意味着咱們又能夠覆蓋，只須要在IOC容器中注入SqlSessionFactory（Mybatis六劍客之一輩子產者）。

在自定義配置類中注入便可，以下：

/** * 注入SqlSessionFactory */
    @Bean("sqlSessionFactory1")
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:/mapper/**/*.xml"));
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        // 自動將數據庫中的下劃線轉換爲駝峯格式
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setDefaultFetchSize(100);
        configuration.setDefaultStatementTimeout(30);
        sqlSessionFactoryBean.setConfiguration(configuration);
        return sqlSessionFactoryBean.getObject();
    }
複製代碼

以上介紹了配置Mybatis的兩種方式，其實在大多數場景中使用第一種已經夠用了，至於爲何介紹第二種呢？固然是爲了多數據源的整合而作準備了。

在MybatisAutoConfiguration中有一行很重要的代碼，以下：

@ConditionalOnSingleCandidate(DataSource.class)
複製代碼

@ConditionalOnSingleCandidate這個註解的意思是當IOC容器中只有一個候選Bean的實例纔會生效。

這行代碼標註在Mybatis的自動配置類中有何含義呢？下面介紹，哈哈哈~

多數據源如何整合？

上文留下的問題：爲何的Mybatis自動配置上標註以下一行代碼：

@ConditionalOnSingleCandidate(DataSource.class)
複製代碼

以上這行代碼的言外之意：當IOC容器中只有一個數據源DataSource，這個自動配置類纔會生效。

哦？照這樣搞，多數據源是不能用Mybatis嗎？

可能你們會有一個誤解，認爲多數據源就是多個的DataSource並存的，固然這樣說也不是不正確。

多數據源的狀況下並非多個數據源並存的，Spring提供了AbstractRoutingDataSource這樣一個抽象類，使得可以在多數據源的狀況下任意切換，至關於一個動態路由的做用，做者稱之爲動態數據源。所以Mybatis只須要配置這個動態數據源便可。

什麼是動態數據源？

動態數據源簡單的說就是可以自由切換的數據源，相似於一個動態路由的感受，Spring 提供了一個抽象類AbstractRoutingDataSource，這個抽象類中喲一個屬性，以下：

private Map<Object, Object> targetDataSources;
複製代碼

targetDataSources是一個Map結構，全部須要切換的數據源都存放在其中，根據指定的KEY進行切換。固然還有一個默認的數據源。

AbstractRoutingDataSource這個抽象類中有一個抽象方法須要子類實現，以下：

protected abstract Object determineCurrentLookupKey();
複製代碼

determineCurrentLookupKey()這個方法的返回值決定了須要切換的數據源的KEY，就是根據這個KEY從targetDataSources取值（數據源）。

數據源切換如何保證線程隔離？

數據源屬於一個公共的資源，在多線程的狀況下如何保證線程隔離呢？不能我這邊切換了影響其餘線程的執行。

說到線程隔離，天然會想到ThreadLocal了，將切換數據源的KEY（用於從targetDataSources中取值）存儲在ThreadLocal中，執行結束以後清除便可。

單獨封裝了一個DataSourceHolder，內部使用ThreadLocal隔離線程，代碼以下：

/** * 使用ThreadLocal存儲切換數據源後的KEY */
public class DataSourceHolder {

    //線程 本地環境
    private static final ThreadLocal<String> dataSources = new InheritableThreadLocal();

    //設置數據源
    public static void setDataSource(String datasource) {
        dataSources.set(datasource);
    }

    //獲取數據源
    public static String getDataSource() {
        return dataSources.get();
    }

    //清除數據源
    public static void clearDataSource() {
        dataSources.remove();
    }
}
複製代碼

如何構造一個動態數據源？

上文說過只需繼承一個抽象類AbstractRoutingDataSource，重寫其中的一個方法determineCurrentLookupKey()便可。代碼以下：

/** * 動態數據源，繼承AbstractRoutingDataSource */
public class DynamicDataSource extends AbstractRoutingDataSource {

    /** * 返回須要使用的數據源的key，將會按照這個KEY從Map獲取對應的數據源（切換） * @return */
    @Override
    protected Object determineCurrentLookupKey() {
        //從ThreadLocal中取出KEY
        return DataSourceHolder.getDataSource();
    }

    /** * 構造方法填充Map，構建多數據源 */
    public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
        //默認的數據源，能夠做爲主數據源
        super.setDefaultTargetDataSource(defaultTargetDataSource);
        //目標數據源
        super.setTargetDataSources(targetDataSources);
        //執行afterPropertiesSet方法，完成屬性的設置
        super.afterPropertiesSet();
    }
}
複製代碼

上述代碼很簡單，分析以下：

  1. 一個多參的構造方法，指定了默認的數據源和目標數據源。
  2. 重寫determineCurrentLookupKey()方法，返回數據源對應的KEY，這裏是直接從ThreadLocal中取值，就是上文封裝的DataSourceHolder。

定義一個註解

爲了操做方便且低耦合，不能每次須要切換的數據源的時候都要手動調一下接口吧，能夠定義一個切換數據源的註解，以下：

/** * 切換數據源的註解 */
@Target(value = ElementType.METHOD)
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
public @interface SwitchSource {

    /** * 默認切換的數據源KEY */
    String DEFAULT_NAME = "hisDataSource";

    /** * 須要切換到數據的KEY */
    String value() default DEFAULT_NAME;
}
複製代碼

註解中只有一個value屬性，指定了須要切換數據源的KEY。

有註解還不行，固然還要有切面，代碼以下：

@Aspect
//優先級設置到最高
@Order(Ordered.HIGHEST_PRECEDENCE)
@Component
@Slf4j
public class DataSourceAspect {


    @Pointcut("@annotation(SwitchSource)")
    public void pointcut() {
    }

    /** * 在方法執行以前切換到指定的數據源 * @param joinPoint */
    @Before(value = "pointcut()")
    public void beforeOpt(JoinPoint joinPoint) {
        /*由於是對註解進行切面，因此這邊無需作過多斷定，直接獲取註解的值，進行環繞，將數據源設置成遠方，而後結束後，清楚當前線程數據源*/
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        SwitchSource switchSource = method.getAnnotation(SwitchSource.class);
        log.info("[Switch DataSource]:" + switchSource.value());
        DataSourceHolder.setDataSource(switchSource.value());
    }

    /** * 方法執行以後清除掉ThreadLocal中存儲的KEY，這樣動態數據源會使用默認的數據源 */
    @After(value = "pointcut()")
    public void afterOpt() {
        DataSourceHolder.clearDataSource();
        log.info("[Switch Default DataSource]");
    }
}
複製代碼

這個ASPECT很容易理解，beforeOpt()在方法以前執行，取值@SwitchSource中value屬性設置到ThreadLocal中;afterOpt()方法在方法執行以後執行，清除掉ThreadLocal中的KEY，保證了若是不切換數據源，則用默認的數據源。

如何與Mybatis整合？

單一數據源與Mybatis整合上文已經詳細講解了，數據源DataSource做爲參數構建了SqlSessionFactory，一樣的思想，只須要把這個數據源換成動態數據源便可。注入的代碼以下：

/** * 建立動態數據源的SqlSessionFactory，傳入的是動態數據源 * @Primary這個註解很重要，若是項目中存在多個SqlSessionFactory，這個註解必定要加上 */
    @Primary
    @Bean("sqlSessionFactory2")
    public SqlSessionFactory sqlSessionFactoryBean(DynamicDataSource dynamicDataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dynamicDataSource);
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setDefaultFetchSize(100);
        configuration.setDefaultStatementTimeout(30);
        sqlSessionFactoryBean.setConfiguration(configuration);
        return sqlSessionFactoryBean.getObject();
    }
複製代碼

與Mybatis整合很簡單，只須要把數據源替換成自定義的動態數據源DynamicDataSource。

那麼動態數據源如何注入到IOC容器中呢？看上文自定義的DynamicDataSource構造方法，確定須要兩個數據源了，所以必須先注入兩個或者多個數據源到IOC容器中，以下：

/** * @Bean：向IOC容器中注入一個Bean * @ConfigurationProperties：使得配置文件中以spring.datasource爲前綴的屬性映射到Bean的屬性中 */
    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean("dataSource")
    public DataSource dataSource(){
        return new DruidDataSource();
    }

    /** * 向IOC容器中注入另一個數據源 * 全局配置文件中前綴是spring.datasource.his */
    @Bean(name = SwitchSource.DEFAULT_NAME)
    @ConfigurationProperties(prefix = "spring.datasource.his")
    public DataSource hisDataSource() {
        return DataSourceBuilder.create().build();
    }
複製代碼

以上構建的兩個數據源，一個是默認的數據源，一個是須要切換到的數據源（targetDataSources），這樣就組成了動態數據源了。數據源的一些信息，好比url，username須要本身在全局配置文件中根據指定的前綴配置便可，代碼再也不貼出。

動態數據源的注入代碼以下：

/** * 建立動態數據源的SqlSessionFactory，傳入的是動態數據源 * @Primary這個註解很重要，若是項目中存在多個SqlSessionFactory，這個註解必定要加上 */
    @Primary
    @Bean("sqlSessionFactory2")
    public SqlSessionFactory sqlSessionFactoryBean(DynamicDataSource dynamicDataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dynamicDataSource);
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setDefaultFetchSize(100);
        configuration.setDefaultStatementTimeout(30);
        sqlSessionFactoryBean.setConfiguration(configuration);
        return sqlSessionFactoryBean.getObject();
    }
複製代碼

這裏還有一個問題：IOC中存在多個數據源了，那麼事務管理器怎麼辦呢？它也懵逼了，到底選擇哪一個數據源呢？所以事務管理器確定仍是要從新配置的。

事務管理器此時管理的數據源將是動態數據源DynamicDataSource，配置以下：

/** * 重寫事務管理器，管理動態數據源 */
    @Primary
    @Bean(value = "transactionManager2")
    public PlatformTransactionManager annotationDrivenTransactionManager(DynamicDataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
複製代碼

至此，Mybatis與多數據源的整合就完成了。

演示

使用也是很簡單，在須要切換數據源的方法上方標註@SwitchSource切換到指定的數據源便可，以下：

//不開啓事務
    @Transactional(propagation = Propagation.NOT_SUPPORTED)
    //切換到HIS的數據源
    @SwitchSource
    @Override
    public List<DeptInfo> list() {
        return hisDeptInfoMapper.listDept();
    }
複製代碼

這樣只要執行到這方法將會切換到HIS的數據源，方法執行結束以後將會清除，執行默認的數據源。

總結

本篇文章講了Spring Boot與單數據源、Mybatis、多數據源之間的整合，但願這篇文章可以幫助讀者理解多數據源的整合，雖然說用的很少，可是在有些領域仍然是比較重要的。

原創不易，點點贊分享一波，謝謝支持~

源碼已經上傳，須要源碼的朋友公衆號回覆關鍵詞多數據源。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程