记录:383
场景:使用dynamic-datasource-spring-boot-starter动态切换数据源,使用MyBatis操作数据库。提供三种示例:一,使用@DS注解作用到类上。二,使用@DS注解作用到方法上。三,不使用注解,使用DynamicDataSourceContextHolder类在方法内灵活切换不同数据源。
源码:https://github.com/baomidou
源码:https://github.com/baomidou/dynamic-datasource-spring-boot-starter
dynamic-datasource-spring-boot-starter:一个基于springboot的快速集成多数据源的启动器。
1.初始化准备
1.1创建Maven工程
使用IntelliJ IDEA创建Maven工程。
(1)微服务名称
名称:hub-example-202-dynamic-datasource
(2)微服务groupId和artifactId
groupId: com.hub
artifactId: hub-example-202-dynamic-datasource
(3)微服务核心模块版本
spring-boot 2.6.3
spring-framework 5.3.15
mybatis-spring-boot-starter 2.2.2
mybatis-3.5.9
mybatis-spring-2.0.7
HikariCP-4.0.3
dynamic-datasource-spring-boot-starter-3.3.2
1.1.2准备数据库
集成动态数据源,使用MyBatis操作数据库。
(1)数据库一
数据库名称:hub_exampledb
脚本:
USE mysql;
CREATE DATABASE hub_exampledb DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER hub_example@'%' IDENTIFIED BY 'h12345678';
GRANT ALL ON hub_exampledb.* TO 'hub_example'@'%' IDENTIFIED BY 'h12345678';
FLUSH PRIVILEGES;
(2)数据库二
数据库名称:hub_example02db
脚本:
USE mysql;
CREATE DATABASE hub_example02db DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER hub_example02@'%' IDENTIFIED BY 'h12345678';
GRANT ALL ON hub_example02db.* TO 'hub_example02'@'%' IDENTIFIED BY 'h12345678';
FLUSH PRIVILEGES;
2.修改pom.xml
修改pom.xml,引入项目依赖Jar、管理Jar包等。
2.1修改pom.xml文件
引入核心依赖包:mybatis和dynamic-datasource。
内容:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
解析:引入mybatis-spring-boot-starter-2.2.2,对应加载mybatis-3.5.9和mybatis-spring-2.0.7。引入dynamic-datasource-spring-boot-starter-3.3.2,加载动态数据源的依赖包。
2全量pom.xml文件
全量pom.xml文件请参考附录:12.1全量pom.xml文件
3.创建application.yml文件
在application.yml中添加各类配置。
3.1集成MyBatis的配置
(1)基础配置
内容:
mybatis:
mapper-locations: classpath*:mapper/*.xml
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
解析:mapper-locations属性指定MyBatis映射的SQL文件目录。
注意:属性log-impl在Java类中是logImpl,一般是驼峰命名的大写字母转换小写且在字母前加上短横线。
(2)属性类
MyBatis配置属性主要从以下两个类找到。
类:org.mybatis.spring.boot.autoconfigure.MybatisProperties
类:org.apache.ibatis.session.Configuration
3.2动态数据源配置
内容:
spring:
datasource:
dynamic:
primary: hub_exampledb
strict: false
datasource:
hub_exampledb:
url: jdbc:mysql://127.0.0.1:3306/hub_exampledb
username: hub_example
password: h12345678
driver-class-name: com.mysql.cj.jdbc.Driver
hub_example02db:
url: jdbc:mysql://127.0.0.1:3306/hub_example02db
username: hub_example02
password: h12345678
driver-class-name: com.mysql.cj.jdbc.Driver
解析:属性primary指定一个数据库,本例操作MySQL数据库的hub_exampledb和hub_example02db。比如要操作Oracle数据库,添加相应信息即可。
3.3其它基础配置
内容:
server:
servlet:
context-path: /hub-example-ds
port: 18080
spring:
jackson:
time-zone: GMT+8
解析:指定服务器端口和路径前缀。指定时区为东八区。
4.创建启动类
4.1创建包
com.hub.example.config:配置类,微服务各类自定义配置。
com.hub.example.domain:微服务使用到的VO、PO等实体类。
com.hub.example.mapper:MyBatis接口。
com.hub.example.service:服务实现类。
com.hub.example.controller:Controller类,发布Restful接口。
com.hub.example.utils:支撑工具类。
4.2启动类
包名:com.hub.example。
启动类:DynamicDatasourceExampleApplication。
(1)内容
@SpringBootApplication
@ComponentScan(basePackages = {"com.hub.example.*"})
@MapperScan(basePackages = "com.hub.example.**.mapper")
public class DynamicDatasourceExampleApplication {
public static void main(String[] args) {
SpringApplication.run(DynamicDatasourceExampleApplication.class, args);
}
}
(2)解析
@SpringBootApplication,SpringBoot标记启动类的注解。
@ComponentScan,扫描指定的包,将组件加载到IOC容器中。
@MapperScan,是MyBatis的注解,扫描指定目录下提供给MyBatis注入的接口。
5.编写Java接口(提供给MyBatis使用)
在MyBatis的ORM(Object Relational Mapping)对象映射关系机制中,一个Java接口映射到一个MyBatis的SQL文件,一个接口方法映射到一条MyBatis的SQL语句。
5.1CityMapper接口
接口全路径:com.hub.example.mapper.CityMapper
内容:
@Repository
public interface CityMapper {
CityDTO queryCityByCityId(String cityId);
}
5.2ProvinceMapper接口
接口全路径:com.hub.example.mapper.ProvinceMapper
内容:
@Repository
public interface ProvinceMapper {
ProvinceDTO queryProvinceByProvinceId(String cityId);
}
6.编写MyBatis的SQL
一个Java接口映射到一个MyBatis的SQL文件。Java接口的一个方法映射到一个SQL。
6.1CityMapper.xml
CityMapper接口映射到CityMapper.xml。
内容:
<?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.hub.example.mapper.CityMapper">
<select id="queryCityByCityId" parameterType="String" resultType="com.hub.example.domain.CityDTO">
select
CITY_ID AS "cityId",
CITY_NAME AS "cityName",
LAND_AREA AS "landArea",
POPULATION AS "population",
GROSS AS "gross",
CITY_DESCRIBE AS "cityDescribe",
DATA_YEAR AS "dataYear",
UPDATE_TIME AS "updateTime"
from t_city
where CITY_ID = #{cityId}
</select>
</mapper>
6.2ProvinceMapper.xml
ProvinceMapper接口映射到ProvinceMapper.xml。
内容:
<?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.hub.example.mapper.ProvinceMapper">
<select id="queryProvinceByProvinceId" parameterType="String" resultType="com.hub.example.domain.ProvinceDTO">
select
PROVINCE_ID AS "provinceId",
PROVINCE_NAME AS "provinceName",
LAND_AREA AS "landArea",
POPULATION AS "population",
GROSS AS "gross",
PROVINCE_DESCRIBE AS "provinceDescribe",
DATA_YEAR AS "dataYear",
UPDATE_TIME AS "updateTime"
from t_province
where PROVINCE_ID = #{provinceId}
</select>
</mapper>
7.使用DS注解作用到类上切换数据源
使用方式:在类上使用注解:@DS("hub_exampledb"),hub_exampledb是在application.yml配置的数据源名称。
7.1编写Service层代码
在Service层注入xxMapper接口,以调用接口方式来调用MyBatis机制操作数据库。
7.1.1Service接口
(1)CityService接口
内容:
public interface CityService {
CityDTO queryCityByCityId(String cityId);
}
(2)ProvinceService接口
内容:
public interface ProvinceService {
ProvinceDTO queryProvinceByProvinceId(String provinceId);
}
7.1.2Service实现类
(1)CityServiceImpl实现类
内容:
@DS("hub_exampledb")
@Service
public class CityServiceImpl implements CityService {
@Autowired
private CityMapper cityMapper;
@Override
public CityDTO queryCityByCityId(String cityId) {
return cityMapper.queryCityByCityId(cityId);
}
}
(2)ProvinceServiceImpl实现类
内容:
@DS("hub_example02db")
@Service
public class ProvinceServiceImpl implements ProvinceService {
@Autowired
private ProvinceMapper provinceMapper;
@Override
public ProvinceDTO queryProvinceByProvinceId(String provinceId) {
return provinceMapper.queryProvinceByProvinceId(provinceId);
}
}
7.2编写Controller层代码
在Controller层注入Service接口,以调用接口方式来调用Service实现类。
@RestController
@RequestMapping("/hub/example/DsOnClass/")
public class DsOnClassController {
@Autowired
private CityService cityService;
@Autowired
private ProvinceService provinceService;
@PostMapping("/query")
public ResultObj<DataVO> query(@RequestBody IdVO idVO) {
CityDTO cityDTO = cityService.queryCityByCityId(idVO.getCityId());
ProvinceDTO provinceDTO = provinceService.queryProvinceByProvinceId(idVO.getProvinceId());
DataVO dataVO = new DataVO();
dataVO.setProvinceDTO(provinceDTO);
dataVO.setCityDTO(cityDTO);
return ResultObj.data(200, dataVO, "DS注解作用到类,切换数据源,执行成功");
}
}
8.使用DS注解作用到方法上切换数据源
使用方式:在方法上使用注解:@DS("hub_exampledb"),hub_exampledb是在application.yml配置的数据源名称。
8.1编写Service层代码
在Service层注入xxMapper接口,以调用接口方式来调用MyBatis机制操作数据库。
8.1.1Service接口
public interface DsOnMethodService {
ProvinceDTO queryProvinceByProvinceId(String provinceId);
CityDTO queryCityByCityId(String cityId);
}
8.1.2Service实现类
在方法上使用@DS注解。
@Service
public class DsOnMethodServiceImpl implements DsOnMethodService {
@Autowired
private ProvinceMapper provinceMapper;
@Autowired
private CityMapper cityMapper;
@DS("hub_example02db")
@Override
public ProvinceDTO queryProvinceByProvinceId(String provinceId) {
return provinceMapper.queryProvinceByProvinceId(provinceId);
}
@DS("hub_exampledb")
@Override
public CityDTO queryCityByCityId(String cityId) {
return cityMapper.queryCityByCityId(cityId);
}
}
8.2编写Controller层代码
在Controller层注入Service接口,以调用接口方式来调用Service实现类。
@RestController
@RequestMapping("/hub/example/DsOnMethod/")
public class DsOnMethodController {
@Autowired
private DsOnMethodService dsOnMethodService;
@PostMapping("/query")
public ResultObj<DataVO> query(@RequestBody IdVO idVO) {
CityDTO cityDTO = dsOnMethodService.queryCityByCityId(idVO.getCityId());
ProvinceDTO provinceDTO = dsOnMethodService.queryProvinceByProvinceId(idVO.getProvinceId());
DataVO dataVO = new DataVO();
dataVO.setProvinceDTO(provinceDTO);
dataVO.setCityDTO(cityDTO);
return ResultObj.data(200, dataVO, "DS注解作用到方法,切换数据源,执行成功");
}
}
9.使用DynamicDataSourceContextHolder切换数据源
使用DynamicDataSourceContextHolder类在方法内灵活切换不同数据源。
9.1编写Service层代码
在Service层注入xxMapper接口,以调用接口方式来调用MyBatis机制操作数据库。
9.1.1Service接口
public interface DsUseContextHolderService {
DataVO query(IdVO idVO);
}
9.1.2Service实现类
在方法内灵活切换数据源。
@Service
public class DsUseContextHolderServiceImpl implements DsUseContextHolderService {
@Autowired
private ProvinceMapper provinceMapper;
@Autowired
private CityMapper cityMapper;
@Override
public DataVO query(IdVO idVO) {
// 1.读取hub_example02db的数据
DynamicDataSourceContextHolder.push("hub_example02db");
ProvinceDTO provinceDTO = provinceMapper.queryProvinceByProvinceId(idVO.getProvinceId());
// 2.读取hub_exampledb的数据
DynamicDataSourceContextHolder.poll();
DynamicDataSourceContextHolder.push("hub_exampledb");
CityDTO cityDTO = cityMapper.queryCityByCityId(idVO.getCityId());
DataVO dataVO = new DataVO();
dataVO.setProvinceDTO(provinceDTO);
dataVO.setCityDTO(cityDTO);
return dataVO;
}
}
9.2编写Controller层代码
在Controller层注入Service接口,以调用接口方式来调用Service实现类。
@RestController
@RequestMapping("/hub/example/DsUseContextHolder/")
public class DsUseContextHolderController {
@Autowired
private DsUseContextHolderService dsUseContextHolderService;
@PostMapping("/query")
public ResultObj<DataVO> query(@RequestBody IdVO idVO) {
DataVO dataVO = dsUseContextHolderService.query(idVO);
return ResultObj.data(200,dataVO,"使用DynamicDataSourceContextHolder切换数据源,执行成功");
}
}
10.支撑对象
10.1CityDTO
实体对象全路径:com.hub.example.domain.CityDTO
内容:
@Data
public class CityDTO implements Serializable {
private Long cityId;
private String cityName;
private Double landArea;
private Long population;
private Double gross;
private String cityDescribe;
private String dataYear;
@JsonFormat(
pattern = "yyyy-MM-dd HH:mm:ss"
)
private Date updateTime;
}
10.2ProvinceDTO
实体对象全路径:com.hub.example.domain.ProvinceDTO
内容:
@Data
public class ProvinceDTO {
private Long provinceId;
private String provinceName;
private Double landArea;
private Long population;
private Double gross;
private String provinceDescribe;
private String dataYear;
@JsonFormat(
pattern = "yyyy-MM-dd HH:mm:ss"
)
private Date updateTime;
}
10.3DataVO
实体对象全路径:com.hub.example.domain.DataVO
内容:
@Data
public class DataVO implements Serializable {
private ProvinceDTO provinceDTO;
private CityDTO cityDTO;
}
10.4IdVO
实体对象全路径:com.hub.example.domain.IdVO
内容:
@Data
public class IdVO implements Serializable {
private String provinceId;
private String cityId;
}
10.5DataVO
实体对象全路径:com.hub.example.domain.ResultObj
内容:
@Data
public class ResultObj<T> implements Serializable {
private int code;
private String msg;
private T data;
private ResultObj(int code, T data, String msg) {
this.code = code;
this.data = data;
this.msg = msg;
}
public static <T> ResultObj<T> data(int code, T data, String msg) {
return new ResultObj<>(code, data, msg);
}
}
11.使用Postman工具测试
使用Postman工具测试。
11.1使用DS注解作用到类上切换数据源测试
请求路径:http://127.0.0.1:18080/hub-example-ds/hub/example/DsOnClass/query
请求方式:POST
入参格式:JSON
入参:
{
"provinceId":"1",
"cityId":"1"
}
11.2使用DS注解作用到方法上切换数据源测试
请求路径:http://127.0.0.1:18080/hub-example-ds/hub/example/DsOnMethod/query
请求方式:POST
入参格式:JSON
入参:
{
"provinceId":"1",
"cityId":"1"
}
11.3使用DynamicDataSourceContextHolder切换数据源测试
请求路径:http://127.0.0.1:18080/hub-example-ds/hub/example/DsUseContextHolder/query
请求方式:POST
入参格式:JSON
入参:
{
"provinceId":"1",
"cityId":"1"
}
12.附录
12.1全量pom.xml文件
<?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>com.hub</groupId>
<artifactId>hub-example-202-dynamic-datasource</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.3</version>
</parent>
<description>集成dynamic-datasource框架应用</description>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring.boot.maven.plugin.version>2.6.3</spring.boot.maven.plugin.version>
<spring.boot.version>2.6.3</spring.boot.version>
<mybatis-spring-boot-starter.version>2.2.2</mybatis-spring-boot-starter.version>
<mysql-connector-java.version>8.0.30</mysql-connector-java.version>
<lombok.version>1.18.24</lombok.version>
<guava.version>30.1-jre</guava.version>
<dynamic-datasource.version>3.3.2</dynamic-datasource.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>${spring.boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql-connector-java.version}</version>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis-spring-boot-starter.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>${guava.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>${dynamic-datasource.version}</version>
</dependency>
</dependencies>
<build>
<finalName>${project.artifactId}</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${spring.boot.maven.plugin.version}</version>
<configuration>
<fork>true</fork>
<addResources>true</addResources>
</configuration>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
12.2建表语句与插入SQL
(1)数据库一
数据库名称:hub_exampledb
建表SQL脚本:
CREATE TABLE t_city (
CITY_ID BIGINT(16) NOT NULL COMMENT '唯一标识',
CITY_NAME VARCHAR(64) COLLATE utf8_bin NOT NULL COMMENT '城市名',
LAND_AREA DOUBLE DEFAULT NULL COMMENT '城市面积',
POPULATION BIGINT(16) DEFAULT NULL COMMENT '城市人口',
GROSS DOUBLE DEFAULT NULL COMMENT '生产总值',
CITY_DESCRIBE VARCHAR(512) COLLATE utf8_bin DEFAULT NULL COMMENT '城市描述',
DATA_YEAR VARCHAR(16) COLLATE utf8_bin DEFAULT NULL COMMENT '数据年份',
UPDATE_TIME DATETIME DEFAULT NULL COMMENT '更新时间'
) ENGINE=INNODB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='城市信息表';
插入SQL脚本:
INSERT INTO t_city (
CITY_ID,CITY_NAME,LAND_AREA,POPULATION,
GROSS,CITY_DESCRIBE,DATA_YEAR,UPDATE_TIME)
VALUES
('1','杭州','16850','1237','1.81','杭州是一个好城市','2021','2023-03-10 05:39:16'),
('2','杭州','16850','1237','1.88','杭州是一个好城市','2022','2023-03-10 05:39:17'),
('3','苏州','8657.32','1285','2.32','苏州是一个工业城市','2021','2023-03-10 05:39:18'),
('4','苏州','8657.32','1285','2.4','苏州是一个工业城市','2022','2023-03-10 05:39:1');
(2)数据库二
数据库名称:hub_example02db
建表SQL脚本:
CREATE TABLE t_province (
PROVINCE_ID BIGINT(16) NOT NULL COMMENT '唯一标识',
PROVINCE_NAME VARCHAR(64) COLLATE utf8_bin NOT NULL COMMENT '省名',
LAND_AREA DOUBLE DEFAULT NULL COMMENT '省面积',
POPULATION BIGINT(16) DEFAULT NULL COMMENT '全省人口',
GROSS DOUBLE DEFAULT NULL COMMENT '生产总值',
PROVINCE_DESCRIBE VARCHAR(512) COLLATE utf8_bin DEFAULT NULL COMMENT '省描述',
DATA_YEAR VARCHAR(16) COLLATE utf8_bin DEFAULT NULL COMMENT '数据年份',
UPDATE_TIME DATETIME DEFAULT NULL COMMENT '更新时间'
) ENGINE=INNODB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='省信息表';
插入SQL脚本:
INSERT INTO t_province (
PROVINCE_ID,PROVINCE_NAME,LAND_AREA,POPULATION,
GROSS,PROVINCE_DESCRIBE,DATA_YEAR,UPDATE_TIME)
VALUES
('1','浙江省','105500','6577','7.77','浙江是一个好地方','2022','2023-03-11 10:55:16'),
('2','江苏省','107200','8515','12.29','江苏是一个发达地区','2022','2023-03-11 10:55:17');
以上,感谢。文章来源:https://www.toymoban.com/news/detail-806821.html
2023年3月11日文章来源地址https://www.toymoban.com/news/detail-806821.html
到了这里,关于使用dynamic-datasource-spring-boot-starter动态切换数据源操作数据库(MyBatis-3.5.9)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!