Mybatis Plus配置多数据源

概述

该项目重要描述了Mybatis Plus多数据源的配置和使用，此中详细记录的配置过程，整个过程从数据库表的创建到数据初始化都有详细的记录说明。
别的，如果存在同一个表在多个数据源中都存在的情况，有一些注意事项，下面看文章通过例子说明。
详细步骤

by-mybatis-plus项目一

不同的表在不同的数据源中，不存在同一个表在多个数据源的情况。
数据库脚本

• 在数据库1：database1中新建数据库表，并插入初始化数据
  

1. CREATE DATABASE `datasource1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
2. use `datasource1`;
4. CREATE TABLE `user_info` (
5.     `id` bigint NOT NULL AUTO_INCREMENT COMMENT 'ID',
6.     `user_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户名',
7.     `user_sex` TINYINT(2) NOT NULL COMMENT '用户性别（0 女性 1男性 2其他）',
8.     `user_age` INT NOT NULL COMMENT '用户年龄',
9.     `user_address` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '用户地址',
10.     `ctime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建日期',
11.     `mtime` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
12.     PRIMARY KEY (`id`)
13. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci COMMENT='用户信息表';
15. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('张三', 1, 18, '北京');
16. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('张颜', 0, 18, '乌鲁木齐');
17. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('李四', 1, 12, '上海');
18. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('王五', 1, 18, '北京');
19. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('王武', 1, 23, '北京');
20. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('王媛', 0, 43, '成都');
21. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('李康', 1, 36, '广州');
22. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('王梅', 0, 16, '合肥');
23. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('李雪华', 0, 23, '东京');
24. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('张熏然', 0, 19, '纽约');
25. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('何莉莉', 0, 32, '深圳');
26. INSERT INTO `datasource1`.`user_info` (`user_name`, `user_sex`, `user_age`, `user_address`) VALUES ('李茉', 0, 23, '东莞');

复制代码

• 在数据库2：database2中新建数据库表，并插入初始化数据
  

1. CREATE DATABASE `datasource2` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
2. use `datasource2`;
4. CREATE TABLE `user_login_log` (
5.     `id` bigint NOT NULL AUTO_INCREMENT COMMENT 'ID',
6.     `user_id` bigint NOT NULL COMMENT '登录用户id',
7.     `user_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户名',
8.     `activity_type` varchar(255) NOT NULL COMMENT '活动时间：in登入，out登出',
9.     `activity_trigger_time` timestamp NOT NULL COMMENT '不懂触发时间（登录或者登出时间）',
10.     `ctime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建日期',
11.     `mtime` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
12.     PRIMARY KEY (`id`)
13. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci COMMENT='用户登录信息记录表';
15. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'in', '2024-08-06 16:38:43');
16. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'out', '2024-08-06 16:39:43');
17. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'in', '2024-08-06 16:48:43');
18. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'out', '2024-08-06 16:59:43');
19. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'in', '2024-08-06 16:38:43');
20. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'out', '2024-08-06 16:39:43');
21. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'in', '2024-08-06 16:48:43');
22. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'out', '2024-08-06 16:59:43');
23. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'in', '2024-08-06 16:38:43');
24. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'out', '2024-08-06 16:39:43');
25. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'in', '2024-08-06 16:48:43');
26. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'out', '2024-08-06 16:59:43');
27. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'in', '2024-08-06 17:38:43');
28. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'out', '2024-08-06 17:39:43');
29. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'in', '2024-08-06 18:48:43');
30. INSERT INTO `datasource2`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (3, '王五', 'out', '2024-08-06 18:59:43');

复制代码

添加maven依靠

1. <dependencies>
2.     <dependency>
3.         <groupId>com.baomidou</groupId>
4.         <artifactId>mybatis-plus-boot-starter</artifactId>
5.         <version>3.5.1</version>
6.     </dependency>
7.    
8.     <dependency>
9.         <groupId>com.baomidou</groupId>
10.         <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
11.         <version>3.5.1</version>
12.     </dependency>
13. </dependencies>

复制代码

编写配置文件

1. spring:
2.   datasource:
3.     dynamic:
4.       primary: datasource1 #设置默认的数据源或者数据源组,默认值即为datasource1
5.       strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
6.       datasource:
7.         datasource1:
8.           url: jdbc:mysql://127.0.0.1:33060/datasource1?characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&autoReconnect=true&rewriteBatchedStatements=true&allowMultiQueries=true&useSSL=false
9.           username: root
10.           password: root
11.           driver-class-name: com.mysql.cj.jdbc.Driver
12.         datasource2:
13.           url: jdbc:mysql://127.0.0.1:33060/datasource2?characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&autoReconnect=true&rewriteBatchedStatements=true&allowMultiQueries=true&useSSL=false
14.           username: root
15.           password: root
16.           driver-class-name: com.mysql.cj.jdbc.Driver

复制代码

在 service类 和 mapper类 上添加数据源注解

• 数据源1：datasource1
  

1. @Mapper
2. @DS("datasource1")
3. public interface UserInfoMapper extends BaseMapper<UserInfo> {
5. }

复制代码

1. @Service
2. @DS("datasource1")
3. public class UserInfoServiceImpl extends ServiceImpl<UserInfoMapper, UserInfo> implements UserInfoService {
5. }

复制代码

• 数据源2：datasource2
  

1. @Mapper
2. @DS("datasource2")
3. public interface UserLoginLogMapper extends BaseMapper<UserLoginLog> {
5. }

复制代码

1. @Service
2. @DS("datasource2")
3. public class UserLoginLogServiceImpl extends ServiceImpl<UserLoginLogMapper, UserLoginLog> implements UserLoginLogService {
5. }

复制代码

编写业务代码

1. @Controller
2. public class BasicController {
4.     @Resource
5.     private UserInfoService userInfoService;
7.     @Resource
8.     private UserLoginLogService userLoginLogService;
10.     private static final String LOGIN = "in";
12.     // http://127.0.0.1:8080/get/user/login/info?id=1
13.     @RequestMapping("/get/user/login/info")
14.     @ResponseBody
15.     public String getUserLoginInfo(@RequestParam(name = "id", required = true) String id) {
16.         UserInfo one = userInfoService.lambdaQuery().eq(UserInfo::getId, id).one();
17.         System.out.println("查询到id=" + id + "的登录用户信息：" + one);
18.         List<UserLoginLog> list = userLoginLogService.lambdaQuery()
19.                 .eq(Objects.nonNull(one), UserLoginLog::getUserId, one.getId())
20.                 .eq(UserLoginLog::getActivityType, LOGIN)
21.                 .list();
22.         System.out.println("查询到id=" + id + "的用户一共登录了：" + list.size() + "次");
23.         return "用户id= " + id + "，名叫：" + one.getUserName() + "，一共登录了系统" + list.size() + "次";
24.     }
25. }

复制代码

启动服务、通过浏览器调用接口

哀求 http://127.0.0.1:8080/get/user/login/info?id=1 ，查看执行结果

by-mybatis-plus项目二

某一个表存在于多个数据源中，即本项目中user_login_log表既在datasource1中又在datasource2中，UserLoginLogService在查询的时间既必要从datasource1又必要从datasource2中查询数据
数据库脚本

在数据库1中补充user_login_log表，并初始化数据

1. use `datasource1`;
3. CREATE TABLE `user_login_log` (
4.     `id` bigint NOT NULL AUTO_INCREMENT COMMENT 'ID',
5.     `user_id` bigint NOT NULL COMMENT '登录用户id',
6.     `user_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户名',
7.     `activity_type` varchar(255) NOT NULL COMMENT '活动时间：in登入，out登出',
8.     `activity_trigger_time` timestamp NOT NULL COMMENT '不懂触发时间（登录或者登出时间）',
9.     `ctime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建日期',
10.     `mtime` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
11.     PRIMARY KEY (`id`)
12. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci COMMENT='用户登录信息记录表';
14. INSERT INTO `datasource1`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'in', '2024-08-06 16:38:43');
15. INSERT INTO `datasource1`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (1, '张三', 'out', '2024-08-06 16:59:43');
16. INSERT INTO `datasource1`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'in', '2024-08-06 16:38:43');
17. INSERT INTO `datasource1`.`user_login_log` (`user_id`, `user_name`, `activity_type`, `activity_trigger_time`) VALUES (2, '李四', 'out', '2024-08-06 16:39:43');

复制代码

在多数据源库的表user_login_log对应的mapper.java上取消@DS(“datasource2”)注解

1. @Mapper
2. // @DS("datasource2")
3. public interface UserLoginLogMapper extends BaseMapper<UserLoginLog> {
5. }

复制代码

在多数据源的表user_login_log对应的service中添加方法，方法必要指定使用的数据源

1. @Service
2. @DS("datasource2")
3. public class UserLoginLogServiceImpl extends ServiceImpl<UserLoginLogMapper, UserLoginLog> implements UserLoginLogService {
5.     @DS("datasource2")
6.     @Override
7.     public List<UserLoginLog> getDataSource(long userId, String activityType) {
8.         return lambdaQuery().eq(UserLoginLog::getUserId, userId).eq(UserLoginLog::getActivityType, activityType).list();
9.     }
11.     @DS("datasource1")
12.     @Override
13.     public List<UserLoginLog> getAntherDataSource(long userId, String activityType) {
14.         return lambdaQuery().eq(UserLoginLog::getUserId, userId).eq(UserLoginLog::getActivityType, activityType).list();
15.     }
16. }

复制代码

注：由于uer_login_log该表在datasource1和datasource2数据源中都存在，所以在mapper.java中必要取消@DS注解

• 那么在service的方法中就必要指定数据源
  
• 在service的上层调用方如controller中必须调用service的方法，不能跳过service类中方法而直接在controller中通过
  userLoginLogService.lambdaQuery()的方式调用，这样调用体系会直接查询yml配置的"primary: datasource1"的默认数据源
  

编写controller类测试

1. @Controller
2. public class BasicController {
4.     @Resource
5.     private UserInfoService userInfoService;
7.     @Resource
8.     private UserLoginLogService userLoginLogService;
10.     private static final String LOGIN = "in";
12.     /**
13.      * 说明： 该方法中通过mybatis plus的多数据源调用两个库的数据查询
14.      * userInfoService使用数据源datasource1
15.      * userLoginLogService使用数据源datasource2
16.      * 测试请求地址： <a href="http://127.0.0.1:8080/get/user/login/info?id=1">测试请求地址</a>
17.      *
18.      * @param id 用户id
19.      * @return 查询结果
20.      */
21.     @RequestMapping("/get/user/login/info")
22.     @ResponseBody
23.     public String getUserLoginInfo(@RequestParam(name = "id") Long id) {
24.         UserInfo one = userInfoService.lambdaQuery().eq(UserInfo::getId, id).one();
25.         System.out.println("查询到id=" + id + "的登录用户信息：" + one);
26.         /*
27.          * 如果在userLoginLogService中有方法指定了@DS其他数据源，那么在上层方法中不能跳过userLoginLogService的方法
28.          * 直接使用lambdaQuery()，只能在userLoginLogService中使用lambdaQuery()，因为如果直接使用lambdaQuery()的话，
29.          * 因为mapper.java没有配置数据源（原因见下个方法注释），会直接使用yml配置的primary: datasource1数据源
30.          */
31.         List<UserLoginLog> list = userLoginLogService.lambdaQuery()
32.                 .eq(Objects.nonNull(one), UserLoginLog::getUserId, one.getId())
33.                 .eq(UserLoginLog::getActivityType, LOGIN)
34.                 .list();
35.         System.out.println("lambdaQuery()方式查询到id=" + id + "的用户一共登录了：" + list.size() + "次");
36.         List<UserLoginLog> dataSource = userLoginLogService.getDataSource(one.getId(), LOGIN);
37.         System.out.println("调用service中方法的方式查询到id=" + id + "的用户一共登录了：" + dataSource.size() + "次");
38.         return "用户id= " + id + "，名叫：" + one.getUserName() + "，一共登录了系统" + dataSource.size() + "次";
39.     }
41.     /**
42.      * 说明：该方法中通过mybatis plus的多数据源调用两个库的数据查询，其中且有一个库在两边都存在并进行查询
43.      * userInfoService 配置数据源datasource1
44.      * userLoginLogService 默认配置数据源datasource2，但是在某些方法上使用数据源datasource1
45.      * 测试请求地址： <a href="http://127.0.0.1:8080/get/different/in/same/service?id=1">测试请求地址</a>
46.      *
47.      * @param id 用户id
48.      * @return 查询结果
49.      */
50.     @RequestMapping("/get/different/in/same/service")
51.     @ResponseBody
52.     public String getDifferentInInSameService(@RequestParam(name = "id") Long id) {
53.         UserInfo one = userInfoService.lambdaQuery().eq(UserInfo::getId, id).one();
54.         System.out.println("查询到id=" + id + "的登录用户信息：" + one);
55.         /*
56.          * 重要！！！
57.          * 说明，如果在某个service中有方法使用其他数据源，那么注意：
58.          * 1、在mapper.java中不能使用@DS注解，如果使用，所有的请求都会走mapper.java中指定的数据源
59.          * 2、在service中，需要走默认数据源的方法，需要手动编写方法，不能在层如controller中直接通过lambdaQuery()方式调用，否则会和另外指定数据源的方法走一个数据源去
60.          */
61. //        List<UserLoginLog> list = userLoginLogService.lambdaQuery()
62. //                .eq(Objects.nonNull(one), UserLoginLog::getUserId, one.getId())
63. //                .eq(UserLoginLog::getActivityType, LOGIN)
64. //                .list();
65.         List<UserLoginLog> list = userLoginLogService.getDataSource(id, LOGIN);
66.         System.out.println("database2登录：" + list.size() + "次");
67.         List<UserLoginLog> antherDataSource = userLoginLogService.getAntherDataSource(id, LOGIN);
68.         System.out.println("database1登录：" + antherDataSource.size() + "次");
69.         int size = list.size() + antherDataSource.size();
70.         System.out.println("查询到id=" + id + "的用户一共登录了：" + size + "次");
71.         return "用户id= " + id + "，名叫：" + one.getUserName() + "，一共登录了系统" + size + "次";
72.     }
73. }

复制代码

启动服务、进行测试

哀求 http://127.0.0.1:8080/get/user/login/info?id=1 ，查看执行结果

idea配景打印日志：

哀求 http://127.0.0.1:8080/get/different/in/same/service?id=1 ，查看执行结果

idea配景打印日志：

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。