详解Spring Boot整合Mybatis实现 Druid多数据源配置

一、多数据源的应用场景

目前，业界流行的数据操作框架是 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，那么需要从主库和从库中分别获取数据，并在业务逻辑层组装返回。逻辑如图：

 

下面就运行这个案例。

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

工程项目地址: 。下面开始运行工程步骤：

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. 项目结构介绍

项目结构如下图所示：

1. org.spring.springboot.config.ds – 配置层，这里是数据源的配置，包括 master 和 cluster 的数据源配置
2. org.spring.springboot.controller – controller 层
3. org.spring.springboot.dao – 数据操作层 dao，细分了 master 和 cluster 包下的 dao 操作类
4. org.spring.springboot.domain – 实体类
5. org.spring.springboot.service – 业务逻辑层
6. application – 应用启动类
7. 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 层，在业务逻辑层做 整合。总结的架构图如下：

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。