SpringBoot入门建站全系列（三十一）atomikos实现多数据源的分布式事务

谁践踏了优雅 2023-06-08 03:30 12阅读 0赞

### SpringBoot入门建站全系列（三十一）atomikos实现多数据源的分布式事务 ###

### 一、概述 ###

多数据源，就是有多个数据库的配置。

多数据源配置并不麻烦，使用起来和单数据源基本相同，但是，重要的是事务的控制。

本篇使用atomikos做多数据源的分布式事务，基于Mysql的xa事务数据源，通过atomikos的事务管理器完成。并使用mybatis作为数据库中间件。

首发地址：  
[品茗IT-首发][IT-]

**如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以[加入我们的java学习圈，点击即可加入][java]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

### 二、配置 ###

本文假设你已经引入spring-boot-starter-web。已经是个SpringBoot项目了,如果不会搭建，可以打开这篇文章看一看[《SpringBoot入门建站全系列（一）项目建立》][SpringBoot]。

#### 2.1 Maven依赖 ####

引入mybatis、数据库连接池、mysql-connector和spring-boot-starter-jta-atomikos.

spring-boot-starter-jta-atomikos是实现jta分布式事务控制的一个工具。

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-jta-atomikos</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.mybatis.spring.boot</groupId>
    	<artifactId>mybatis-spring-boot-starter</artifactId>
    </dependency>
    <dependency>
    	<groupId>mysql</groupId>
    	<artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.apache.commons</groupId>
    	<artifactId>commons-dbcp2</artifactId>
    </dependency>

#### 2.2 配置文件 ####

在application.properties 中需要配置数据库相关信息的信息，如：

spring.jta.enabled=true
    
    spring.datasource.master.unique-resource-name=master
    spring.datasource.master.xa-data-source-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
    spring.datasource.master.min-pool-size=8
    spring.datasource.master.max-pool-size=20
    spring.datasource.master.xa-properties.URL=jdbc:mysql://127.0.0.1:3306/boot?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
    spring.datasource.master.xa-properties.user=cff
    spring.datasource.master.xa-properties.password=123456
    
    spring.datasource.slave.unique-resource-name=slave
    spring.datasource.slave.xa-data-source-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
    spring.datasource.slave.min-pool-size=8
    spring.datasource.slave.max-pool-size=20
    spring.datasource.slave.xa-properties.URL=jdbc:mysql://127.0.0.1:3306/cff?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
    spring.datasource.slave.xa-properties.user=cff
    spring.datasource.slave.xa-properties.password=123456
    
    mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

**注意，这里的配置：**

*  spring.jta.enabled是开启jta事务支持；
 *  spring.datasource.master开头的配置，是需要我手动配置master数据源的配置，使用atomikos的AtomikosDataSourceBean；
 *  spring.datasource.slave开头的配置，是需要我手动配置slave数据源的配置，使用atomikos的AtomikosDataSourceBean；
 *  master和slave只是个名字而已，根据自己需要修改任何名称都行，在config配置类中指明即可；
 *  mybatis.configuration.log-impl是mybatis自动装配的配置。

### 三、配置数据源 ###

配置多个数据源，需要DataSource、SqlSessionFactory；

atomikos的TransactionManager不需要对应到每个数据源，不配置即可。这一点对比下[《SpringBoot入门建站全系列（三十）Mybatis多数据源进行数据库操作》][SpringBoot_Mybatis] 一篇中的配置。

#### 3.1 Master数据源 ####

配置Master数据源，需要Master自己的DataSource、SqlSessionFactory。

同时，指定MapperScan扫描的包路径，和对应的sqlSessionFactory。

package com.cff.springbootwork.atomikos.config;
    
    import javax.sql.DataSource;
    
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.mybatis.spring.SqlSessionFactoryBean;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Primary;
    
    import com.atomikos.jdbc.AtomikosDataSourceBean;
    
    @Configuration
    @MapperScan(basePackages = MasterDataSourceConfiguration.PACKAGE, sqlSessionFactoryRef = "masterSqlSessionFactory")
    public class MasterDataSourceConfiguration { 
    	static final String PACKAGE = "com.cff.springbootwork.atomikos.dao.master";
    
    	@Bean(name = "masterDataSource")
    	@ConfigurationProperties(prefix = "spring.datasource.master")
    	@Primary
    	public DataSource masterDataSource() { 
    		return new AtomikosDataSourceBean();
    	}
    
    	@Bean(name = "masterSqlSessionFactory")
    	@Primary
    	public SqlSessionFactory masterSqlSessionFactory() throws Exception { 
    		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
    		sessionFactory.setDataSource(masterDataSource());
    		return sessionFactory.getObject();
    	}
    }

这里面，

