Spring Boot 整合 Mybatis 實現(xiàn) Druid 多數(shù)據(jù)源詳解 | 泥瓦匠BYSocket

摘要: 原創(chuàng)出處:www.bysocket.com 泥瓦匠BYSocket 希望轉(zhuǎn)載，保留摘要，謝謝！

“清醒時做事，糊涂時跑步，大怒時睡覺，獨處時思考”

本文提綱
一、多數(shù)據(jù)源的應(yīng)用場景
二、運行 springboot-mybatis-mutil-datasource 工程案例
三、springboot-mybatis-mutil-datasource 工程代碼配置詳解

一、多數(shù)據(jù)源的應(yīng)用場景

目前，業(yè)界流行的數(shù)據(jù)操作框架是 Mybatis，那 Druid 是什么呢？
Druid 是 Java 的數(shù)據(jù)庫連接池組件。Druid 能夠提供強(qiáng)大的監(jiān)控和擴(kuò)展功能。比如可以監(jiān)控 SQL ，在監(jiān)控業(yè)務(wù)可以查詢慢查詢 SQL 列表等。Druid 核心主要包括三部分：
1. DruidDriver 代理 Driver，能夠提供基于 Filter－Chain 模式的插件體系。
2. DruidDataSource 高效可管理的數(shù)據(jù)庫連接池
3. SQLParser

當(dāng)業(yè)務(wù)數(shù)據(jù)量達(dá)到了一定程度，DBA 需要合理配置數(shù)據(jù)庫資源。即配置主庫的機(jī)器高配置，把核心高頻的數(shù)據(jù)放在主庫上；把次要的數(shù)據(jù)放在從庫，低配置。開源節(jié)流嘛，就這個意思。把數(shù)據(jù)放在不同的數(shù)據(jù)庫里，就需要通過不同的數(shù)據(jù)源進(jìn)行操作數(shù)據(jù)。這里我們舉個 springboot-mybatis-mutil-datasource 工程案例：
user 用戶表在主庫 master 上，地址表 city 在從庫 cluster 上。下面實現(xiàn)獲取 根據(jù)用戶名獲取用戶信息，包括從庫的地址信息 REST API，那么需要從主庫和從庫中分別獲取數(shù)據(jù)，并在業(yè)務(wù)邏輯層組裝返回。邏輯如圖：

下面就運行這個案例。

二、運行 springboot-mybatis-mutil-datasource 工程案例

git clone 下載工程 springboot-learning-example ，項目地址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example。下面開始運行工程步驟（Quick Start）：
1.數(shù)據(jù)庫準(zhǔn)備
a.創(chuàng)建 cluster 數(shù)據(jù)庫 springbootdb：

CREATE DATABASE springbootdb;

b.創(chuàng)建表 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.插入數(shù)據(jù)

INSERT city VALUES (1 ,1,'溫嶺市','BYSocket 的家在溫嶺。');

然后，再創(chuàng)建一個 master 數(shù)據(jù)庫
a.創(chuàng)建數(shù)據(jù)庫 springbootdb_cluster：

CREATE DATABASE springbootdb_cluster;

b.創(chuàng)建表 user ：

DROP TABLE IF EXISTS `city`;
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.插入數(shù)據(jù)

INSERT user VALUES (1 ,'泥瓦匠','他有一個小網(wǎng)站 bysocket.com');

（以上數(shù)據(jù)庫創(chuàng)建無先后順序）

2. 項目結(jié)構(gòu)介紹
項目結(jié)構(gòu)如下圖所示：
org.spring.springboot.config.ds – 配置層，這里是數(shù)據(jù)源的配置，包括 master 和 cluster 的數(shù)據(jù)源配置
org.spring.springboot.controller – Controller 層
org.spring.springboot.dao – 數(shù)據(jù)操作層 DAO，細(xì)分了 master 和 cluster 包下的 DAO 操作類
org.spring.springboot.domain – 實體類
org.spring.springboot.service – 業(yè)務(wù)邏輯層
Application – 應(yīng)用啟動類
application.properties – 應(yīng)用配置文件，應(yīng)用啟動會自動讀取配置

3.改數(shù)據(jù)庫配置
打開 application.properties 文件， 修改相應(yīng)的主從數(shù)據(jù)源配置，比如數(shù)據(jù)源地址、賬號、密碼等。（如果不是用 MySQL，自行添加連接驅(qū)動 pom，然后修改驅(qū)動名配置。）

4.編譯工程
在項目根目錄 springboot-learning-example，運行 maven 指令：

mvn cleaninstall

5.運行工程
右鍵運行 Application 應(yīng)用啟動類（位置：/springboot-learning-example/springboot-mybatis-mutil-datasource/src/main/java/org/spring/springboot/Application.java）的 main 函數(shù)，這樣就成功啟動了 springboot-mybatis-mutil-datasource 案例。

在瀏覽器打開：
http://localhost:8080/api/user?userName=泥瓦匠
瀏覽器返回 JSON 結(jié)果：

