SpringBoot整合Mybatis實現(xiàn)多數(shù)據(jù)源配置與跨數(shù)據(jù)源事務實例

更新時間：2022年11月28日 14:37:22 作者：喜羊羊sk

開發(fā)中經(jīng)常有這樣的需要: 讀寫分離。微服務環(huán)境下可以實現(xiàn)一個服務讀取一個數(shù)據(jù)庫，另一個服務寫庫。但是在實際應用中有時也需要在一個服務中讀寫不同的數(shù)據(jù)庫。可以在一個SpringBoot單體項目中配置多個數(shù)據(jù)源解決讀寫庫分離

Pom依賴

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.2.RELEASE</version>
    <relativePath/>
</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-starter</artifactId>
        <version>1.2.14</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.2</version>
    </dependency>
    <!--   分頁插件     -->
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper-spring-boot-starter</artifactId>
        <version>1.3.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
</dependencies>

application.yml

# 數(shù)據(jù)源
spring:
datasource:
# master主數(shù)據(jù)源配置
master:
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/ds1?characterEncoding=UTF-8&serverTimezone=GMT%2B8
username: root
password: root
# cluster從數(shù)據(jù)源配置
cluster:
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/ds2?characterEncoding=UTF-8&serverTimezone=GMT%2B8
username: root
password: root
#pagehelper分頁插件配置
pagehelper:
master:
helper-dialect: mysql #設置數(shù)據(jù)庫類型
reasonable: true #開啟合理化：頁碼<=0 查詢第一頁，頁碼>=總頁數(shù)查詢最后一頁
support-methods-arguments: true #支持通過 Mapper 接口參數(shù)來傳遞分頁參數(shù)
params: count=countsql

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

Java代碼方式創(chuàng)建主從數(shù)據(jù)源配置。使用@Primary: 用于指定bean的注入優(yōu)先級。被@Primary修飾的bean對象優(yōu)先注入

MasterDataSourceConfig

/**
 * @ClassName: MasterDataSourceConfig
 * @Description: mysql主庫配置類
 */
