springboot 配置多數據源實戰案例

摘要: 代碼地址https://github.com/java-open/springboot-integration 「公眾號：天山雲海」歡迎關注和轉載，珍惜每一次偶遇，謝謝！

一.前言:

工作中會遇到這樣的業務情況,我們會把數據放在不同的數據庫里，一個業務中需要連接不同的數據源進行操作數據。這個時候springboot需要配置多數據源.

通過如下案例展示如何: user 用戶表在主庫 master 上，地址表 city 在從庫 cluster 上。下面實現獲取 根據用戶名獲取用戶信息，包括從庫的地址信息 REST API，那么需要從主庫和從庫中分別獲取數據，並在業務邏輯層組裝返回。

二、准備數據庫

1.數據庫准備 a.創建 cluster 數據庫 springbootdb_cluster： CREATE DATABASE springbootdb_custer;

b.創建表 city ：

DROP TABLE IF EXISTS `city`;
CREATE TABLE `city` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '城市編號',
`province_id` int(10) unsigned NOT NULL COMMENT '省份編號',
`city_name` varchar(25) DEFAULT NULL COMMENT '城市名稱',
`description` varchar(25) DEFAULT NULL COMMENT '描述',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

c.插入數據 INSERT city VALUES (1 ,1,'上海市','魔都是個神奇而又冰冷的城市。');

1.2再創建一個 master 數據庫

a.創建數據庫 springbootdb_master： CREATE DATABASE springbootdb_cluster;

b.創建表 user ：

DROP TABLE IF EXISTS `user`;
CREATE TABLE user
(
id INT(10) unsigned PRIMARY KEY NOT NULL COMMENT '用戶編號' AUTO_INCREMENT,
user_name VARCHAR(25) COMMENT '用戶名稱',
description VARCHAR(25) COMMENT '描述'
)ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

c.插入數據 INSERT user VALUES (1 ,'張天師','一人之下!');

1.3.更改項目中數據庫配置 打開 application.properties 文件， 修改相應的主從數據源配置，比如數據源地址、賬號、密碼等。（如果不是用 MySQL，自行添加連接驅動 pom，然后修改驅動名配置。）

三、springboot-mybatis-mutil-datasource 工程案例

首先代碼工程結構如下：

resources/mapper 下面有兩個模塊，分別是 Mybatis 不同數據源需要掃描的 mapper xml 目錄

1. 依賴 pom.xml Mybatis 通過 Spring Boot Mybatis Starter 依賴 Druid 是數據庫連接池依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>springboot</groupId>
    <artifactId>springboot-mybatis-mutil-datasource</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-mybatis-mutil-datasource :: Spring Boot 實現 Mybatis 多數據源配置</name>

    <!-- Spring Boot 啟動父依賴 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.1.RELEASE</version>
    </parent>

    <properties>
        <mybatis-spring-boot>1.2.0</mybatis-spring-boot>
        <mysql-connector>5.1.39</mysql-connector>
        <druid>1.0.18</druid>
    </properties>

    <dependencies>

        <!-- Spring Boot Web 依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Spring Boot Test 依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- Spring Boot Mybatis 依賴 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis-spring-boot}</version>
        </dependency>

        <!-- MySQL 連接驅動依賴 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql-connector}</version>
        </dependency>

        <!-- Druid 數據連接池依賴 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${druid}</version>
        </dependency>

        <!-- Junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>
</project>

2. application.properties 配置兩個數據源配置 數據源配置會被數據源數據源配置如下

## master 數據源配置
master.datasource.url=jdbc:mysql://localhost:3306/springbootdb?useUnicode=true&characterEncoding=utf8
master.datasource.username=root
master.datasource.password=123456
master.datasource.driverClassName=com.mysql.jdbc.Driver

## cluster 數據源配置
cluster.datasource.url=jdbc:mysql://localhost:3306/springbootdb_cluster?useUnicode=true&characterEncoding=utf8
cluster.datasource.username=root
cluster.datasource.password=123456
cluster.datasource.driverClassName=com.mysql.jdbc.Driver

3. 數據源配置 多數據源配置的時候注意，必須要有一個主數據源，即 MasterDataSourceConfig 配置：

@Primary 標志這個 Bean 如果在多個同類 Bean 候選時，該 Bean 優先被考慮。「多數據源配置的時候注意，必須要有一個主數據源，用 @Primary 標志該 Bean」 @MapperScan 掃描 Mapper 接口並容器管理，包路徑精確到 master，為了和下面 cluster 數據源做到精確區分 @Value 獲取全局配置文件 application.properties 的 kv 配置,並自動裝配 sqlSessionFactoryRef 表示定義了 key ，表示一個唯一 SqlSessionFactory 實例

