springboot整合多數據源以及多數據源中的事務處理

前言

本篇文章主要介紹的是springboot整合多數據源以及多數據源事務處理。
多數據源就是在同一個項目中連接多個數據庫，使用多個數據庫可能是由於業務量擴大進行數據庫拆分，也可能是根據項目實際情況需要連接多個數據庫。比如我之前有個項目，需要訪問一個已有的數據庫進行查詢操作，但不能修改，還需要新建數據庫表進行其他的業務處理，這時就需要使用多數據源。

GitHub源碼鏈接位於文章底部。

創建數據庫

創建member數據庫，添加一張user表，字段為id主鍵自增，name，age；
創建order數據庫，添加一張order表，字段為id主鍵自增，number；

工程結構

先來看一下工程結構，這里的demo使用會員數據庫和訂單數據庫，建立member和order相關包和類。

引入依賴

在pom文件中引入依賴，這里持久層框架使用的是mybatis，數據庫引擎是mysql。不過oracle也適用。

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- MySQL 連接驅動依賴 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.39</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
    </dependencies>

yml配置

在application.yml中進行數據源配置

server:
  port: 8080
spring:
  datasource:
    member:
      jdbc-url: jdbc:mysql://localhost:3306/member?useUnicode=true&characterEncoding=utf-8
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver
    order:
      jdbc-url: jdbc:mysql://localhost:3306/order?useUnicode=true&characterEncoding=utf-8
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver

這里數據源的url的key是'jdbc-url',在多數據源的情況下，使用'url'作為key會報錯，這是它本身的一個bug。

數據源配置類

在config目錄中創建member文件夾，在member文件夾中創建MemberDatasourceConfig進行數據源配置。

@Configuration
@MapperScan(value = "com.lxg.mapper.member",sqlSessionTemplateRef = "memberSqlSessionTemplate")
public class MemberDatasourceConfig {
    /**
     * 創建DataSource
     * @return
     */
    @Bean("memberDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.member")
    public DataSource memberDataSource(){
        return DataSourceBuilder.create().build();
    }