@Configuration
@MapperScan(basePackages = MasterDataSourceConfig.PACKAGE,sqlSessionTemplateRef = "masterSqlSessionTemplate")
public class MasterDataSourceConfig {
    /**
     * 設置掃描包的路徑
     */
    public static final String PACKAGE = "cn.zysheep.dao.master";
    /**
     * Mapper配置文件路徑
     */
    public static final String MAPPER_LOCATION = "classpath*:mapper/master/*.xml";
    /**
     * 實體別名
     */
    public static final String ENTITY_ALIASES = "cn.zysheep.entity";
    @Value("${spring.datasource.master.driverClassName}")
    private String driverClassName;
    @Value("${spring.datasource.master.url}")
    private String url;
    @Value("${spring.datasource.master.username}")
    private String user;
    @Value("${spring.datasource.master.password}")
    private String password;
    @Value("${pagehelper.master.helper-dialect}")
    private String helperDialect;
    @Value("${pagehelper.master.reasonable}")
    private String reasonable;
    /**
     * 創(chuàng)建數(shù)據(jù)源
     * @return DataSource
     * @Primary: 用于指定bean的注入優(yōu)先級。被@Primary修飾的bean對象優(yōu)先注入
     */
    @Bean(name = "masterDataSource")
    @Primary
    public DataSource masterDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(user);
        dataSource.setPassword(password);
        return dataSource;
    }
    /**
     * 創(chuàng)建工廠
     *@param dataSource
     *@throws Exception
     *@return SqlSessionFactory
     */
    @Bean(name = "masterSqlSessionFactory")
    @Primary
    public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(MAPPER_LOCATION));
        sessionFactory.setTypeAliasesPackage(ENTITY_ALIASES);
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        // 字段值為空也可以插入
        configuration.setJdbcTypeForNull(JdbcType.NULL);
        configuration.setCallSettersOnNulls(true);
        // mybatis log
        configuration.setLogImpl(StdOutImpl.class);
        sessionFactory.setConfiguration(configuration);
        PageInterceptor pageInterceptor = new PageInterceptor();
        // 分頁配置
        Properties p = new Properties();
        p.setProperty("helperDialect", helperDialect);
        p.setProperty("reasonable", reasonable);
        pageInterceptor.setProperties(p);
        sessionFactory.setPlugins(pageInterceptor);
        return sessionFactory.getObject();
    }
    /**
     * 創(chuàng)建事務
     *@param dataSource
     *@return DataSourceTransactionManager
     */
    @Bean(name = "masterTransactionManager")
    @Primary
    public DataSourceTransactionManager masterDataSourceTransactionManager(@Qualifier("masterDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
    /**
     * 創(chuàng)建模板
     *@param sqlSessionFactory
     *@return SqlSessionTemplate
     */
    @Bean(name = "masterSqlSessionTemplate")
    @Primary
    public SqlSessionTemplate masterSqlSessionTemplate(@Qualifier("masterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

ClusterDataSourceConfig

/**
 * @ClassName: DataSourceConfig
 * @Description: mysql從庫配置類
 */
@Configuration
@MapperScan(basePackages = ClusterDataSourceConfig.PACKAGE,sqlSessionTemplateRef = "clusterSqlSessionTemplate")
public class ClusterDataSourceConfig {
    /**
     * 設置掃描包的路徑
     */
    public static final String PACKAGE = "cn.zysheep.dao.cluster";
    /**
     * Mapper配置文件路徑
     */
    public static final String MAPPER_LOCATION = "classpath*:mapper/cluster/*.xml";
    /**
     * 實體別名
     */
    public static final String ENTITY_ALIASES = "cn.zysheep.entity";
    @Value("${spring.datasource.cluster.driverClassName}")
    private String driverClassName;
    @Value("${spring.datasource.cluster.url}")
    private String url;
    @Value("${spring.datasource.cluster.username}")
    private String user;
    @Value("${spring.datasource.cluster.password}")
    private String password;
    @Value("${pagehelper.master.helper-dialect}")
    private String helperDialect;
    @Value("${pagehelper.master.reasonable}")
    private String reasonable;
    /**
     * 創(chuàng)建數(shù)據(jù)源
     *@return DataSource
     */
    @Bean(name = "clusterDataSource")
    public DataSource masterDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(user);
        dataSource.setPassword(password);
        return dataSource;
    }
    /**
     * 創(chuàng)建工廠
     *@param dataSource
     *@throws Exception
     *@return SqlSessionFactory
     */
    @Bean(name = "clusterSqlSessionFactory")
    public SqlSessionFactory masterSqlSessionFactory(@Qualifier("clusterDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(MAPPER_LOCATION));
        sessionFactory.setTypeAliasesPackage(ENTITY_ALIASES);
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        // 字段值為空也可以插入
        configuration.setJdbcTypeForNull(JdbcType.NULL);
        configuration.setCallSettersOnNulls(true);
        // mybatis log
        configuration.setLogImpl(StdOutImpl.class);
        sessionFactory.setConfiguration(configuration);
        PageInterceptor pageInterceptor = new PageInterceptor();
        // 分頁配置
        Properties p = new Properties();
        p.setProperty("helperDialect", helperDialect);
        p.setProperty("reasonable", reasonable);
        pageInterceptor.setProperties(p);
        sessionFactory.setPlugins(pageInterceptor);
        return sessionFactory.getObject();
    }
    /**
     * 創(chuàng)建事務管理器
     *@param dataSource
     *@return DataSourceTransactionManager
     */
    @Bean(name = "clusterTransactionManager")
    public DataSourceTransactionManager masterDataSourceTransactionManager(@Qualifier("clusterDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
    /**
     * 創(chuàng)建模板
     *@param sqlSessionFactory
     *@return SqlSessionTemplate
     */
    @Bean(name = "clusterSqlSessionTemplate")
    public SqlSessionTemplate masterSqlSessionTemplate(@Qualifier("clusterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

啟動類

啟動類添加@EnableTransactionManagement注解，開啟注解事務

@EnableTransactionManagement
@SpringBootApplication(exclude = PageHelperAutoConfiguration.class)
public class MultiDataSourceApplication {
    public static void main(String[] args) {
        SpringApplication.run(MultiDataSourceApplication.class, args);
    }
}

使用

在service層類或者方法上添加@Transactional注解。并指定屬性事務管理器transactionManager的值，根據(jù)使用不同的數(shù)據(jù)源，選擇不同的數(shù)據(jù)事務管理器

@Transactional(transactionManager = "masterTransactionManager")
public void insertUser() {
    // TODO 添加用戶業(yè)務操作
}
@Transactional(transactionManager = "clusterTransactionManager")
public void listUser() {
    // TODO 查詢用戶業(yè)務操作
}

思考: @Transactional只能指定一個事務管理器，并且注解不允許重復，所以就只能使用一個數(shù)據(jù)源的事務管理器了。那么對于一個方法涉及到多個數(shù)據(jù)源操作需要保證事務一致性的怎么辦呢？

實現(xiàn)跨數(shù)據(jù)源事務

基于注解+AOP使用編程式事務的方式實現(xiàn)跨數(shù)據(jù)源事務

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MultiDataSourceTransactional {
    /**
     * 事務管理器數(shù)組
     */
    String[] transactionManagers();
}

首先多個數(shù)據(jù)源的事務分別都開起來，然后各事務分別去執(zhí)行對應的sql（此所謂第一階段提交），最后如果都成功就把事務全部提交，只要有一個失敗就把事務都回滾——此所謂第二階段提交。

/**
 * 需要注意的點：
 * 1）聲明事務和提交事務或者回滾事務的順序應該相反的，就是先進后出，所以采用了棧來存儲。
 * 2）線程執(zhí)行結(jié)束后記得清空本地變量。
 * 3）可以參照@Transactional的那些屬性升級功能，比如隔離級別回滾異常等。
 */
@Component
@Aspect
public class MultiTransactionAop {
    /**
     * 線程本地變量：為什么使用棧？※為了達到后進先出的效果※
     */
    private static final ThreadLocal<Stack<Map<DataSourceTransactionManager, TransactionStatus>>> THREAD_LOCAL = new ThreadLocal<>();
    private static Logger logger = LoggerFactory.getLogger(MultiTransactionAop.class);
    /**
     * 用于獲取事務管理器
     */
    @Autowired
    private ApplicationContext applicationContext;
    /**
     * 事務聲明
     */
    private DefaultTransactionDefinition def = new DefaultTransactionDefinition();
    {
        // 非只讀模式
        def.setReadOnly(false);
        // 事務隔離級別：采用數(shù)據(jù)庫的
        def.setIsolationLevel(TransactionDefinition.ISOLATION_DEFAULT);
        // 事務傳播行為
        def.setPropagationBehavior(TransactionDefinition.PROPAGATION_REQUIRED);
    }
    /**
     * 切點
     */
    @Pointcut("@annotation(cn.zysheep.datasource.anntation.MultiDataSourceTransactional)")
    public void pointcut() {
    }
    /**
     * 聲明事務
     *
     * @param transactional 注解
     */
    @Before("pointcut() && @annotation(transactional)")
    public void before(MultiDataSourceTransactional transactional) {
        // 根據(jù)設置的事務名稱按順序聲明，并放到ThreadLocal里
        String[] transactionManagerNames = transactional.transactionManagers();
        Stack<Map<DataSourceTransactionManager, TransactionStatus>> pairStack = new Stack<>();
        for (String transactionManagerName : transactionManagerNames) {
            DataSourceTransactionManager transactionManager = applicationContext.getBean(transactionManagerName, DataSourceTransactionManager.class);
            TransactionStatus transactionStatus = transactionManager.getTransaction(def);
            Map<DataSourceTransactionManager, TransactionStatus> transactionMap = new HashMap<>();
            transactionMap.put(transactionManager, transactionStatus);
            pairStack.push(transactionMap);
        }
        THREAD_LOCAL.set(pairStack);
    }
    /**
     * 后置增強，相當于AfterReturningAdvice，方法退出時執(zhí)行
     *
     * 提交事務
     */
    @AfterReturning("pointcut()")
    public void afterReturning() {
        // ※棧頂彈出（后進先出）
        Stack<Map<DataSourceTransactionManager, TransactionStatus>> pairStack = THREAD_LOCAL.get();
        while (!pairStack.empty()) {
            Map<DataSourceTransactionManager, TransactionStatus> pair = pairStack.pop();
            pair.forEach((key,value)->key.commit(value));
        }
        THREAD_LOCAL.remove();
    }
    /**
     * 異常拋出增強，相當于ThrowsAdvice
     *
     * 回滾事務
     */
    @AfterThrowing(value = "pointcut()")
    public void afterThrowing() {
        // ※棧頂彈出（后進先出）
        Stack<Map<DataSourceTransactionManager, TransactionStatus>> pairStack = THREAD_LOCAL.get();
        logger.info("=========================");
        logger.info("Pair Stack:{}", pairStack);
        logger.info("=========================");
        while (!pairStack.empty()) {
            Map<DataSourceTransactionManager, TransactionStatus> pair = pairStack.pop();
            pair.forEach((key,value)->key.rollback(value));
        }
        THREAD_LOCAL.remove();
    }
}

在事務的方法上添加前面我們的多數(shù)據(jù)源事務注解

 /**
     * 測試多數(shù)據(jù)源事務
     */
    @MultiDataSourceTransactional(transactionManagers = {"masterTransactionManager", "clusterTransactionManager"})
    @Override
    public void saveUser() {
        String rid = UUID.randomUUID().toString();
        User user = new User();
        user.setId(rid);
        userMapper.saveUser(user);
        Log log = new Log();
        log.setId(rid);
        logMapper.saveLog(log);
        throw new RuntimeException();
    }

到此這篇關于SpringBoot整合Mybatis實現(xiàn)多數(shù)據(jù)源配置與跨數(shù)據(jù)源事務實例的文章就介紹到這了,更多相關SpringBoot多數(shù)據(jù)源配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

SpringBoot中@EnableAsync和@Async注解的使用小結(jié)
在SpringBoot中,可以通過@EnableAsync注解來啟動異步方法調(diào)用的支持,通過@Async注解來標識異步方法,讓方法能夠在異步線程中執(zhí)行,本文就來介紹一下,感興趣的可以了解一下
2023-11-11
淺談java實現(xiàn)重載的方法
方法重載是讓類以統(tǒng)一的方式處理不同類型數(shù)據(jù)的一種手段。多個同名函數(shù)同時存在，具有不同的參數(shù)個數(shù)/類型。重載Overloading是一個類中多態(tài)性的一種表現(xiàn)。Java的方法重載，就是在類中可以創(chuàng)建多個方法，它們具有相同的名字，但具有不同的參數(shù)和不同的定義。
2015-09-09
Springboot整合https的實例代碼
本文簡單介紹了一些密碼學的基礎和如何通過Springboot整合HTTPS，本文將通過實例代碼給大家詳細介紹整合過程，感興趣的朋友跟隨小編一起看看吧
2022-02-02
java中CompletableFuture異步執(zhí)行方法
本文主要介紹了java中CompletableFuture異步執(zhí)行方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2023-06-06
Java語言獲取TCP流的實現(xiàn)步驟
使用Wireshark分析網(wǎng)絡包時,一個很常用的功能就是選中一個TCP報文,然后查看這個TCP報文的TCP流,從而可以進一步分析建連是否慢了,斷連是否正常等情況,那么本文就TCP流的概念以及在Java中如何獲取,做一個簡單的學習,需要的朋友可以參考下
2023-11-11
Jenkins 編譯后使用SSH發(fā)布詳解
這篇文章主要介紹了Jenkins 編譯后使用SSH發(fā)布詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2019-07-07
Java移動文件夾及其所有子文件與子文件夾
這篇文章主要為大家詳細介紹了Java移動文件夾及其所有子文件與子文件夾的方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-03-03
jpa介紹以及在spring boot中使用詳解
最近在項目中使用了一下jpa，發(fā)現(xiàn)還是挺好用的。這里就來講一下jpa以及在spring boot中的使用。在這里我們先來了解一下jpa，希望能給你帶來幫助
2021-08-08
java利用遞歸調(diào)用實現(xiàn)樹形菜單的樣式
這篇文章主要給大家介紹了關于java利用遞歸調(diào)用實現(xiàn)樹形菜單樣式的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2018-09-09
java并發(fā)編程專題（十一）----(JUC原子類)數(shù)組類型詳解
這篇文章主要介紹了JAVA JUC原子類數(shù)組類型詳解的相關資料，文中示例代碼非常詳細，幫助大家更好的理解和學習，感興趣的朋友可以了解下
2020-07-07