Spring Boot项目多数据源配置

Posted by 代码无止境 on 2019-06-23

在实际的项目开发过程中我们会经常遇到一个项目操作多个数据库的问题,也就是多数据源的问题。那么本篇文章将通过一个具体的例子来讲解如何在Spring Boot+Mybatis+Druid+MySQL项目中实现多数据源的配置。

准备

首先我们需要创建一个空的Spring Boot项目,您可以通过Spring Initializr页面生成一个空的Spring Boot项目,当然也可以下载springboot-pom.xml文件,然后使用Maven构建一个Spring Boot项目。项目创建完成后,为了方便后面代码的编写您可以将其导入到您喜欢的IDE中,我这里选择了Intelli IDEA打开。
一个可用的MySQL数据库。

数据库方面的准备工作

在本例中我们将会新建两个数据库(dbone和dbtwo),其中dbone中拥有一张city表,dbtwo中包含一张user表。
1.新建数据库

1
2
3
-- 创建数据库
CREATE DATABASE dbone;
CREATE DATABASE dbtwo;

2.dbone,建city表并插入一条数据

1
2
3
4
5
6
7
8
9
10
11
12
-- 在dbone中新建city表
USE dbone;
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;

INSERT city VALUES (1 ,1,'上海市','直辖市');

3.在dbtwo中新建user表

1
2
3
4
5
6
7
8
9
10
11
12
-- 初始化dbtwo的表
USE dbtwo;
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '用户编号',
`user_name` varchar(25) DEFAULT NULL COMMENT '用户名称',
`description` varchar(25) DEFAULT NULL COMMENT '描述',
`city_id` int(11) DEFAULT NULL COMMENT '城市id',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

INSERT user VALUES (1 ,'代码无止境', '个人主页:https://itweknow.cn', 1);

项目依赖

在准备阶段我们就已经生成了一个Spring Boot的一个基础的Web项目,前面也提到过我们的例子使用的技术栈是SpringBoot+MySQL+MyBatis+Druid,在SpringBoot的Web项目基础的依赖的基础上我们会增加mybatis、druid以及MySQL连接驱动这三个依赖,我们只需要在项目的pom.xml中添加如下内容即可。
pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!--mybatis-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>

<!--连接驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>

<!--druid-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.28</version>
</dependency>

多数据源的配置

1.在application.propertis中增加配置数据源所需要的信息

1
2
3
4
5
6
7
8
9
10
11
## dbone 数据源配置
dbone.druid.datasource.url=jdbc:mysql://localhost:3306/dbone?serverTimezone=GMT%2B8
dbone.druid.datasource.username=root
dbone.druid.datasource.password=123456
dbone.datasource.driverClassName=com.mysql.jdbc.Driver

## dbtwo 数据源配置
dbtwo.druid.datasource.url=jdbc:mysql://localhost:3306/dbtwo?serverTimezone=GMT%2B8
dbtwo.druid.datasource.username=root
dbtwo.druid.datasource.password=123456
dbtwo.datasource.driverClassName=com.mysql.jdbc.Driver

2.DruidDataSourceProperties
我们抽象了一个类来存储创建一个数据源所需要的属性,每个数据源都有一个自己Properties类继承自DruidDataSourceProperties,并利用@ConfigurationProperties注解来从配置文件中读取各个配置项的值。由于文章篇幅的原因这里就不贴代码了,需要的话可以在源码中找到(在cn.itweknow.springbootmultidatasource.config包下)。

