前言
来啦老铁！
笔者学习Spring Boot有一段时间了，附上Spring Boot系列学习文章，欢迎取阅、赐教：
- 5分钟入手Spring Boot;
- Spring Boot数据库交互之Spring Data JPA;
- Spring Boot数据库交互之Mybatis;
- Spring Boot视图技术;
- Spring Boot之整合Swagger;
- Spring Boot之junit单元测试踩坑;
- 如何在Spring Boot中使用TestNG;
- Spring Boot之整合logback日志;
- Spring Boot之整合Spring Batch：批处理与任务调度;
- Spring Boot之整合Spring Security: 访问认证;
- Spring Boot之整合Spring Security: 授权管理;
最近正在筹划开源一款基于Spring Boot的API自动化测试框架，准备在框架中支持多数据库源，毕竟各个公司或个人所使用的数据库可能是不一样的。
网上有很多介绍Spring Boot框架下如何支持多数据库源的文章，大同小异，但我觉得其实现起来还是相对复杂，而我将介绍另外一种极简的方案！
项目代码已上传Git Hub仓库，欢迎取阅：
- https://github.com/dylanz666/spring-boot-multidb-demo
整体步骤
- 创建项目；
- 添加开源依赖；
- 实现多数据库源支持；
- 验证多数据库源效果；
- MongoDB彩蛋；
1. 创建项目；
本小节烦请参考之前的文章Spring Boot数据库交互之Mybatis，我们基于Mybatis的数据库交互方案，创建本项目，并在项目中完成单一数据库(Oracle)的支持。此时，项目整体结构如下：
Mybatis数据库交互
在实现多数据库源支持之前，我们先验证一下单一数据库源（我在Oracle数据库中有一张表，表名：lead）：
1). controller中设置API为：/lead/{leadId};
2). application.properties配置好oracle的数据库信息，即url、username、password、driver-class-name等；
server.port=8080
#configuration for oracle
spring.datasource.url=jdbc:oracle:thin:@//127.0.0.1:1521/TEST
spring.datasource.username=oracleusername
spring.datasource.password=oraclepassword
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
logging.level.com.github.dylanz666.dao=debug
3). 其他介绍忽略，详情请看：Spring Boot数据库交互之Mybatis;
4). 启动项目，访问API：
- http://127.0.0.1:8080/lead/10130546
访问API
后台数据库交互
接下来，我们开始介绍如何支持多数据库源，即尝试在同一Spring Boot中支持Oracle、Mysql、MongoDB等数据库！
2. 添加开源依赖；
我将使用多数据库源神器：
- dynamic-datasource-spring-boot-starter
官方介绍：
- https://gitee.com/baomidou/dynamic-datasource-spring-boot-starter
根据官网的介绍我们发现，其使用起来相当简单，相当极简!
我要演示的是Oracle和Mysql这两种数据库源：
第一步，pom.xml文件中添加该多数据库源神器的依赖，是一个starter:
com.baomidou
dynamic-datasource-spring-boot-starter
3.2.0
第二步，添加数据库连接依赖：
com.oracle.database.jdbc
ojdbc8
19.7.0.0
mysql
mysql-connector-java
runtime
记得安装一下依赖：
mvn install -Dmaven.test.skip=true -Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true
3. 实现多数据库源支持；
1). 修改application.properties；
server.port=8080
#configuration for oracle
spring.datasource.dynamic.primary=oracle
spring.datasource.dynamic.strict=false
spring.datasource.dynamic.datasource.oracle.url=jdbc:oracle:thin:@//127.0.0.1:1521/TEST
spring.datasource.dynamic.datasource.oracle.username=oracleusername
spring.datasource.dynamic.datasource.oracle.password=oraclepassword
spring.datasource.dynamic.datasource.oracle.driver-class-name=oracle.jdbc.OracleDriver
#configuration for mysql
spring.datasource.dynamic.datasource.mysql.url=jdbc:mysql://127.0.0.1:3306/test
spring.datasource.dynamic.datasource.mysql.username=mysqlusername
spring.datasource.dynamic.datasource.mysql.password=mysqlpassword
spring.datasource.dynamic.datasource.mysql.driver-class-name=com.mysql.cj.jdbc.Driver
logging.level.com.github.dylanz666.dao=debug
注意，配置信息内的spring.datasource.dynamic.datasource.oracle...和spring.datasource.dynamic.datasource.mysql...中，oracle和mysql可为任意字符，如：
spring.datasource.dynamic.datasource.dylanz.username。
(请自行配置正确的数据库用户名、密码)
2). 修改service包内的LeadService；
package com.github.dylanz666.service;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.github.dylanz666.dao.LeadDAO;
import com.github.dylanz666.domain.Lead;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @author : dylanz
* @since : 09/13/2020
*/
@Service
public class LeadService {
@Autowired
private LeadDAO leadDAO;
@DS(value = "oracle")
public Lead getLeadByLeadId(Long leadId) {
return leadDAO.getLeadByLeadId(leadId);
}
}
或：
package com.github.dylanz666.service;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.github.dylanz666.dao.LeadDAO;
import com.github.dylanz666.domain.Lead;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @author : dylanz
* @since : 09/13/2020
*/
@Service
@DS(value = "oracle")
public class LeadService {
@Autowired
private LeadDAO leadDAO;
public Lead getLeadByLeadId(Long leadId) {
return leadDAO.getLeadByLeadId(leadId);
}
}
此时，项目整体结构为：
项目整体结构
我们来解读一下：
(1). 只需要使用注解@DS声明使用的数据库是哪一个即可；
(2). @DS内的value属性即为application.properties中配置的数据库名称，未标识value则使用application.properties中配置的primary属性值对应的数据库；
(3). 我们可以在方法维度和类维度利用@DS注解进而使用不同的数据库，简单灵活！
3). Mysql的例子
我在Mysql数据库中有一张表，表名：release_team，代码如下：
- ReleaseTeam实体类：
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Data;
import java.io.Serializable;
/**
* @author : dylanz
* @since : 09/14/2020
*/
@Data
@JsonIgnoreProperties(ignoreUnknown = true)
public class ReleaseTeam implements Serializable {
private static final long serialVersionUID = 1L;
private int id;
private String department;
private String name;
private String updated_by;
private String updated_when;
}
- ReleaseTeamDAO：
package com.github.dylanz666.dao;
import com.github.dylanz666.domain.ReleaseTeam;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
import org.apache.ibatis.annotations.Select;
/**
* @author : dylanz
* @since : 09/14/2020
*/
public interface ReleaseTeamDAO {
@Select("select * from release_team where id = #{id}")
@Results(value = {
@Result(property = "id", column = "ID"),
@Result(property = "department", column = "DEPARTMENT"),
@Result(property = "name", column = "NAME"),
@Result(property = "updated_by", column = "UPDATED_BY"),
@Result(property = "updated_when", column = "UPDATED_WHEN")
})
ReleaseTeam getReleaseTeamById(@Param("id") int id);
}
- ReleaseTeamService：
package com.github.dylanz666.service;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.github.dylanz666.dao.ReleaseTeamDAO;
import com.github.dylanz666.domain.ReleaseTeam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @author : dylanz
* @since : 09/14/2020
*/
@Service
public class ReleaseTeamService {
@Autowired
private ReleaseTeamDAO releaseTeamDAO;
@DS(value = "mysql")
public ReleaseTeam getReleaseTeamById(int id) {
return releaseTeamDAO.getReleaseTeamById(id);
}
}
- ReleaseTeamController：
package com.github.dylanz666.controller;
import com.github.dylanz666.domain.ReleaseTeam;
import com.github.dylanz666.service.ReleaseTeamService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
/**
* @author : dylanz
* @since : 09/14/2020
*/
@RestController
public class ReleaseTeamController {
@Autowired
private ReleaseTeamService releaseTeamService;
@GetMapping("/release/team/{id}")
@ResponseBody
public ReleaseTeam getReleaseTeam(@PathVariable(name = "id") int id) {
return releaseTeamService.getReleaseTeamById(id);
}
}
4. 验证多数据库源效果；
重启项目，分别调用使用Oracle和Mysql数据库的API：
Oracle和Mysql例子
Oracle和Mysql例子的log
总结一下：
1). 这种采用注解的方式与Spring Boot “开箱即用和约定优于配置” 的理念不谋而合，对于使用者来说非常友好和容易使用，如果你会其他多数据库源解决方案的话，你一定会发现，使用了本文这个方案，那是 “真香” 啊！
2). 数据库信息的配置也十分简单和相对灵活，如单一数据库源使用数据库配置类似于spring.datasource.YYY的，只需要改为spring.datasource.dynamic.datasource.XXX.YYY（XXX为自己起的数据库标识，YYY为数据库信息属性，如url、username等）；
3). 这种方式背后帮助使用者完成了datasource配置，因此，我的理解是它支持所有Spring Boot默认支持的数据库类型，但笔者只有使用Oracle、Mysql等的经验，如果朋友们有发现其他问题或限制，也烦请告诉我，感激不尽！
5. MongoDB彩蛋
MongoDB与Oracle、Mysql的使用方式本身不同，不与现有数据库源产生冲突，因此不需要纳入多数据库源解决方案的考虑之中，也即：
-
MongoDB该怎么用还是怎么用，与本方案不冲突！
我也将在合适的机会，介绍如何在Spring Boot框架中使用MongoDB；
今天是我爱人生日，祝老婆生日快乐，也借此感谢老婆多年来的鼓励与支持！
如果本文对您有帮助，麻烦点赞+关注！
谢谢！