    /**
     * 創建sqlSessionFactory
     * @param dataSource
     * @return
     * @throws Exception
     */
    @Bean(name = "memberSqlSessionFactory")
    public SqlSessionFactory memberSqlSessionFactory(@Qualifier("memberDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean.getObject();
    }

    /**
     * 創建事務管理器
     * @param dataSource
     * @return
     */
    @Bean(name = "memberTransactionManager")
    public DataSourceTransactionManager memberTransactionManager(@Qualifier("memberDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    /**
     * 創建sqlSession模板
     * @param sqlSessionFactory
     * @return
     */
    @Bean(name = "memberSqlSessionTemplate")
    public SqlSessionTemplate memberSqlSessionTemplate(@Qualifier("memberSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

在config目錄中創建order文件夾，在order文件夾中創建OrderDatasourceConfig進行數據源配置。

@Configuration
@MapperScan(value = "com.lxg.mapper.order",sqlSessionTemplateRef = "orderSqlSessionTemplate")
public class OrderDatasourceConfig {
    /**
     * 創建DataSource
     * @return
     */
    @Bean("orderDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.order")
    public DataSource orderDataSource(){
        return DataSourceBuilder.create().build();
    }

    /**
     * 創建sqlSessionFactory
     * @param dataSource
     * @return
     * @throws Exception
     */
    @Bean(name = "orderSqlSessionFactory")
    public SqlSessionFactory orderSqlSessionFactory(@Qualifier("orderDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean.getObject();
    }

    /**
     * 創建事務管理器
     * @param dataSource
     * @return
     */
    @Bean(name = "orderTransactionManager")
    public DataSourceTransactionManager orderTransactionManager(@Qualifier("orderDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    /**
     * 創建sqlSession模板
     * @param sqlSessionFactory
     * @return
     */
    @Bean(name = "orderSqlSessionTemplate")
    public SqlSessionTemplate orderSqlSessionTemplate(@Qualifier("orderSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

SpringBoot2.0以前需要在方法上加Primary注解，來判斷默認的數據庫連接。
Configuration注解定義當前類為配置類，相當於xml,配合Bean注解將方法注入到spring容器中。
MapperScan注解定義了持久層的掃包范圍，並且指定這個包配置的是哪個數據源。
ConfigurationProperties注解是springboot的注解，它指定了使用application.yml文件中哪個數據源的配置。

Mapper層

在mapper目錄下創建member文件夾，在member文件夾中創建MemberMapper.java,添加一條插入語句。

@Repository
public interface MemberMapper {
    /**
     * 添加會員
     * @param name 姓名
     * @param age 年齡
     * @return
     */
    @Insert("insert into user values(null,#{name},#{age});")
    public int addUser(@Param("name") String name, @Param("age") Integer age);
}

在mapper目錄下創建order文件夾，在order文件夾中創建MemberMapper.java,添加一條插入語句。

@Repository
public interface OrderMapper {
    /**
     * 添加訂單
     * @param number 數量
     * @return
     */
    @Insert("insert into `order` values(null,#{number});")
    public int addOrder(@Param("number") Integer number);
}

這里的order表名因為是數據庫關鍵字，需要使用``符號，（英文輸入法下鍵盤上tab鍵上面那個按）鍵進行引用，否則會報錯。

controller層

在controller層中新建MultiDatasourceController

@RestController
public class MultiDatasourceController {
    @Autowired
    private MemberMapper memberMapper;
    @Autowired
    private OrderMapper orderMapper;


    /**
     * 調用member數據庫
     * @param name
     * @param age
     * @return
     */
    @Transactional(rollbackFor = Exception.class,transactionManager = "memberTransactionManager")
    @RequestMapping("/addUser")
    public String addUser(String name, Integer age)  {
        return memberMapper.addUser(name, age)>0?"success":"fail";
    }

    /**
     * 調用order數據庫
     * @param number
     * @return
     */
    @Transactional(rollbackFor = Exception.class,transactionManager = "orderTransactionManager")
    @RequestMapping("/addOrder")
    public String addOrder(Integer number) {
        int i = 10 / number;
        return orderMapper.addOrder(number)>0?"success":"fail";
    }
}

方法上添加Transactional注解，進行事務管理，指定事務管理器，就是我們之前在config中配置的。
這樣的話比如addOrder中，如果輸入的參數number為0，就會失敗回滾。
在瀏覽器中分別訪問這兩個接口，就可以看到兩個數據庫中的分別插入數據了。
order數據庫


member數據庫

多數據源事務處理

但是上面這種事務處理還是單數據源的處理方式，如果兩個數據源在同一個事務中時，就無法完全回滾了。

    @Transactional(rollbackFor = Exception.class,transactionManager = "orderTransactionManager")
    @RequestMapping("/addOrderAndMember")
    public String addOrderAndMember(String name, Integer age,Integer number) {
        int i = memberMapper.addUser(name, age);
        int j = orderMapper.addOrder(number);
        int x = 10 / number;
        return j >0?"success":"fail";
    }

比如這一段代碼，因為指定的事務管理器是orderTransactionManager，所以 即使number為0的時候，memberMapper.addUser(name, age);這一段數據庫操作是不會回滾的。
這里需要使用jta-atomikos進行事務管理。
pom中引入jta-atomikos依賴：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-jta-atomikos</artifactId>
</dependency>

修改application.yml文件，添加一些配置，注意，這里的數據庫地址的key是'url',不然會報空指針。

server:
  port: 8080
spring:
  datasource:
    member:
      url: jdbc:mysql://localhost:3306/member?useUnicode=true&characterEncoding=utf-8
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver
      borrowConnectionTimeout: 30
      loginTimeout: 30
      maintenanceInterval: 60
      maxIdleTime: 60
      maxLifetime: 20000
      maxPoolSize: 25
      minPoolSize: 3
      uniqueResourceName: memberDataSource
    order:
      url: jdbc:mysql://localhost:3306/order?useUnicode=true&characterEncoding=utf-8
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver
      borrowConnectionTimeout: 30
      loginTimeout: 30
      maintenanceInterval: 60
      maxIdleTime: 60
      maxLifetime: 20000
      maxPoolSize: 25
      minPoolSize: 3
      uniqueResourceName: orderDataSource

在config/member中添加MemberConfig配置類，屬性與yml中的數據源配置是一致的

@Data
@ConfigurationProperties(prefix = "spring.datasource.member")
public class MemberConfig {
    private String url;
    private String username;
    private String password;
    private int minPoolSize;
    private int maxPoolSize;
    private int maxLifetime;
    private int borrowConnectionTimeout;
    private int loginTimeout;
    private int maintenanceInterval;
    private int maxIdleTime;
    private String testQuery;
    private String uniqueResourceName;
}

在config/order中添加OrderConfig配置類，屬性與yml中的數據源配置是一致的

@Data
@ConfigurationProperties(prefix = "spring.datasource.order")
public class OrderConfig {
    private String url;
    private String username;
    private String password;
    private int minPoolSize;
    private int maxPoolSize;
    private int maxLifetime;
    private int borrowConnectionTimeout;
    private int loginTimeout;
    private int maintenanceInterval;
    private int maxIdleTime;
    private String testQuery;
    private String uniqueResourceName;
}

Data注解提供get/set方法。
ConfigurationProperties注解負責解析對應屬性在yml文件的前綴。

修改創建memberDataSource的方法，這里memberConfig可能會報紅無法注入，先不用管，之后在啟動類上加上一個注解即可消除，文章稍后會講到。可以看到，這里的ConfigurationProperties注解被刪除了，因為被移到MemberConfig里了。

    @Bean("memberDataSource")
    public DataSource memberDataSource(MemberConfig memberConfig) throws SQLException {
        System.out.println(memberConfig);
        MysqlXADataSource mysqlXaDataSource = new MysqlXADataSource();
        mysqlXaDataSource.setUrl(memberConfig.getUrl());
        mysqlXaDataSource.setPinGlobalTxToPhysicalConnection(true);
        mysqlXaDataSource.setPassword(memberConfig.getPassword());
        mysqlXaDataSource.setUser(memberConfig.getUsername());
        mysqlXaDataSource.setPinGlobalTxToPhysicalConnection(true);
        //注冊到全局事務
        AtomikosDataSourceBean xaDataSource = new AtomikosDataSourceBean();
        xaDataSource.setXaDataSource(mysqlXaDataSource);
        xaDataSource.setUniqueResourceName(memberConfig.getUniqueResourceName());
        xaDataSource.setMinPoolSize(memberConfig.getMinPoolSize());
        xaDataSource.setMaxPoolSize(memberConfig.getMaxPoolSize());
        xaDataSource.setMaxLifetime(memberConfig.getMaxLifetime());
        xaDataSource.setBorrowConnectionTimeout(memberConfig.getBorrowConnectionTimeout());
        xaDataSource.setLoginTimeout(memberConfig.getLoginTimeout());
        xaDataSource.setMaintenanceInterval(memberConfig.getMaintenanceInterval());
        xaDataSource.setMaxIdleTime(memberConfig.getMaxIdleTime());
        xaDataSource.setTestQuery(memberConfig.getTestQuery());
        return xaDataSource;
    }

之后刪除或者注釋掉該類中的事務管理器，也就是下面這一段代碼:

    /**
     * 創建事務管理器
     * @param dataSource
     * @return
     */
    @Bean(name = "memberTransactionManager")
    public DataSourceTransactionManager memberTransactionManager(@Qualifier("memberDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

修改創建orderDataSource的方法，這里orderConfig可能會報紅無法注入，先不用管，之后在啟動類上加上一個注解即可消除，文章稍后會講到。可以看到，這里的ConfigurationProperties注解被刪除了，因為被移到OrderConfig里了。

@Bean("orderDataSource")
    public DataSource orderDataSource(OrderConfig orderConfig) throws SQLException {
        System.out.println(orderConfig);
        MysqlXADataSource mysqlXaDataSource = new MysqlXADataSource();
        mysqlXaDataSource.setUrl(orderConfig.getUrl());
        mysqlXaDataSource.setPinGlobalTxToPhysicalConnection(true);
        mysqlXaDataSource.setPassword(orderConfig.getPassword());
        mysqlXaDataSource.setUser(orderConfig.getUsername());
        mysqlXaDataSource.setPinGlobalTxToPhysicalConnection(true);

        //注冊到全局事務
        AtomikosDataSourceBean xaDataSource = new AtomikosDataSourceBean();
        xaDataSource.setXaDataSource(mysqlXaDataSource);
        xaDataSource.setUniqueResourceName(orderConfig.getUniqueResourceName());
        xaDataSource.setMinPoolSize(orderConfig.getMinPoolSize());
        xaDataSource.setMaxPoolSize(orderConfig.getMaxPoolSize());
        xaDataSource.setMaxLifetime(orderConfig.getMaxLifetime());
        xaDataSource.setBorrowConnectionTimeout(orderConfig.getBorrowConnectionTimeout());
        xaDataSource.setLoginTimeout(orderConfig.getLoginTimeout());
        xaDataSource.setMaintenanceInterval(orderConfig.getMaintenanceInterval());
        xaDataSource.setMaxIdleTime(orderConfig.getMaxIdleTime());
        xaDataSource.setTestQuery(orderConfig.getTestQuery());
        return xaDataSource;
    }

之后刪除或者注釋掉該類中的事務管理器，也就是下面這一段代碼:

   /**
     * 創建事務管理器
     * @param dataSource
     * @return
     */
    @Bean(name = "orderTransactionManager")
    public DataSourceTransactionManager orderTransactionManager(@Qualifier("orderDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

Transactional注解的transactionManager屬性需要刪除，因為不需要指定事務管理器了，統一為xa事務管理器。

在啟動類中添加EnableConfigurationProperties注解，解決之前提到的配置類報紅顯示無法注入的問題。

@SpringBootApplication
@EnableConfigurationProperties({MemberConfig.class, OrderConfig.class})
public class MultiDatasourceApplication {
    public static void main(String[] args) {
        SpringApplication.run(MultiDatasourceApplication.class);
    }
}

此時調用這個接口，如果number為0，報了異常，兩個添加方法都會回滾了。

    @Transactional(rollbackFor = Exception.class )
    @RequestMapping("/addOrderAndMember")
    public String addOrderAndMember(String name, Integer age,Integer number) {
        int i = memberMapper.addUser(name, age);
        int j = orderMapper.addOrder(number);
        int x = 10 / number;
        return j >0?"success":"fail";
    }

注意：
如果這里的整合了mybatis-plus，需要修改sqlSessionFactory為mybatis-plus的MybatisSqlSessionFactoryBean。並且整合多數據源后，mybatis-plus的分頁會出現問題，mybatis-plus的TableLogic邏輯刪除注解也會出現問題，需要重新加載分頁插件和邏輯刪除插件，即MemberDatasourceConfig和OrderDatasourceConfig中的sqlSessionFactory應該修改為

    /**
     * 創建sqlSessionFactory
     * @param dataSource
     * @return
     * @throws Exception
     */
    @Bean(name = "memberSqlSessionFactory")
    public SqlSessionFactory memberSqlSessionFactory(@Qualifier("memberDataSource") DataSource dataSource) throws Exception {
		//邏輯刪除 如果值為1,表示已經刪除,如果為0,表示未刪除
        GlobalConfiguration globalConfig = new GlobalConfiguration();
        globalConfig.setLogicDeleteValue("1");
        globalConfig.setLogicNotDeleteValue("0");
        globalConfig.setSqlInjector(new LogicSqlInjector());
        //分頁插件
        MybatisConfiguration configuration = new MybatisConfiguration();
        configuration.addInterceptor(new PaginationInterceptor());

        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        sqlSessionFactoryBean.setConfiguration(configuration);
        sqlSessionFactoryBean.setGlobalConfig(globalConfig);
        return sqlSessionFactoryBean.getObject();
    }

如果任使用mybatis的SqlSessionFactoryBean，當調用BaseMapper的方法時，會報Invalid bound statement (not found)異常。

設置日志文件目錄

在yml文件中添加配置

spring: 
	jta:
    	log-dir: /logs

本文GitHub源碼：https://github.com/lixianguo5097/springboot/tree/master/springboot-multiDatasource

CSDN：https://blog.csdn.net/qq_27682773
簡書：https://www.jianshu.com/u/e99381e6886e
博客園：https://www.cnblogs.com/lixianguo
個人博客：https://www.lxgblog.com