springboot 配置多数据源实战案例

作者: 小山居 | 来源:发表于2019-11-27 23:52 被阅读0次

摘要: 代码地址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 目录

依赖 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>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.1.RELEASE</version>
</parent>

 <!-- 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>

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

数据源配置
多数据源配置的时候注意，必须要有一个主数据源，即 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
代码地址https://github.com/java-open/springboot-integration 「公众号：天山云海」欢迎关注和转载，珍惜每一次偶遇

springboot 配置多数据源实战案例

master 数据源配置

cluster 数据源配置

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

IT书籍阅读