*  新建了一个AtomikosDataSourceBean，bean名称加个master以做区分，AtomikosDataSourceBean的属性通过@ConfigurationProperties(prefix = “spring.datasource.master”)注入，同时，加上@Primary标明它是首选。
 *  @Primary注解只能加在某一个数据源上，不能所有数据源配置都加，不然会报错。
 *  新建了masterSqlSessionFactory，处理masterDataSource的SqlSession。

#### 3.2 Slave数据源 ####

配置Slave数据源，需要Slave自己的DataSource、SqlSessionFactory。

同时，指定MapperScan扫描的包路径，和对应的sqlSessionFactory。

package com.cff.springbootwork.atomikos.config;
    
    import javax.sql.DataSource;
    
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.mybatis.spring.SqlSessionFactoryBean;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import com.atomikos.jdbc.AtomikosDataSourceBean;
    
    @Configuration
    @MapperScan(basePackages = SlaveDataSourceConfiguration.PACKAGE, sqlSessionFactoryRef = "slaveSqlSessionFactory")
    public class SlaveDataSourceConfiguration { 
    	static final String PACKAGE = "com.cff.springbootwork.atomikos.dao.slave";
    
    	@Bean(name = "slaveDataSource")
    	@ConfigurationProperties(prefix = "spring.datasource.slave")
    	public DataSource slaveDataSource() { 
    		return new AtomikosDataSourceBean();
    	}
    
    	@Bean(name = "slaveSqlSessionFactory")
    	public SqlSessionFactory slaveSqlSessionFactory() throws Exception { 
    		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
    		sessionFactory.setDataSource(slaveDataSource());
    		return sessionFactory.getObject();
    	}
    }

这里面，

*  新建了一个AtomikosDataSourceBean，bean名称加个slave以做区分，AtomikosDataSourceBean的属性通过@ConfigurationProperties(prefix = “spring.datasource.slave”)注入，注意，这个地方不能加上@Primary注解。
 *  新建了slaveSqlSessionFactory，处理slaveDataSource的SqlSession。

### 四、测试Mapper ###

Mapper的写法无任何改变，只不过，要注意不同mapper放在上面不同数据源指定的包路径下。

#### 4.1 Master数据源的Mapper ####

新建一个UserInfoMasterDao，处理master数据源的用户表。

UserInfoMasterDao：

package com.cff.springbootwork.atomikos.dao.master;
    
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    import org.apache.ibatis.annotations.Update;
    
    import com.cff.springbootwork.atomikos.domain.UserInfo;
    
    @Mapper
    public interface UserInfoMasterDao { 
    	@Select({ 
    		"<script>",
    	        "SELECT ",
    	        "user_name as userName,passwd,name,mobile,valid, user_type as userType",
    	        "FROM user_info",
    	        "WHERE user_name = #{userName,jdbcType=VARCHAR}",
    	   "</script>"})
    	UserInfo findByUserName(@Param("userName") String userName);
    	
    	@Update({ 
            "<script>",
            " update user_info set",
            " name = #{name, jdbcType=VARCHAR}, mobile = #{mobile, jdbcType=VARCHAR}",
            " where user_name=#{userName}",
            "</script>"
        })
        int update(UserInfo userInfo);
    }

#### 4.2 Slave数据源的Mapper ####

新建一个UserInfoSlaveDao，处理Slave数据源的用户表。

UserInfoSlaveDao：

package com.cff.springbootwork.atomikos.dao.slave;
    
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    import org.apache.ibatis.annotations.Update;
    
    import com.cff.springbootwork.atomikos.domain.UserInfo;
    
    @Mapper
    public interface UserInfoSlaveDao { 
    	@Select({ 
    		"<script>",
    	        "SELECT ",
    	        "user_name as userName,passwd,name,mobile,valid, user_type as userType",
    	        "FROM user_info",
    	        "WHERE user_name = #{userName,jdbcType=VARCHAR}",
    	   "</script>"})
    	UserInfo findByUserName(@Param("userName") String userName);
    	
    	@Update({ 
            "<script>",
            " update user_info set",
            " name = #{name, jdbcType=VARCHAR}, mobile = #{mobile, jdbcType=VARCHAR}",
            " where user_name=#{userName}",
            "</script>"
        })
        int update(UserInfo userInfo);
    }

### 五、测试Service ###

写一个普通的UserInfoService，注入两个mapper即可使用。

UserInfoService:

package com.cff.springbootwork.atomikos.service;
    
    import java.util.ArrayList;
    import java.util.List;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    import org.springframework.transaction.annotation.Transactional;
    
    import com.cff.springbootwork.atomikos.dao.master.UserInfoMasterDao;
    import com.cff.springbootwork.atomikos.dao.slave.UserInfoSlaveDao;
    import com.cff.springbootwork.atomikos.domain.UserInfo;
    
    @Service
    public class UserInfoService { 
    	@Autowired
    	UserInfoMasterDao userInfoMasterDao;
    
    	@Autowired
    	UserInfoSlaveDao userInfoSlaveDao;
    
    	public List<UserInfo> getUserInfoByUserName(String userName) { 
    		UserInfo userInfoMaster = userInfoMasterDao.findByUserName(userName);
    		UserInfo userInfoSlave = userInfoSlaveDao.findByUserName(userName);
    
    		List<UserInfo> list = new ArrayList<>();
    		list.add(userInfoMaster);
    		list.add(userInfoSlave);
    		return list;
    	}
    
    	@Transactional(rollbackFor = Exception.class)
    	public List<UserInfo> update(UserInfo userInfo) { 
    		userInfoMasterDao.update(userInfo);
    		userInfoSlaveDao.update(userInfo);
    		int i = 1 / 0;
    		return getUserInfoByUserName(userInfo.getUserName());
    	}
    }

注意，我这里的update方法中，写了一个`int i = 1 / 0;`,是为了测试无分布式事务支持的时候事务是如何处理的。

### 六、测试Web ###

package com.cff.springbootwork.atomikos.web;
    
    import java.util.List;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.cff.springbootwork.atomikos.domain.UserInfo;
    import com.cff.springbootwork.atomikos.service.UserInfoService;
    
    @RestController
    @RequestMapping("/mybatis")
    public class MybatisRest { 
    
    	@Autowired
    	UserInfoService userInfoService;
    
    	@RequestMapping(value = "/mybatis/{name}", method = {  RequestMethod.GET })
    	public List<UserInfo> testMybatis(@PathVariable("name") String name) { 
    		return userInfoService.getUserInfoByUserName(name);
    	}
    	
    	@RequestMapping(value = "/update")
    	public List<UserInfo> update(@RequestBody UserInfo userInfo) { 
    		return userInfoService.update(userInfo);
    	}
    }

### 七、实体 ###

UserInfo:

完整实体，请访问[《SpringBoot入门建站全系列（三十）Mybatis多数据源进行数据库操作》][SpringBoot_Mybatis]查看。

### 八、结论 ###

*  多数据源的使用和普通使用方法完全一样，只不过要多配置一下。
 *  多数据源的事务的分布式事务控制只是改变了数据源的实现而已，和多数据源的配置没有多大区别。
 *  多数据源事务管理器只能是一个，不能每个数据源一个，这个实现可以由Springboot自动配置；
 *  当update失败时，Atomikos可以轻松实现多数据源的数据回滚。

[品茗IT-博客专题:https://www.pomit.cn/lecture.html][IT-_https_www.pomit.cn_lecture.html]汇总了[Spring专题][Spring]、[Springboot专题][Springboot]、[SpringCloud专题][SpringCloud]、[web基础配置][web]专题。

### 快速构建项目 ###

Spring项目快速开发工具：

[一键快速构建Spring项目工具][Spring 1]

[一键快速构建SpringBoot项目工具][SpringBoot 1]

[一键快速构建SpringCloud项目工具][SpringCloud 1]

[一站式Springboot项目生成][Springboot 1]

[Mysql一键生成Mybatis注解Mapper][Mysql_Mybatis_Mapper]

[Spring组件化构建][Spring 1]

[SpringBoot组件化构建][SpringBoot 1]

[SpringCloud服务化构建][SpringCloud 1]

喜欢这篇文章么，喜欢就加入我们一起讨论SpringBoot使用吧！  
![品茗IT交流群][IT]

[IT-]: https://www.pomit.cn/p/2312431011432961
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[SpringBoot]: https://www.pomit.cn/p/169774771175680
[SpringBoot_Mybatis]: https://www.pomit.cn/p/2294759473523201
[IT-_https_www.pomit.cn_lecture.html]: https://www.pomit.cn/lecture.html
[Spring]: https://www.pomit.cn/lecture/springunion.html
[Springboot]: https://www.pomit.cn/lecture/springbootfull.html
[SpringCloud]: https://www.pomit.cn/lecture/springcloudfull.html
[web]: https://www.pomit.cn/lecture/webbasics.html
[Spring 1]: https://www.pomit.cn/java/spring/spring.html
[SpringBoot 1]: https://www.pomit.cn/java/spring/springboot.html
[SpringCloud 1]: https://www.pomit.cn/java/spring/springcloud.html
[Springboot 1]: https://www.pomit.cn/java/java/sqlToSpringboot.html
[Mysql_Mybatis_Mapper]: https://www.pomit.cn/java/java/sqlToMybatis.html
[IT]: /images/20230531/5284e880e48e46dbb97be1620e867494.png