3.主数据源dbone的配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@Configuration
@EnableConfigurationProperties({ DbOneDruidDataSourceProperties.class })
// 指定在哪些包下扫描Mapper
@MapperScan(value = { "cn.itweknow.springbootmultidatasource.dao.mapper.dbone" }, sqlSessionFactoryRef = "dbOneSqlSessionFactory")
@ConditionalOnProperty(name = "dbone.druid.datasource.url", matchIfMissing = false)
public class DbOneDruidDataSourceConfiguration {

/**
* 指定mapper.xml文件的地址
*/
static final String MAPPER_LOCATION = "classpath:sqlmap/dbone/*Mapper.xml";

@Autowired
private DbOneDruidDataSourceProperties dbOneDruidDataSourceProperties;

@Bean(name = "dbOneDruidDataSource", initMethod = "init", destroyMethod = "close")
@ConditionalOnMissingBean(name = "dbOneDruidDataSource")
@Primary
public DruidDataSource dbOneDruidDataSource() throws Exception {
DruidDataSource dataSource = new DruidDataSource();
dataSource.setDriverClassName(dbOneDruidDataSourceProperties.getDriverClassName());
dataSource.setUrl(dbOneDruidDataSourceProperties.getUrl());
dataSource.setUsername(dbOneDruidDataSourceProperties.getUsername());
dataSource.setPassword(dbOneDruidDataSourceProperties.getPassword());
return dataSource;
}

@Bean(name = "dbOneTransactionManager")
@ConditionalOnMissingBean(name = "dbOneTransactionManager")
@Primary
public DataSourceTransactionManager dbOneTransactionManager(@Qualifier("dbOneDruidDataSource") DruidDataSource druidDataSource) {
return new DataSourceTransactionManager(druidDataSource);
}

@Bean(name = "dbOneTransactionTemplate")
@ConditionalOnMissingBean(name = "dbOneTransactionTemplate")
@Primary
public TransactionTemplate dbOneTransactionTemplate(@Qualifier("dbOneTransactionManager") PlatformTransactionManager platformTransactionManager) {
return new TransactionTemplate(platformTransactionManager);
}

@Bean(name = "dbOneSqlSessionFactory")
@ConditionalOnMissingBean(name = "dbOneSqlSessionFactory")
@Primary
public SqlSessionFactory dbOneSqlSessionFactory(@Qualifier("dbOneDruidDataSource") DruidDataSource druidDataSource)
throws Exception {
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(druidDataSource);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
.getResources(MAPPER_LOCATION));
return sessionFactory.getObject();
}

}

4.从数据源的配置
从数据源dbtwo的配置同主数据源的配置大同小异,主要的区别是Mapper的扫描包、mapper.xml不同,以及从数据源的配置没有@Primary注解。

测试

测试代码的逻辑是从dbtwo中查询出一条用户数据,然后根据该用户的cityId字段去dbone中查询出对与的城市数据。最后将从两个库中查询出的数据组合起来返回给调用方。具体实现的代码可以参考本例源码,这里就只粘一下项目的结构,并稍作解释。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
├── multi-datasource.sql
├── pom.xml
├── README.md
├── springboot-multi-datasource.iml
└── src
└── main
├── java
│   └── cn
│   └── itweknow
│   └── springbootmultidatasource
│   ├── config // 数据源的配置
│   │   ├── DbOneDruidDataSourceConfiguration.java
│   │   ├── DbOneDruidDataSourceProperties.java
│   │   ├── DbTwoDruidDataSourceConfiguration.java
│   │   ├── DbTwoDruidDataSourceProperties.java
│   │   └── DruidDataSourceProperties.java
│   ├── controller // controller
│   │   └── UserController.java
│   ├── dao // 持久层,实体类
│   │   ├── City.java
│   │   ├── example // mybatis example
│   │   │   ├── dbone
│   │   │   │   └── CityExample.java
│   │   │   └── dbtwo
│   │   │   └── UserExample.java
│   │   ├── mapper // mybatis mapper接口
│   │   │   ├── dbone
│   │   │   │   └── CityMapper.java
│   │   │   └── dbtwo
│   │   │   └── UserMapper.java
│   │   └── User.java
│   ├── repository
│   │   ├── CityRepository.java
│   │   └── UserRepository.java
│   ├── service // 业务逻辑
│   │   ├── impl
│   │   │   └── UserServiceImpl.java
│   │   └── UserService.java
│   ├── SpringbootMultiDatasourceApplication.java
│   └── vo
│   └── User.java
└── resources
├── application.properties
└── sqlmap // mapper.xml
├── dbone
│   └── CityMapper.xml
└── dbtwo
└── UserMapper.xml

想要源码吗?戳这里!启动整个项目之后,访问测试的接口,如果你看到如下的结果就说明多数据源配置成功了。
多数据源配置测试结果图

ps:“学习不止,码不停蹄”,如果你喜欢我的文章,就关注我吧。

扫码关注“代码无止境”