Spring Boot + Mybatis 實現動態數據源

動態數據源

在很多具體應用場景的時候，我們需要用到動態數據源的情況，比如多租戶的場景，系統登錄時需要根據用戶信息切換到用戶對應的數據庫。又比如業務A要訪問A數據庫，業務B要訪問B數據庫等，都可以使用動態數據源方案進行解決。接下來，我們就來講解如何實現動態數據源，以及在過程中剖析動態數據源背后的實現原理。

實現案例

本教程案例基於 Spring Boot + Mybatis + MySQL 實現。

數據庫設計

首先需要安裝好MySQL數據庫，新建數據庫 example，創建example表，用來測試數據源，SQL腳本如下：

 CREATE TABLE `example` (
  `pk` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `message` varchar(100) NOT NULL,
  `create_time` datetime NOT NULL COMMENT '創建時間',
  `modify_time` datetime DEFAULT NULL COMMENT '生效時間',
  PRIMARY KEY (`pk`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 ROW_FORMAT=COMPACT COMMENT='測試用例表'

添加依賴

添加Spring Boot，Spring Aop，Mybatis，MySQL相關依賴。

pom.xml

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>1.3.1</version>
    </dependency>
    <!-- spring aop -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.8</version>
    </dependency>

自定義配置文件

新建自定義配置文件resource/config/mysql/db.properties，添加數據源:

#數據庫設置
spring.datasource.example.jdbc-url=jdbc:mysql://localhost:3306/example?characterEncoding=UTF-8
spring.datasource.example.username=root
spring.datasource.example.password=123456
spring.datasource.example.driver-class-name=com.mysql.jdbc.Driver

啟動類

啟動類添加 exclude = {DataSourceAutoConfiguration.class}， 以禁用數據源默認自動配置。

數據源默認自動配置會讀取 spring.datasource.* 的屬性創建數據源，所以要禁用以進行定制。

DynamicDatasourceApplication.java:

package com.main.example.dynamic.datasource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

@SpringBootApplication(exclude = {
        DataSourceAutoConfiguration.class
})
public class DynamicDatasourceApplication {
 
  public static void main(String[] args) {
    SpringApplication.run(DynamicDatasourceApplication.class, args);
  }

}

數據源配置類

創建一個數據源配置類，主要做以下幾件事情：

1. 配置 dao，model(bean)，xml mapper文件的掃描路徑。

2. 注入數據源配置屬性，創建數據源。

3. 創建一個動態數據源，裝入數據源。

4. 將動態數據源設置到SQL會話工廠和事務管理器。

如此，當進行數據庫操作時，就會通過我們創建的動態數據源去獲取要操作的數據源了。

DbSourceConfig.java:

package com.main.example.config.dao;

import com.main.example.common.DataEnum;
import com.main.example.common.DynamicDataSource;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;

import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;

//數據庫配置統一在config/mysql/db.properties中
@Configuration
@PropertySource(value = "classpath:config/mysql/db.properties")
public class DbSourceConfig {
    private String typeAliasesPackage = "com.main.example.bean.**.*";

    @Bean(name = "exampleDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.example")
    public DataSource exampleDataSource() {
        return DataSourceBuilder.create().build();
    }

    /*
     * 動態數據源
     * dbMap中存放數據源名稱與數據源實例，數據源名稱存於DataEnum.DbSource中
     * setDefaultTargetDataSource方法設置默認數據源
     */
    @Bean(name = "dynamicDataSource")
    public DataSource dynamicDataSource() {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        //配置多數據源
        Map<Object, Object> dbMap = new HashMap();
        dbMap.put(DataEnum.DbSource.example.getName(), exampleDataSource());
        dynamicDataSource.setTargetDataSources(dbMap);

        // 設置默認數據源
        dynamicDataSource.setDefaultTargetDataSource(exampleDataSource());

        return dynamicDataSource;
    }

    /*
     * 數據庫連接會話工廠
     * 將動態數據源賦給工廠
     * mapper存於resources/mapper目錄下
     * 默認bean存於com.main.example.bean包或子包下，也可直接在mapper中指定
     */
    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactoryBean sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean sqlSessionFactory = new SqlSessionFactoryBean();
        sqlSessionFactory.setDataSource(dynamicDataSource());
        sqlSessionFactory.setTypeAliasesPackage(typeAliasesPackage); //掃描bean
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        sqlSessionFactory.setMapperLocations(resolver.getResources("classpath*:mapper/*.xml"));    // 掃描映射文件

        return sqlSessionFactory;
    }

    @Bean
    public PlatformTransactionManager transactionManager() {
        // 配置事務管理, 使用事務時在方法頭部添加@Transactional注解即可
        return new DataSourceTransactionManager(dynamicDataSource());
    }
}

動態數據源類

我們上一步把這個動態數據源設置到了SQL會話工廠和事務管理器，這樣在操作數據庫時就會通過動態數據源類來獲取要操作的數據源了。

動態數據源類集成了Spring提供的AbstractRoutingDataSource類，AbstractRoutingDataSource 中獲取數據源的方法就是 determineTargetDataSource，而此方法又通過 determineCurrentLookupKey 方法獲取查詢數據源的key。

所以如果我們需要動態切換數據源，就可以通過以下兩種方式定制：

1. 覆寫 determineCurrentLookupKey 方法

通過覆寫 determineCurrentLookupKey 方法，從一個自定義的 DbSourceContext.getDbSource() 獲取數據源key值，這樣在我們想動態切換數據源的時候，只要通過  DbSourceContext.setDbSource(key)  的方式就可以動態改變數據源了。這種方式要求在獲取數據源之前，要先初始化各個數據源到 DbSourceContext 中，我們案例就是采用這種方式實現的，所以要將數據源都事先初始化到DynamicDataSource 中。

2. 可以通過覆寫 determineTargetDataSource，因為數據源就是在這個方法創建並返回的，所以這種方式就比較自由了，支持到任何你希望的地方讀取數據源信息，只要最終返回一個 DataSource 的實現類即可。比如你可以到數據庫、本地文件、網絡接口等方式讀取到數據源信息然后返回相應的數據源對象就可以了。

DynamicDataSource.java:

package com.main.example.common;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

public class DynamicDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DbSourceContext.getDbSource();
    }

}