@Configuration
// 掃描 Mapper 接口並容器管理
@MapperScan(basePackages = MasterDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "masterSqlSessionFactory")
public class MasterDataSourceConfig {

    // 精確到 master 目錄，以便跟其他數據源隔離
    static final String PACKAGE = "com.spring.springboot.dao.master";
    static final String MAPPER_LOCATION = "classpath:mapper/master/*.xml";

    @Value("${master.datasource.url}")
    private String url;

    @Value("${master.datasource.username}")
    private String user;

    @Value("${master.datasource.password}")
    private String password;

    @Value("${master.datasource.driverClassName}")
    private String driverClass;

    @Bean(name = "masterDataSource")
    @Primary
    public DataSource masterDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClass);
        dataSource.setUrl(url);
        dataSource.setUsername(user);
        dataSource.setPassword(password);
        return dataSource;
    }

    @Bean(name = "masterTransactionManager")
    @Primary
    public DataSourceTransactionManager masterTransactionManager() {
        return new DataSourceTransactionManager(masterDataSource());
    }

    @Bean(name = "masterSqlSessionFactory")
    @Primary
    public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource)
            throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(masterDataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
                .getResources(MasterDataSourceConfig.MAPPER_LOCATION));
        return sessionFactory.getObject();
    }
}

同理可得，從數據源 ClusterDataSourceConfig 配置如下：

@Configuration
// 掃描 Mapper 接口並容器管理
@MapperScan(basePackages = ClusterDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "clusterSqlSessionFactory")
public class ClusterDataSourceConfig {

    // 精確到 cluster 目錄，以便跟其他數據源隔離
    static final String PACKAGE = "com.spring.springboot.dao.cluster";
    static final String MAPPER_LOCATION = "classpath:mapper/cluster/*.xml";

    @Value("${cluster.datasource.url}")
    private String url;

    @Value("${cluster.datasource.username}")
    private String user;

    @Value("${cluster.datasource.password}")
    private String password;

    @Value("${cluster.datasource.driverClassName}")
    private String driverClass;

    @Bean(name = "clusterDataSource")
    public DataSource clusterDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClass);
        dataSource.setUrl(url);
        dataSource.setUsername(user);
        dataSource.setPassword(password);
        return dataSource;
    }

    @Bean(name = "clusterTransactionManager")
    public DataSourceTransactionManager clusterTransactionManager() {
        return new DataSourceTransactionManager(clusterDataSource());
    }

    @Bean(name = "clusterSqlSessionFactory")
    public SqlSessionFactory clusterSqlSessionFactory(@Qualifier("clusterDataSource") DataSource clusterDataSource)
            throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(clusterDataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
                .getResources(ClusterDataSourceConfig.MAPPER_LOCATION));
        return sessionFactory.getObject();
    }
}

上面數據配置分別掃描 Mapper 接口，分別對應 包中的 UserDAO 和 CityDAO 。 都有 @Mapper 標志為 Mybatis 的並通過容器管理的 Bean。Mybatis 內部會使用反射機制運行去解析相應 SQL。

4.根據表生成實體類,dao,mapper等

5.業務層代碼: 編寫controller層代碼,根據傳入的name值,然后查詢主從兩個數據內容 UserController層

/**
 *控制層
 */
@RestController
public class UserController {
    @Autowired
    private UserService userService;
    /**
     * 通過用戶名獲取用戶信息,以及從庫的地址信息
     */
    @RequestMapping(value = "/user",method = RequestMethod.GET)
    public User findUserByName(@RequestParam(value = "name",required = true) String name){
        return  userService.findByName(name);

    }
}

Service層 照常注入主從兩個Dao層

@Service
public class UserService {


    @Autowired
    private UserDao userDao; // 主數據源

    @Autowired
    private CityDao cityDao; // 從數據源


    public User findByName(String userName) {
        User user = userDao.findByName(userName);
        City city = cityDao.findByName("上海市");
        System.out.println(city);
        user.setDescription("從數據庫->"+city.getDescription());
        user.setCity(city);
        return user;
    }
}

6.訪問接口路徑,測試結果包含兩個數據庫內容

右鍵運行Application 啟動類,然后再瀏覽器輸入接口路徑測試結果

四、總結 多數據源適合的場景很多。不同的 DataSource ，不同的 SqlSessionFactory 和 不同的 DAO 層，在業務邏輯層做 整合。 需要參考完整代碼的請參考: github地址:https://github.com/java-open/springboot-integration

參考鏈接: https://mp.weixin.qq.com/s/sxvWSfBbWbiI91B6rQb66A https://www.bysocket.com/technique/1712.html