首頁慕課教程 Spring Boot 入門教程 Spring Boot 多數(shù)據(jù)源與分布式事務(wù)

程序員大陽 · 更新于 2020-05-02

上一節(jié)

Spring Boot 使用事務(wù)

Spring Boot 日志管理

下一節(jié)

Spring Boot 多數(shù)據(jù)源與分布式事務(wù)

1. 前言

一個項目中使用多個數(shù)據(jù)源的需求，我們在日常工作中時常會遇到。

以商城系統(tǒng)為例，有一個 MySQL 的數(shù)據(jù)庫負(fù)責(zé)存儲交易數(shù)據(jù)。公司還有一套 ERP 企業(yè)信息化管理系統(tǒng)，要求訂單信息同步錄入 ERP 數(shù)據(jù)庫，便于公司統(tǒng)一管理，而該 ERP 系統(tǒng)采用的數(shù)據(jù)庫為 SQL Server 。

此時，就可以在 Spring Boot 項目中配置多個數(shù)據(jù)源。另外，使用多數(shù)據(jù)源后，需要采用分布式事務(wù)來保持?jǐn)?shù)據(jù)的完整性。

2. 實例場景

本小節(jié)我們使用 Spring Boot 開發(fā)一個商城系統(tǒng)的訂單生成功能，訂單信息同時進(jìn)入 MySQL 與 SQL Server 數(shù)據(jù)庫。

3. 數(shù)據(jù)庫模塊實現(xiàn)

首先創(chuàng)建 MySQL 數(shù)據(jù)庫 shop ，并新建訂單表 order ，表結(jié)構(gòu)如下：

圖片描述

order 表結(jié)構(gòu)

然后創(chuàng)建 SQL Server 數(shù)據(jù)庫 erpshop ，并新建訂單表 erp_order ，表結(jié)構(gòu)如下。注意 id 是自增長的唯一標(biāo)識，out_id 是對應(yīng)訂單在 MySQL 數(shù)據(jù)庫中的唯一標(biāo)識，以便在兩個庫中比對訂單。
圖片描述

erp_order 結(jié)構(gòu)

4. Spring Boot 后端實現(xiàn)

接下來，我們開始實現(xiàn) Spring Boot 后端項目，數(shù)據(jù)持久層采用 MyBatis 框架，同時訪問兩個數(shù)據(jù)源。

4.1 使用 Spring Initializr 創(chuàng)建項目

Spring Boot 版本選擇 2.2.5 ，Group 為 com.imooc ， Artifact 為 spring-boot-multidb，生成項目后導(dǎo)入 Eclipse 開發(fā)環(huán)境。

4.2 引入項目依賴

我們引入熱部署依賴、 Web 依賴、數(shù)據(jù)庫訪問相關(guān)依賴及測試相關(guān)依賴，具體如下：

實例：

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<!-- 熱部署 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
		</dependency>
		<!-- Web支持 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<!-- JDBC -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-jdbc</artifactId>
		</dependency>
		<!-- MySQL驅(qū)動 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<!-- SQL Server驅(qū)動 -->
		<dependency>
			<groupId>com.microsoft.sqlserver</groupId>
			<artifactId>mssql-jdbc</artifactId>
		</dependency>
		<!-- 集成MyBatis -->
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>2.1.2</version>
		</dependency>
		<!-- junit -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- 測試 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

4.3 數(shù)據(jù)源配置

由于我們要同時訪問兩個數(shù)據(jù)庫，所以需要在配置文件中添加兩個數(shù)據(jù)源的配置信息。注意配置多數(shù)據(jù)源時， url 配置需要使用 spring.datasource.db1.jdbc-url=xxx 的形式。

實例：

# 數(shù)據(jù)源1 MySQL
spring.datasource.db1.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.db1.jdbc-url=jdbc:mysql://127.0.0.1:3306/shop?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
spring.datasource.db1.username=root
spring.datasource.db1.password=Easy@0122
# 數(shù)據(jù)源2 SQL Server
spring.datasource.db2.driverClassName = com.microsoft.sqlserver.jdbc.SQLServerDriver
spring.datasource.db2.jdbc-url =jdbc:sqlserver://127.0.0.1:1433;DatabaseName=erpshop
spring.datasource.db2.username =sa
spring.datasource.db2.password =Easy@0122

4.4 注冊數(shù)據(jù)源組件

多個數(shù)據(jù)源的情況下，我們需要通過配置類，將數(shù)據(jù)源注冊為組件放入 Spring 容器中。