數據源上下文

動態數據源的切換主要是通過調用這個類的方法來完成的。在任何想要進行切換數據源的時候都可以通過調用這個類的方法實現切換。比如系統登錄時，根據用戶信息調用這個類的數據源切換方法切換到用戶對應的數據庫。完整代碼如下:

DbSourceContext.java:

package com.main.example.common;

import org.apache.log4j.Logger;

public class DbSourceContext {
    private static Logger logger = Logger.getLogger(DbSourceContext.class);

    private static final ThreadLocal<String> dbContext = new ThreadLocal<String>();

    public static void setDbSource(String source) {
        logger.debug("set source ====>" + source);
        dbContext.set(source);
    }

    public static String getDbSource() {
        logger.debug("get source ====>" + dbContext.get());
        return dbContext.get();
    }

    public static void clearDbSource() {
        dbContext.remove();
    }
}

注解式數據源

到這里，在任何想要動態切換數據源的時候，只要調用DbSourceContext.setDbSource(key)  就可以完成了。

接下來我們實現通過注解的方式來進行數據源的切換，原理就是添加注解（如@DbSource(value="example")），然后實現注解切面進行數據源切換。

創建一個動態數據源注解，擁有一個value值，用於標識要切換的數據源的key。

DbSource.java:

package com.main.example.config.dao;

import java.lang.annotation.*;

/**
 * 動態數據源注解
 * @author
 * @date April 12, 2019
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DbSource {
    /**
     * 數據源key值
     * @return
     */
    String value();
}

創建一個AOP切面，攔截帶 @DataSource 注解的方法，在方法執行前切換至目標數據源，執行完成后恢復到默認數據源。

DynamicDataSourceAspect.java:

package com.main.example.config.dao;

import com.main.example.common.DbSourceContext;
import org.apache.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/**
 * 動態數據源切換處理器
 * @author linzhibao
 * @date April 12, 2019
 */
