Loading [MathJax]/jax/output/CommonHTML/config.js
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >【SpringBoot DB系列】Mybatis多数据源配置与使用

【SpringBoot DB系列】Mybatis多数据源配置与使用

原创
作者头像
一灰灰blog
修改于 2021-01-18 06:28:37
修改于 2021-01-18 06:28:37
1.5K0
举报
文章被收录于专栏:小灰灰小灰灰

【SpringBoot DB 系列】Mybatis 多数据源配置与使用

上一篇博文介绍 JdbcTemplate 配置多数据源的使用姿势,在我们实际的项目开发中,使用 mybatis 来操作数据库的可能还是非常多的,本文简单的介绍一下 mybatis 中,多数据源的使用姿势

  • 通过区分包路径配合配置文件指定不同包下对应不同数据源的实现方式

<!-- more -->

I. 环境准备

1. 数据库相关

以 mysql 为例进行演示说明,因为需要多数据源,一个最简单的 case 就是一个物理库上多个逻辑库,本文是基于本机的 mysql 进行操作

创建数据库teststory,两个库下都存在一个表money (同名同结构表,但是数据不同哦)

代码语言:txt
AI代码解释
复制
CREATE TABLE `money` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT '' COMMENT '用户名',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '钱',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;

2. 项目环境

本项目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发

下面是核心的pom.xml(源码可以再文末获取)

代码语言:txt
AI代码解释
复制
<dependencies>
    <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>
    </dependency>
</dependencies>

配置文件信息application.yml

代码语言:txt
AI代码解释
复制
# 数据库相关配置
spring:
  datasource:
    story:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
      username: root
      password:
    test:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
      username: root
      password:


# 日志相关
logging:
  level:
    root: info
    org:
      springframework:
        jdbc:
          core: debug

请注意上面的数据库配置,我们前面介绍的但数据库配置如下,它们层级并不一样,上面的配置需要我们自己额外进行加载解析

代码语言:txt
AI代码解释
复制
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password:

II. 包路径指定

这种实现方式和前文中 JdbcTemplate 的多数据源配置方式很类似,将不同数据源的 Mapper 文件拆分在不同的包中,然后在配置 mybatis 数据源及资源文件加载时,分别进行指定

1. 项目结构

本项目中使用story + test两个数据库,我们将不同数据库的mapper.xml以及对应的实体相关类都分别放开,如下图

2. 具体实现

因为两个库中表结构完全一致,所以上图中的 Entity, Mapper, Repository以及xml文件基本都是一致的,下面代码只给出其中一份

数据库实体类StoryMoneyEntity

代码语言:txt
AI代码解释
复制
@Data
public class StoryMoneyEntity {
    private Integer id;

    private String name;

    private Long money;

    private Integer isDeleted;

    private Timestamp createAt;

    private Timestamp updateAt;
}

xml 对应的 Mapper 接口StoryMoneyMapper

代码语言:txt
AI代码解释
复制
@Mapper
public interface StoryMoneyMapper {
    List<StoryMoneyEntity> findByIds(List<Integer> ids);
}

mapper 对应的 xml 文件

代码语言:txt
AI代码解释
复制
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.git.hui.boot.multi.datasource.story.mapper.StoryMoneyMapper">

    <resultMap id="BaseResultMap" type="com.git.hui.boot.multi.datasource.story.entity.StoryMoneyEntity">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="money" property="money" jdbcType="INTEGER"/>
        <result column="is_deleted" property="isDeleted" jdbcType="TINYINT"/>
        <result column="create_at" property="createAt" jdbcType="TIMESTAMP"/>
        <result column="update_at" property="updateAt" jdbcType="TIMESTAMP"/>
    </resultMap>
    <sql id="money_po">
      id, `name`, money, is_deleted, create_at, update_at
    </sql>

    <select id="findByIds" parameterType="list" resultMap="BaseResultMap">
        select
        <include refid="money_po"/>
        from money where id in
        <foreach item="id" collection="list" separator="," open="(" close=")" index="">
            #{id}
        </foreach>
    </select>