實例：

/**
 * 數(shù)據(jù)源配置類
 */
@Configuration//標(biāo)注為配置類
public class DataSourceConfig {
	/**
	 * 數(shù)據(jù)源1
	 */
	@Bean//返回值注冊為組件
	@ConfigurationProperties("spring.datasource.db1")//使用spring.datasource.db1作為前綴的配置
	public DataSource db1() {
		return DataSourceBuilder.create().build();
	}
	/**
	 * 數(shù)據(jù)源2
	 */
	@Bean//返回值注冊為組件
	@ConfigurationProperties("spring.datasource.db2")//使用spring.datasource.db2作為前綴的配置
	public DataSource db2() {
		return DataSourceBuilder.create().build();
	}
}

通過這個配置類， Spring 容器中就有兩個數(shù)據(jù)源組件，這兩個組件分別采用 spring.datasource.db1 和 spring.datasource.db2 開頭的配置信息。所以通過這兩個組件，就能分別操作 MySQL 數(shù)據(jù)源 1 和 SQL Sever 數(shù)據(jù)源 2 。

4.5 MyBatis 配置

多數(shù)據(jù)源情況下， MyBatis 中的關(guān)鍵組件 SqlSessionFactory 和 SqlSessionTemplate 也需要單獨(dú)配置，我們需要為兩個數(shù)據(jù)源分別配置一套組件。

實例：

/**
 * 數(shù)據(jù)源1 MyBatis配置
 */
@Configuration
@MapperScan(value = "com.imooc.springbootmultidb.mapper1", sqlSessionFactoryRef = "sqlSessionFactory1")
public class Db1MyBatisConfig {
	@Autowired // 自動裝配
	@Qualifier("db1") // 指定注入名為db1的組件
	private DataSource db1;

