1. 程式人生 > >Spring Boot 整合 Mybatis 實現 Druid 多資料來源詳解

Spring Boot 整合 Mybatis 實現 Druid 多資料來源詳解

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

本文提綱
一、多資料來源的應用場景
二、執行 springboot-mybatis-mutil-datasource 工程案例
三、springboot-mybatis-mutil-datasource 工程程式碼配置詳解

一、多資料來源的應用場景

目前,業界流行的資料操作框架是 Mybatis,那 Druid 是什麼呢?
Druid 是 Java 的資料庫連線池元件。Druid 能夠提供強大的監控和擴充套件功能。比如可以監控 SQL ,在監控業務可以查詢慢查詢 SQL 列表等。Druid 核心主要包括三部分:
1. DruidDriver 代理 Driver,能夠提供基於 Filter-Chain 模式的外掛體系。
2. DruidDataSource 高效可管理的資料庫連線池
3. SQLParser

當業務資料量達到了一定程度,DBA 需要合理配置資料庫資源。即配置主庫的機器高配置,把核心高頻的資料放在主庫上;把次要的資料放在從庫,低配置。開源節流嘛,就這個意思。把資料放在不同的資料庫裡,就需要通過不同的資料來源進行操作資料。這裡我們舉個 springboot-mybatis-mutil-datasource 工程案例:
user 使用者表在主庫 master 上,地址表 city 在從庫 cluster 上。下面實現獲取 根據使用者名稱獲取使用者資訊,包括從庫的地址資訊 REST API,那麼需要從主庫和從庫中分別獲取資料,並在業務邏輯層組裝返回。邏輯如圖:WX20170324-144757

下面就執行這個案例。

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

git clone 下載工程 springboot-learning-example ,專案地址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example。下面開始執行工程步驟(Quick Start):
1.資料庫準備
a.建立 cluster 資料庫 springbootdb:

CREATE DATABASE springbootdb;

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,'溫嶺市','BYSocket 的家在溫嶺。');

然後,再建立一個 master 資料庫
a.建立資料庫 springbootdb_cluster:

CREATE DATABASE springbootdb_cluster;

b.建立表 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.插入資料

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

(以上資料庫建立無先後順序)

2. 專案結構介紹
專案結構如下圖所示:
org.spring.springboot.config.ds – 配置層,這裡是資料來源的配置,包括 master 和 cluster 的資料來源配置
org.spring.springboot.controller – Controller 層
org.spring.springboot.dao – 資料操作層 DAO,細分了 master 和 cluster 包下的 DAO 操作類
org.spring.springboot.domain – 實體類
org.spring.springboot.service – 業務邏輯層
Application – 應用啟動類
application.properties – 應用配置檔案,應用啟動會自動讀取配置

3.改資料庫配置
開啟 application.properties 檔案, 修改相應的主從資料來源配置,比如資料來源地址、賬號、密碼等。(如果不是用 MySQL,自行新增連線驅動 pom,然後修改驅動名配置。)

4.編譯工程
在專案根目錄 springboot-learning-example,執行 maven 指令:

mvn clean install

5.執行工程
右鍵執行 Application 應用啟動類(位置:/springboot-learning-example/springboot-mybatis-mutil-datasource/src/main/java/org/spring/springboot/Application.java)的 main 函式,這樣就成功啟動了 springboot-mybatis-mutil-datasource 案例。

在瀏覽器開啟:
http://localhost:8080/api/user?userName=泥瓦匠
瀏覽器返回 JSON 結果:

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

這裡 city 結果體來自 cluster 庫,user 結果體來自 master 庫。

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

首先程式碼工程結構如下:
org.spring.springboot.config.ds 包包含了多資料來源的配置,同樣有第三個資料來源,按照前幾個複製即可
resources/mapper 下面有兩個模組,分別是 Mybatis 不同資料來源需要掃描的 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 是資料庫連線池依賴

<?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 配置:

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

    // 精確到 master 目錄,以便跟其他資料來源隔離
    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 標誌這個 Bean 如果在多個同類 Bean 候選時,該 Bean 優先被考慮。「多資料來源配置的時候注意,必須要有一個主資料來源,用 @Primary 標誌該 Bean」
@MapperScan 掃描 Mapper 介面並容器管理,包路徑精確到 master,為了和下面 cluster 資料來源做到精確區分
@Value 獲取全域性配置檔案 application.properties 的 kv 配置,並自動裝配
sqlSessionFactoryRef 表示定義了 key ,表示一個唯一 SqlSessionFactory 例項

同理可得,從資料來源 ClusterDataSourceConfig 配置如下:

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

    // 精確到 cluster 目錄,以便跟其他資料來源隔離
    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();
    }
}

上面資料配置分別掃描 Mapper 介面,org.spring.springboot.dao.master(對應 xml classpath:mapper/master ) 和 org.spring.springboot.dao.cluster(對應 xml classpath:mapper/cluster ) 包中對應的 UserDAO 和 CityDAO 。
都有 @Mapper 標誌為 Mybatis 的並通過容器管理的 Bean。Mybatis 內部會使用反射機制執行去解析相應 SQL。

3.業務層 biz
biz 照常注入了兩個 DAO,如同以前一樣正常工作。不用關心和指定到具體說明資料來源。

/**
 * 使用者業務實現層
 *
 * Created by bysocket on 07/02/2017.
 */
@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao; // 主資料來源

    @Autowired
    private CityDao cityDao; // 從資料來源

    @Override
    public User findByName(String userName) {
        User user = userDao.findByName(userName);
        City city = cityDao.findByName("溫嶺市");
        user.setCity(city);
        return user;
    }
}

四、小結

多資料來源適合的場景很多。不同的 DataSource ,不同的 SqlSessionFactory 和 不同的 DAO 層,在業務邏輯層做 整合。總結的架構圖如下:

WX20170324-144830

同樣,如果實戰中,大家遇到什麼,或者建議《Spring boot 那些事》還需要一起交流的。請點選留言。

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

歡迎掃一掃我的公眾號關注 — 及時得到部落格訂閱哦!
— http://www.bysocket.com/ —
— https://github.com/JeffLi1993 —