</mapper>

数据库操作封装类StoryMoneyRepository

代码语言:txt
AI代码解释
复制
@Repository
public class StoryMoneyRepository {
    @Autowired
    private StoryMoneyMapper storyMoneyMapper;

    public void query() {
        List<StoryMoneyEntity> list = storyMoneyMapper.findByIds(Arrays.asList(1, 1000));
        System.out.println(list);
    }
}

接下来的重点看一下数据源以及 Mybatis 的相关配置StoryDatasourceConfig

代码语言:txt
AI代码解释
复制
// 请注意下面这个MapperScan,将数据源绑定在对应的包路径下
@Configuration
@MapperScan(basePackages = "com.git.hui.boot.multi.datasource.story.mapper", sqlSessionFactoryRef = "storySqlSessionFactory")
public class StoryDatasourceConfig {

    // 从配置文件中,获取数据库的相关配置
    @Primary
    @Bean(name = "storyDataSourceProperties")
    @ConfigurationProperties(prefix = "spring.datasource.story")
    public DataSourceProperties storyDataSourceProperties() {
        return new DataSourceProperties();
    }

    // DataSource的实例创建
    @Primary
    @Bean(name = "storyDataSource")
    public DataSource storyDataSource(@Qualifier("storyDataSourceProperties") DataSourceProperties storyDataSourceProperties) {
        return storyDataSourceProperties.initializeDataSourceBuilder().build();
    }