	@Bean
	public SqlSessionFactory sqlSessionFactory1() throws Exception {
		SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
		sqlSessionFactoryBean.setDataSource(db1);// sqlSessionFactory1使用的數(shù)據(jù)源為db1
		sqlSessionFactoryBean
				.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper1/*.xml"));
		return sqlSessionFactoryBean.getObject();
	}

	@Bean
	public SqlSessionTemplate sqlSessionTemplate1() throws Exception {
		return new SqlSessionTemplate(sqlSessionFactory1());// sqlSessionTemplate1使用的數(shù)據(jù)源也是關(guān)聯(lián)到db1
	}
}

通過上面的配置類， com.imooc.springbootmultidb.mapper1 包中的 DAO 數(shù)據(jù)訪問接口會自動調(diào)用 sqlSessionTemplate1 組件實現(xiàn)具體數(shù)據(jù)庫操作，而 sqlSessionTemplate1 操作的數(shù)據(jù)源已經(jīng)通過配置類設(shè)置為 db1 。同時， DAO 數(shù)據(jù)訪問接口對應(yīng)的映射文件已經(jīng)指定到 classpath:mapper1/ 目錄去尋找。這樣數(shù)據(jù)源 – DAO 數(shù)據(jù)訪問接口 – 映射文件三者的對應(yīng)關(guān)系就建立起來了。

數(shù)據(jù)源 2 的配置方法是一樣的，com.imooc.springbootmultidb.mapper2 包中的 DAO 數(shù)據(jù)訪問接口會自動調(diào)用 sqlSessionTemplate2 組件，其操作的數(shù)據(jù)源即為 db2 ，其對應(yīng)的映射文件指定到 classpath:mapper2/ 目錄去尋找。

實例：

/**
 * 數(shù)據(jù)源2 MyBatis配置
 */
@Configuration
@MapperScan(value = "com.imooc.springbootmultidb.mapper2", sqlSessionFactoryRef = "sqlSessionFactory2")
public class Db2MyBatisConfig {
	@Autowired // 自動裝配
	@Qualifier("db2") // 指定注入名為db1的組件
	private DataSource db2;

	@Bean
	public SqlSessionFactory sqlSessionFactory2() throws Exception {
		SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
		sqlSessionFactoryBean.setDataSource(db2);// sqlSessionFactory2使用的數(shù)據(jù)源為db2
		sqlSessionFactoryBean
				.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper2/*.xml"));
		return sqlSessionFactoryBean.getObject();
	}

	@Bean
	public SqlSessionTemplate sqlSessionTemplate2() throws Exception {
		return new SqlSessionTemplate(sqlSessionFactory2());// sqlSessionTemplate2使用的數(shù)據(jù)源也是關(guān)聯(lián)到db2
	}
}

4.6 數(shù)據(jù)訪問接口實現(xiàn)

數(shù)據(jù)訪問接口的位置已經(jīng)在配置類指定，首先在 com.imooc.springbootmultidb.mapper1 創(chuàng)建 OrderDao ，操作的是數(shù)據(jù)源 1 中的 order 表。

實例：

/**
 * 數(shù)據(jù)訪問接口
 */
@Repository
public interface OrderDao {
	public int insert(OrderDo order);
}

然后在 com.imooc.springbootmultidb.mapper2 創(chuàng)建 ErpOrderDao ，操作的是數(shù)據(jù)源 2 中的 erporder 表。

實例：

/**
 * 數(shù)據(jù)訪問接口
 */
@Repository
public interface ErpOrderDao {
	public int insert(ErpOrderDo erpOrder);
}

這兩個接口中使用的數(shù)據(jù)對象比較簡單，代碼如下：

實例：

/**
 * 訂單數(shù)據(jù)類
 */
public class OrderDo {
	/**
	 * 訂單id
	 */
	private Long id;
	/**
	 * 商品id
	 */
	private Long goodsId;
	/**
	 * 購買數(shù)量
	 */
	private Long count;
	// 省略 get set
}
/**
 * ERP訂單數(shù)據(jù)類
 */
public class ErpOrderDo {
	/**
	 * 訂單id
	 */
	private Long id;
	/**
	 * 商城系統(tǒng)訂單id
	 */
	private Long outId;
	/**
	 * 商品id
	 */
	private Long goodsId;
	/**
	 * 購買數(shù)量
	 */
	private Long count;
	// 省略 get set
}

4.7 編寫映射文件

分別針對 OrderDao 、 ErpOrderDao 編寫對應(yīng)的映射文件，然后按照配置類指定的位置，兩個文件分別放到 resources/mapper1 和 resources/mapper2 目錄下。

實例：

<?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">
<!-- 本映射文件對應(yīng)OrderDao接口 -->
<mapper namespace="com.imooc.springbootmultidb.mapper1.OrderDao">
	<!-- 對應(yīng)OrderDao中的insert方法 -->
	<insert id="insert"
		parameterType="com.imooc.springbootmultidb.mapper1.OrderDo"
		useGeneratedKeys="true" keyProperty="id">
		insert into `order`
		(goods_id,count) values (#{goodsId},#{count})
	</insert>
</mapper>

實例：

<?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">
<!-- 本映射文件對應(yīng)ErpOrderDao接口 -->
<mapper
	namespace="com.imooc.springbootmultidb.mapper2.ErpOrderDao">
	<!-- 對應(yīng)ErpOrderDao中的insert方法 -->
	<insert id="insert"
		parameterType="com.imooc.springbootmultidb.mapper2.ErpOrderDo">
		insert into erp_order (out_id,goods_id,count) values
		(#{outId},#{goodsId},#{count})
	</insert>
</mapper>

4.8 多數(shù)據(jù)源測試

數(shù)據(jù)操作接口與對應(yīng)的映射文件均已編寫完畢，現(xiàn)在可以通過測試類進(jìn)行多數(shù)據(jù)源測試了，我們在測試類中同時向兩個庫插入記錄。

實例：

/**
 * 多數(shù)據(jù)源測試
 */
@SpringBootTest
class MultidbTest {
	@Autowired
	private OrderDao orderDao;// 對應(yīng)數(shù)據(jù)源1
	@Autowired
	private ErpOrderDao erpOrderDao;// 對應(yīng)數(shù)據(jù)源2

	/**
	 * 插入測試
	 */
	@Test
	void testInsert() {
		// 數(shù)據(jù)源1插入數(shù)據(jù)
		OrderDo order = new OrderDo();
		order.setCount(1L);
		order.setGoodsId(1L);
		int affectRows1 = orderDao.insert(order);
		// 數(shù)據(jù)源2插入數(shù)據(jù)
		ErpOrderDo erpOrder = new ErpOrderDo();
		erpOrder.setCount(order.getCount());
		erpOrder.setGoodsId(order.getGoodsId());
		erpOrder.setOutId(order.getId());
		int affectRows2 = erpOrderDao.insert(erpOrder);
		assertEquals(1, affectRows1);
		assertEquals(1, affectRows2);
	}
}

運(yùn)行測試方法后，兩個數(shù)據(jù)庫表中均新增數(shù)據(jù)成功，這樣我們就成功的使用 Spring Boot 同時操作了兩個數(shù)據(jù)源。

5. 分布式事務(wù)

采用多數(shù)據(jù)源之后，事務(wù)的實現(xiàn)方式也隨之發(fā)生變化。當(dāng)某個數(shù)據(jù)源操作出現(xiàn)異常時，該數(shù)據(jù)源和其他數(shù)據(jù)源的事務(wù)都需要回滾。這種涉及多個數(shù)據(jù)源的事務(wù)，稱為分布式事務(wù)，接來下我們就來具體實現(xiàn)一下。

5.1 引入分布式事務(wù)依賴

在 pom.xml 引入 Atomikos 事務(wù)管理器相關(guān)的依賴項， Atomikos 是一個開源的事務(wù)管理器，支持分布式事務(wù)。

實例：

		<!--分布式事務(wù) -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-jta-atomikos</artifactId>
		</dependency>

5.2 更換數(shù)據(jù)源組件

需要將默認(rèn)的數(shù)據(jù)源更換為支持分布式事務(wù)的數(shù)據(jù)源， MySQL 對應(yīng)的數(shù)據(jù)源為 MysqlXADataSource ， SQL Server 對應(yīng)的數(shù)據(jù)源為 SQLServerXADataSource 。

實例：


/**
 * 數(shù)據(jù)源配置類
 */
@Configuration // 標(biāo)注為配置類
public class DataSourceConfig {
	// 注入數(shù)據(jù)源1配置項
	@Value("${spring.datasource.db1.jdbc-url}")
	private String db1_url;
	@Value("${spring.datasource.db1.username}")
	private String db1_username;
	@Value("${spring.datasource.db1.password}")
	private String db1_password;
	// 注入數(shù)據(jù)源2配置項
	@Value("${spring.datasource.db2.jdbc-url}")
	private String db2_url;
	@Value("${spring.datasource.db2.username}")
	private String db2_username;
	@Value("${spring.datasource.db2.password}")
	private String db2_password;

	/**
	 * 數(shù)據(jù)源1
	 */
	@Bean // 返回值注冊為組件
	public DataSource db1() throws SQLException {
		MysqlXADataSource dataSource = new MysqlXADataSource();
		dataSource.setUrl(db1_url);
		dataSource.setUser(db1_username);
		dataSource.setPassword(db1_password);
		AtomikosDataSourceBean atomikosDataSourceBean = new AtomikosDataSourceBean();
		atomikosDataSourceBean.setXaDataSource(dataSource);
		atomikosDataSourceBean.setUniqueResourceName("db1");
		return atomikosDataSourceBean;

	}

	/**
	 * 數(shù)據(jù)源2
	 */
	@Bean // 返回值注冊為組件
	public DataSource db2() {
		SQLServerXADataSource dataSource = new SQLServerXADataSource();
		dataSource.setURL(db2_url);
		dataSource.setUser(db2_username);
		dataSource.setPassword(db2_password);
		AtomikosDataSourceBean atomikosDataSourceBean = new AtomikosDataSourceBean();
		atomikosDataSourceBean.setXaDataSource(dataSource);
		atomikosDataSourceBean.setUniqueResourceName("db2");
		return atomikosDataSourceBean;
	}
}

5.3 添加分布式事務(wù)管理器組件

繼續(xù)修改 DataSourceConfig 類，在其中配置分布式事務(wù)管理器組件。當(dāng)項目中使用事務(wù)時，會通過配置的分布式事務(wù)管理器管理分布式事務(wù)操作。

實例：

	/**
	 * 分布式事務(wù)管理器
	 */
	@Bean(name = "jtaTransactionManager")
	public JtaTransactionManager jtaTransactionManager() {
		UserTransactionManager userTransactionManager = new UserTransactionManager();
		UserTransaction userTransaction = new UserTransactionImp();
		return new JtaTransactionManager(userTransaction, userTransactionManager);
	}

5.4 測試分布式事務(wù)

在測試方法上添加 @Transactional 開啟事務(wù)，然后在兩個數(shù)據(jù)源操作中間模擬拋出異常。

實例：

	/**
	 * 插入測試
	 */
	@Test
	@Transactional // 開啟事務(wù)
	void testInsert() {
		// 數(shù)據(jù)源1插入數(shù)據(jù)
		OrderDo order = new OrderDo();
		order.setCount(1L);
		order.setGoodsId(1L);
		int affectRows1 = orderDao.insert(order);
		// 模擬拋出異常
		int a = 1 / 0;
		// 數(shù)據(jù)源2插入數(shù)據(jù)
		ErpOrderDo erpOrder = new ErpOrderDo();
		erpOrder.setCount(order.getCount());
		erpOrder.setGoodsId(order.getGoodsId());
		erpOrder.setOutId(order.getId());
		int affectRows2 = erpOrderDao.insert(erpOrder);
		assertEquals(1, affectRows1);
		assertEquals(1, affectRows2);
	}

此時運(yùn)行測試類，可以發(fā)現(xiàn)數(shù)據(jù)源 1 的事務(wù)已回滾，驗證成功！

Tips：如果運(yùn)行測試類報錯 master..xp_sqljdbc_xa_init_ex 相關(guān)信息，是 SQL Server 默認(rèn)配置不支持分布式事務(wù)問題，可查詢相關(guān)資料解決該問題。

6. 小結(jié)

在開發(fā) Spring Boot 項目時，如果默認(rèn)配置滿足不了我們的需求，可以通過手工配置組件實現(xiàn)我們需要的功能。這些組件可能是各個公司提供的，我們根據(jù)相應(yīng)文檔，為其配置各個屬性即可。

配置多個數(shù)據(jù)源時，通過配置類，逐一配置數(shù)據(jù)源組件及其參數(shù)。
配置 MyBatis 時，手工配置 MyBatis 相關(guān)組件，并指定相應(yīng)掃描的 DAO 類及映射文件。
使用分布式事務(wù)時，使用支持分布式事務(wù)的數(shù)據(jù)源組件，并配置分布式事務(wù)管理器。

上一節(jié)

Spring Boot 使用事務(wù)

下一節(jié)

Spring Boot 日志管理

我要提出意見反饋

第七色在线视频,2021少妇久久久久久久久久,亚洲欧洲精品成人久久av18,亚洲国产精品特色大片观看完整版,孙宇晨将参加特朗普的晚宴

熱搜

最近搜索 清空

我的購物車

已加入門課程

購物車?yán)锟湛杖缫?/h3> 快去這里選購你中意的課程 實戰(zhàn)課 體系課

Spring Boot 入門教程

前端開發(fā)

JavaScript

JavaScript 入門教程

TypeScript 入門教程

Vue 入門教程

Ajax 入門教程

ES6-10 入門教程

Yarn 入門教程

ECharts 入門教程

HTML & CSS

CSS3 入門教程

雪碧圖入門教程

移動端布局教程

Html5 入門教程

Sass 入門教程

HTML 入門教程

canvas 入門教程

uni-app 入門教程

服務(wù)端相關(guān)

服務(wù)器

Nginx 入門教程

HTTP 入門教程

Docker 入門教程

Shell 入門教程

Linux 入門教程

開發(fā)工具

Gradle 入門教程

Vim 編輯器教程

RESTful 規(guī)范教程

Dreamweaver 教程

Markdown 入門教程

Maven 入門教程

Eclipse 編輯器教程

GitHub 入門教程

Android Studio 編輯器教程

PyCharm 編輯器教程

Sublime Text 使用教程

Postman 教程

Git入門教程

熱門服務(wù)端語言

C 語言入門教程

Go 入門教程

Kotlin 教程

Ruby 入門教程

ThinkPHP 入門教程

Java

基礎(chǔ)應(yīng)用

Java 入門教程

Android 入門教程

算法入門教程

數(shù)據(jù)結(jié)構(gòu)入門教程

Lambda 表達(dá)式教程

Java 并發(fā)原理入門教程

設(shè)計模式入門教程

Java并發(fā)工具

JVM 入門教程

RabbitMQ 入門教程

網(wǎng)絡(luò)編程入門教程

后端通用面試教程

框架應(yīng)用

Spring Boot 入門教程

Spring 入門教程

Hibernate 入門教程

MyBatis 入門教程

Spring MVC 入門教程

Swagger 入門教程

Zookeeper 入門教程

Netty 教程

Spring Security

微服務(wù)

Spring Cloud Hystrix

Python

基礎(chǔ)應(yīng)用

最近搜索清空

購物車?yán)锟湛杖缫?/h3>
快去這里選購你中意的課程

實戰(zhàn)課

體系課