{
    "id": 1,
    "userName":"泥瓦匠",
    "description":"他有一個小網(wǎng)站 bysocket.com",
    "city": {
        "id": 1,
        "provinceId": 1,
        "cityName":"溫嶺市",
        "description":"BYSocket 的家在溫嶺。"
    }
}

這里 city 結(jié)果體來自 cluster 庫，user 結(jié)果體來自 master 庫。

三、springboot-mybatis-mutil-datasource 工程代碼配置詳解

代碼共享在我的 GitHub 上：
https://github.com/JeffLi1993/springboot-learning-example/tree/master/springboot-mybatis-mutil-datasource

首先代碼工程結(jié)構(gòu)如下：
org.spring.springboot.config.ds 包包含了多數(shù)據(jù)源的配置，同樣有第三個數(shù)據(jù)源，按照前幾個復(fù)制即可
resources/mapper 下面有兩個模塊，分別是 Mybatis 不同數(shù)據(jù)源需要掃描的 mapper xml 目錄

├── pom.xml
└── src
    └── main
        ├── java
        │   └── org
        │       └── spring
        │           └── springboot
        │               ├── Application.java
        │               ├── config
        │               │   └── ds
        │               │       ├── ClusterDataSourceConfig.java
        │               │       └── MasterDataSourceConfig.java
        │               ├── controller
        │               │   └── UserRestController.java
        │               ├── dao
        │               │   ├── cluster
        │               │   │   └── CityDao.java
        │               │   └── master
        │               │       └── UserDao.java
        │               ├── domain
        │               │   ├── City.java
        │               │   └── User.java
        │               └── service
        │                   ├── UserService.java
        │                   └── impl
        │                       └── UserServiceImpl.java
        └── resources
            ├── application.properties
            └── mapper
                ├── cluster
                │   └── CityMapper.xml
                └── master
                    └── UserMapper.xml

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

<?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 實現(xiàn) Mybatis 多數(shù)據(jù)源配置</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 連接驅(qū)動依賴 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql-connector}</version>
        </dependency>
        <!-- Druid 數(shù)據(jù)連接池依賴 -->
        <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 配置兩個數(shù)據(jù)源配置
數(shù)據(jù)源配置會被數(shù)據(jù)源數(shù)據(jù)源配置如下

## master 數(shù)據(jù)源配置
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 數(shù)據(jù)源配置
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. 數(shù)據(jù)源配置
多數(shù)據(jù)源配置的時候注意，必須要有一個主數(shù)據(jù)源，即 MasterDataSourceConfig 配置：

@Configuration
// 掃描 Mapper 接口并容器管理
@MapperScan(basePackages = MasterDataSourceConfig.PACKAGE, sqlSessionFactoryRef ="masterSqlSessionFactory")
public class MasterDataSourceConfig {
    // 精確到 master 目錄，以便跟其他數(shù)據(jù)源隔離
    static final String PACKAGE ="org.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();
    }
}

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

同理可得，從數(shù)據(jù)源 ClusterDataSourceConfig 配置如下：

@Configuration
// 掃描 Mapper 接口并容器管理
@MapperScan(basePackages = ClusterDataSourceConfig.PACKAGE, sqlSessionFactoryRef ="clusterSqlSessionFactory")
public class ClusterDataSourceConfig {
    // 精確到 cluster 目錄，以便跟其他數(shù)據(jù)源隔離
    static final String PACKAGE ="org.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();
    }
}

上面數(shù)據(jù)配置分別掃描 Mapper 接口，org.spring.springboot.dao.master（對應(yīng) xml classpath:mapper/master ） 和 org.spring.springboot.dao.cluster（對應(yīng) xml classpath:mapper/cluster ） 包中對應(yīng)的 UserDAO 和 CityDAO 。
都有 @Mapper 標(biāo)志為 Mybatis 的并通過容器管理的 Bean。Mybatis 內(nèi)部會使用反射機(jī)制運行去解析相應(yīng) SQL。

3.業(yè)務(wù)層 biz
biz 照常注入了兩個 DAO，如同以前一樣正常工作。不用關(guān)心和指定到具體說明數(shù)據(jù)源。

/**
 * 用戶業(yè)務(wù)實現(xiàn)層
 *
 * Created by bysocket on 07/02/2017.
 */
@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserDao userDao;// 主數(shù)據(jù)源
    @Autowired
    private CityDao cityDao;// 從數(shù)據(jù)源
    @Override
    public User findByName(String userName) {
        User user = userDao.findByName(userName);
        City city = cityDao.findByName("溫嶺市");
        user.setCity(city);
        return user;
    }
}

四、小結(jié)

多數(shù)據(jù)源適合的場景很多。不同的 DataSource ，不同的 SqlSessionFactory 和 不同的 DAO 層，在業(yè)務(wù)邏輯層做 整合?？偨Y(jié)的架構(gòu)圖如下：

同樣，如果實戰(zhàn)中，大家遇到什么，或者建議《Spring boot 那些事》還需要一起交流的。請點擊留言。

推薦書《奧黛麗·赫本》一本講女神的故事。

歡迎掃一掃我的公眾號關(guān)注 — 及時得到博客訂閱哦！
— http://www.bysocket.com/ —
— https://github.com/JeffLi1993 —