    // ibatis 对应的SqlSession工厂类
    @Primary
    @Bean("storySqlSessionFactory")
    public SqlSessionFactory storySqlSessionFactory(DataSource storyDataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(storyDataSource);
        bean.setMapperLocations(
                // 设置mybatis的xml所在位置
                new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/story/*.xml"));
        return bean.getObject();
    }

    @Primary
    @Bean("storySqlSessionTemplate")
    public SqlSessionTemplate storySqlSessionTemplate(SqlSessionFactory storySqlSessionFactory) {
        return new SqlSessionTemplate(storySqlSessionFactory);
    }
}

另外一个数据源的配置文件则如下

代码语言:txt
AI代码解释
复制
@Configuration
@MapperScan(basePackages = "com.git.hui.boot.multi.datasource.test.mapper", sqlSessionFactoryRef = "testSqlSessionFactory")
public class TestDatasourceConfig {

    @Bean(name = "testDataSourceProperties")
    @ConfigurationProperties(prefix = "spring.datasource.test")
    public DataSourceProperties testDataSourceProperties() {
        return new DataSourceProperties();
    }

    @Bean(name = "testDataSource")
    public DataSource testDataSource(@Qualifier("testDataSourceProperties") DataSourceProperties storyDataSourceProperties) {
        return storyDataSourceProperties.initializeDataSourceBuilder().build();
    }

    @Bean("testSqlSessionFactory")
    public SqlSessionFactory testSqlSessionFactory(@Qualifier("testDataSource") DataSource testDataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(testDataSource);
        bean.setMapperLocations(
                // 设置mybatis的xml所在位置
                new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/test/*.xml"));
        return bean.getObject();
    }

    @Bean("testSqlSessionTemplate")
    public SqlSessionTemplate testSqlSessionTemplate(@Qualifier("testSqlSessionFactory") SqlSessionFactory testSqlSessionFactory) {
        return new SqlSessionTemplate(testSqlSessionFactory);
    }
}

3. 测试

简单测试一下是否生效,直接在启动类中,调用

代码语言:txt
AI代码解释
复制
@SpringBootApplication
public class Application {

    public Application(StoryMoneyRepository storyMoneyRepository, TestMoneyRepository testMoneyRepository) {
        storyMoneyRepository.query();
        testMoneyRepository.query();
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }

}

输出如下

4. 小结

本文中介绍的多数据源方式,其实和但数据源的 mybatis 配置方式基本一致,顶多就是 SpringBoot 中,遵循默认的规范不需要我们显示的创建DataSource实例、SqlSessionFactory实例等

上面介绍的方式,实际上就是显示的声明 Mybatis 配置过程,多一个数据源,就多一个相关的配置,好处是理解容易,缺点是不灵活,如果我的 Mapper 类放错位置,可能就会出问题了

那么有其他的方式么,如果我希望将所有的 Mapper 放在一个包路径下,可以支持么?

下一篇博文,将介绍一种基于AbstractRoutingDataSource + 注解的方式来实现多数据源的支持

II. 其他

0. 项目

相关博文

源码

1. 一灰灰 Blog

尽信书则不如,以上内容,纯属一家之言,因个人能力有限,难免有疏漏和错误之处,如发现 bug 或者有更好的建议,欢迎批评指正,不吝感激

下面一灰灰的个人博客,记录所有学习和工作中的博文,欢迎大家前去逛逛

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
springboot之mybatis多数据源最简解决方案
说起多数据源,一般都来解决那些问题呢,主从模式或者业务比较复杂需要连接不同的分库来支持业务。
Vincent-yuan
2020/10/27
7700
【SpringBoot DB系列】Mybatis多数据源配置与使用
上一篇博文介绍 JdbcTemplate 配置多数据源的使用姿势,在我们实际的项目开发中,使用 mybatis 来操作数据库的可能还是非常多的,本文简单的介绍一下 mybatis 中,多数据源的使用姿势
一灰灰blog
2021/01/20
4150
【SpringBoot DB系列】Mybatis多数据源配置与使用
【SpringBoot DB 系列】Mybatis 基于 AbstractRoutingDataSource 与 AOP 实现多数据源切换
前面一篇博文介绍了 Mybatis 多数据源的配置,简单来讲就是一个数据源一个配置指定,不同数据源的 Mapper 分开指定;本文将介绍另外一种方式,借助AbstractRoutingDataSource来实现动态切换数据源,并通过自定义注解方式 + AOP 来实现数据源的指定
一灰灰blog
2021/01/20
1.1K0
【SpringBoot DB 系列】Mybatis 基于 AbstractRoutingDataSource 与 AOP 实现多数据源切换
【SpringBoot + Mybatis系列】Mapper接口注册的几种方式
SpringBoot项目中借助Mybatis来操作数据库,对大部分java技术栈的小伙伴来说,并不会陌生;我们知道,使用mybatis,一般会有下面几个
一灰灰blog
2021/07/29
7200
【SpringBoot + Mybatis系列】Mapper接口注册的几种方式
Spring配置多数据源实战
这里我们只演示同一个mysql下面的不同的两个库,主要采取分包的形式来区分不同的数据源:
Dream城堡
2022/01/07
5670
SpringBoot整合MyBatis多数据源
在平常的项目中,我们有连接数据库的需求。一般都是一个项目一个数据库,但也有例外需要连接多个数据库的。
半月无霜
2023/03/03
1.2K0
SpringBoot整合MyBatis多数据源
【SpringBoot DB 系列】Mybatis-Plus 多数据源配置
前面介绍了两种 Mybatis 的数据源配置,当然也少不了 mybatis-plus
一灰灰blog
2021/01/20
2K0
【SpringBoot DB 系列】Mybatis-Plus 多数据源配置
完整Demo:springboot实现多数据源配置
公司有一套人脸识别动态布控系统,该系统有两个子系统组成,识别算法采用C++编写,后台管理系统采用Java编写,C程序提供HTTP接口供Java程序调用,两个程序都是本地化部署。现在有个问题,C程序是南理工学生写的,需求响应不及时,接口不能立马提供,所以考虑由Java程序配置多数据源直接读C程序的数据库。
架构师小跟班
2019/08/07
1.8K0
完整Demo:springboot实现多数据源配置
【SpringBoot DB 系列】Mybatis基于AbstractRoutingDataSource与AOP实现多数据源切换
前面一篇博文介绍了 Mybatis 多数据源的配置,简单来讲就是一个数据源一个配置指定,不同数据源的 Mapper 分开指定;本文将介绍另外一种方式,借助AbstractRoutingDataSource来实现动态切换数据源,并通过自定义注解方式 + AOP 来实现数据源的指定
一灰灰blog
2021/01/17
1.1K0
【SpringBoot DB 系列】Mybatis基于AbstractRoutingDataSource与AOP实现多数据源切换
springboot(七):springboot+mybatis多数据源最简解决方案
说起多数据源,一般都来解决那些问题呢,主从模式或者业务比较复杂需要连接不同的分库来支持业务。我们项目是后者的模式,网上找了很多,大都是根据jpa来做多数据源解决方案,要不就是老的spring多数据源解决方案,还有的是利用aop动态切换,感觉有点小复杂,其实我只是想找一个简单的多数据支持而已,折腾了两个小时整理出来,供大家参考。 废话不多说直接上代码吧 配置文件 pom包就不贴了比较简单该依赖的就依赖,主要是数据库这边的配置: mybatis.config-locations=classpath:mybati
纯洁的微笑
2018/04/19
1.4K0
Spring Boot(七):Mybatis 多数据源最简解决方案
一个 test1 库和一个 test2 库,其中 test1 位主库,在使用的过程中必须指定主库,不然会报错。
纯洁的微笑
2019/05/17
3920
【SpringBoot Mybatis系列】MapperMapper接口与Sql绑定几种姿势
通常我们在使用Mybatis进行开发时,会选择xml文件来写对应的sql,然后将Mapper接口与sql的xml文件建立绑定关系,然后在项目中调用mapper接口就可以执行对应的sql
一灰灰blog
2022/11/28
1.1K0
【SpringBoot Mybatis系列】MapperMapper接口与Sql绑定几种姿势
SpringBoot之SpringBoot整合多数据源
本来按照视屏来说,到上一章的打包运行就没有了,但是我百度翻了好一大波,找到了他的上一期中的其他剩余视屏
彼岸舞
2021/02/02
7920
Springboot 之 Mybatis 多数据源实现
上篇讲解了 JPA 多数据源实现;这篇讲解一下 Mybatis 多数据源实现 。主要采用将不同数据库的 Mapper 接口分别存放到不同的 package,Spring 去扫描不同的包,注入不同的数据源来实现多数据源。原理跟 JPA 多数据源实现基本一致。
BUG弄潮儿
2022/12/05
1.6K0
Springboot 之 Mybatis 多数据源实现
springboot多数据源配置和使用
这个直接把多个数据库连接信息写上即可,用spring.datasource属性进行配置,如下:
用户7634691
2020/08/10
3.1K0
【SpringBoot + Mybatis系列】Mapper接口注册的几种方式
SpringBoot项目中借助Mybatis来操作数据库,对大部分java技术栈的小伙伴来说,并不会陌生;我们知道,使用mybatis,一般会有下面几个
一灰灰blog
2021/07/26
1.1K0
【SpringBoot + Mybatis系列】Mapper接口注册的几种方式
Spring Boot入门教程2-4、使用Spring Boot+MyBatis多数据源配置(xml配置版)
本项目构建基于:https://ken.io/note/springboot-course-basic-curd-xml
KenTalk
2018/09/11
1K0
SpringBoot配置多数据源实战
当相关业务场景想实现同时操作2个甚至多个不同数据库表的时候,就需要配置多个数据源。
刘大猫
2024/11/14
1270
Spring Boot 1.0 && 2.0 + Mybatis 多数据源配置与使用
mysql 对应的数据源配置中,定义了实体 Boy 和对应的数据层接口 BoyMapper:
happyJared
2018/12/19
1.2K0
SpringBoot 的多数据源配置
最近在项目开发中,需要为一个使用 MySQL 数据库的 SpringBoot 项目,新添加一个 PLSQL 数据库数据源,那么就需要进行 SpringBoot 的多数据源开发。代码很简单,下面是实现的过程。 环境准备
未读代码
2021/01/04
6.2K0
SpringBoot 的多数据源配置
推荐阅读
相关推荐
springboot之mybatis多数据源最简解决方案
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档