Spring Boot 多數據源與分布式事務

1. 前言

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

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

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

2. 實例場景

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

3. 數據庫模塊實現

首先創(chuàng)建 MySQL 數據庫 shop ，并新建訂單表 order ，表結構如下：

然后創(chuàng)建 SQL Server 數據庫 erpshop ，并新建訂單表 erp_order ，表結構如下。注意 id 是自增長的唯一標識，out_id 是對應訂單在 MySQL 數據庫中的唯一標識，以便在兩個庫中比對訂單。

4. Spring Boot 后端實現

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

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

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

4.2 引入項目依賴

我們引入熱部署依賴、 Web 依賴、數據庫訪問相關依賴及測試相關依賴，具體如下：

實例：

		<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驅動 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<!-- SQL Server驅動 -->
		<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 數據源配置

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

實例：

# 數據源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
# 數據源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 注冊數據源組件

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

實例：

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

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

4.5 MyBatis 配置

多數據源情況下， MyBatis 中的關鍵組件 SqlSessionFactory 和 SqlSessionTemplate 也需要單獨配置，我們需要為兩個數據源分別配置一套組件。

實例：

/**
 * 數據源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使用的數據源為db1
		sqlSessionFactoryBean
				.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper1/*.xml"));
		return sqlSessionFactoryBean.getObject();
	}

	@Bean
	public SqlSessionTemplate sqlSessionTemplate1() throws Exception {
		return new SqlSessionTemplate(sqlSessionFactory1());// sqlSessionTemplate1使用的數據源也是關聯到db1
	}
}

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

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

實例：

/**
 * 數據源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使用的數據源為db2
		sqlSessionFactoryBean
				.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper2/*.xml"));
		return sqlSessionFactoryBean.getObject();
	}

	@Bean
	public SqlSessionTemplate sqlSessionTemplate2() throws Exception {
		return new SqlSessionTemplate(sqlSessionFactory2());// sqlSessionTemplate2使用的數據源也是關聯到db2
	}
}

4.6 數據訪問接口實現

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

實例：

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

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

實例：

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

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

實例：

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

4.7 編寫映射文件

分別針對 OrderDao 、 ErpOrderDao 編寫對應的映射文件，然后按照配置類指定的位置，兩個文件分別放到 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">
<!-- 本映射文件對應OrderDao接口 -->
<mapper namespace="com.imooc.springbootmultidb.mapper1.OrderDao">
	<!-- 對應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">
<!-- 本映射文件對應ErpOrderDao接口 -->
<mapper
	namespace="com.imooc.springbootmultidb.mapper2.ErpOrderDao">
	<!-- 對應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 多數據源測試

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

實例：

/**
 * 多數據源測試
 */
@SpringBootTest
class MultidbTest {
	@Autowired
	private OrderDao orderDao;// 對應數據源1
	@Autowired
	private ErpOrderDao erpOrderDao;// 對應數據源2

	/**
	 * 插入測試
	 */
	@Test
	void testInsert() {
		// 數據源1插入數據
		OrderDo order = new OrderDo();
		order.setCount(1L);
		order.setGoodsId(1L);
		int affectRows1 = orderDao.insert(order);
		// 數據源2插入數據
		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);
	}
}

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

5. 分布式事務

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

5.1 引入分布式事務依賴

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

實例：

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

5.2 更換數據源組件

需要將默認的數據源更換為支持分布式事務的數據源， MySQL 對應的數據源為 MysqlXADataSource ， SQL Server 對應的數據源為 SQLServerXADataSource 。

實例：

/**
 * 數據源配置類
 */
@Configuration // 標注為配置類
public class DataSourceConfig {
	// 注入數據源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;
	// 注入數據源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;

	/**
	 * 數據源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;

	}

	/**
	 * 數據源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 添加分布式事務管理器組件

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

實例：

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

5.4 測試分布式事務

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

實例：

	/**
	 * 插入測試
	 */
	@Test
	@Transactional // 開啟事務
	void testInsert() {
		// 數據源1插入數據
		OrderDo order = new OrderDo();
		order.setCount(1L);
		order.setGoodsId(1L);
		int affectRows1 = orderDao.insert(order);
		// 模擬拋出異常
		int a = 1 / 0;
		// 數據源2插入數據
		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);
	}

此時運行測試類，可以發(fā)現數據源 1 的事務已回滾，驗證成功！

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

6. 小結

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

• 配置多個數據源時，通過配置類，逐一配置數據源組件及其參數。
• 配置 MyBatis 時，手工配置 MyBatis 相關組件，并指定相應掃描的 DAO 類及映射文件。
• 使用分布式事務時，使用支持分布式事務的數據源組件，并配置分布式事務管理器。