@Aspect
@Order(-1)  // 該切面應當先於 @Transactional 執行
@Component
public class DynamicDataSourceAspect {
    private static Logger logger = Logger.getLogger(DynamicDataSourceAspect.class);
    /**
     * 切換數據源
     * @param point
     * @param dbSource
     */
    //@Before("@annotation(dbSource)") 注解在對應方法，攔截有@DbSource的方法
    //注解在類對象，攔截有@DbSource類下所有的方法
    @Before("@within(dbSource)")
    public void switchDataSource(JoinPoint point, DbSource dbSource) {
            // 切換數據源
            DbSourceContext.setDbSource(dbSource.value());
    }

    /**
     * 重置數據源
     * @param point
     * @param dbSource
     */
    //注解在類對象，攔截有@DbSource類下所有的方法
    @After("@within(dbSource)")
    public void restoreDataSource(JoinPoint point, DbSource dbSource) {
        // 將數據源置為默認數據源
        DbSourceContext.clearDbSource();
    }
}

到這里，動態數據源相關的處理代碼就完成了。

編寫用戶業務代碼

接下來編寫用戶查詢業務代碼，用來進行測試，Dao層只需添加一個查詢接口即可。

ExampleDao.java:

package com.main.example.dao;

import com.main.example.common.DataEnum;
import com.main.example.config.dao.DbSource;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.List;

@Component("exampleDao")
//切換數據源注解，以DataEnum.DbSource中的值為准
@DbSource("example")
public class ExampleDao extends DaoBase {
    private static final String MAPPER_NAME_SPACE = "com.main.example.dao.ExampleMapper";

    public List<String> selectAllMessages() {
        return selectList(MAPPER_NAME_SPACE, "selectAllMessages");
    }
}

Controler代碼：

TestExampleDao.java:

package com.main.example.dao;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
public class TestExampleDao {
    @Autowired
    ExampleDao exampleDao;

    @RequestMapping(value = "/test/example")
    public List<String> selectAllMessages() {
        try {
            List<String> ldata = exampleDao.selectAllMessages();
            if(ldata == null){System.out.println("*********it is null.***********");return null;}
            for(String d : ldata) {
                System.out.println(d);
            }
            return ldata;
        }catch(Exception e) {
            e.printStackTrace();
        }

        return new ArrayList<>();
    }
}

ExampleMapper.xml代碼：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.main.example.dao.ExampleMapper">
    <select id="selectAllMessages" resultType="java.lang.String">
        SELECT
        message
        FROM example
    </select>

</mapper>

測試效果

啟動系統，訪問 http://localhost:80/test/example，分別測試兩個接口，成功返回數據。

可能遇到的問題

1.報錯：java.lang.IllegalArgumentException: jdbcUrl is required with driverClassName

原因：

spring boot從1.X升級到2.X版本之后，一些配置及用法有了變化，如果不小心就會碰到“jdbcUrl is required with driverClassName.”的錯誤

解決方法：

在1.0 配置數據源的過程中主要是寫成：spring.datasource.url 和spring.datasource.driverClassName。

而在2.0升級之后需要變更成：spring.datasource.jdbc-url和spring.datasource.driver-class-name即可解決！

 2.自定義配置文件

自定義配置文件需要在指定配置類上加上@PropertySource標簽，例如：

@PropertySource(value = "classpath:config/mysql/db.properties")

若是作用於配置類中的方法，則在方法上加上@ConfigurationProperties，例如：

@ConfigurationProperties(prefix = "spring.datasource.example")

配置項前綴為spring.datasource.example

若是作用於配置類上，則在類上加上@ConfigurationProperties（同上），並且在啟動類上加上@EnableConfigurationProperties(XXX.class)

3.多數據源

需要在啟動類上取消自動裝載數據源，如：

@SpringBootApplication(exclude = {
        DataSourceAutoConfiguration.class
})

 

附: 

如果想在數據層數據層直接使用mapper，只需要在對應的包下建立和*mapper.xml中namespace對應的類，然后在該類上加上@Mapper標注，或者在程序初始時使用@MapperScan掃描全mapper包

 

 

轉載請注明出處：https://www.cnblogs.com/fnlingnzb-learner/p/10710145.html