目錄
前言
1、使用Spring提供的AbstractRoutingDataSource
2、使用MyBatis注冊多個SqlSessionFactory
3、使用dynamic-datasource框架
前言
????????Java后臺使用MyBatis-plus 快速訪問多個數 據源,這里分享三種常用的多數據源管理方案
1、使用Spring提供的AbstractRoutingDataSource
這種方式的核心是使用 Spring 提供的 AbstractRoutingDataSource 抽象類,注入多個數據源。核心代碼如下:
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.DependsOn;
import org.springframework.context.annotation.Primary;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
import org.springframework.stereotype.Component;import javax.sql.DataSource;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;@Component
@Primary // 將該Bean設置為主要注入Bean
public class DynamicDataSource extends AbstractRoutingDataSource {// 當前使用的數據源標識public static ThreadLocal<String> name=new ThreadLocal<>();// 寫@AutowiredDataSource dataSource1;// 讀@AutowiredDataSource dataSource2;// 返回當前數據源標識@Overrideprotected Object determineCurrentLookupKey() {return name.get();}@Overridepublic void afterPropertiesSet() {// 為targetDataSources初始化所有數據源Map<Object, Object> targetDataSources=new HashMap<>();targetDataSources.put("W",dataSource1);targetDataSources.put("R",dataSource2);super.setTargetDataSources(targetDataSources);// 為defaultTargetDataSource 設置默認的數據源super.setDefaultTargetDataSource(dataSource1);super.afterPropertiesSet();}
}
將自己實現的 DynamicDataSource 注冊成為默認的 DataSource 實例后,只需要在每次使用 DataSource 時,提前
改變一下其中的name標識,就可以快速切換數據源。這里使用到AOP功能,關鍵代碼如下:
注解類,用于標識讀庫或者寫庫
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/**** @Author 黎劍* @Slogan 無意與眾不同,只因品位出眾,致敬未來的你*/
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface WR {String value() default "W";
}
切面類
import com.lijian.dynamic.datasource.DynamicDataSource;
import com.lijian.dynamic.datasource.annotation.WR;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;/**** @author 黎劍* @slogan 無意與眾不同,只因品位出眾,致敬未來的你*/
@Component
@Aspect
public class DynamicDataSourceAspect implements Ordered {// 前置@Before("within(com.lijian.dynamic.datasource.service.impl.*) && @annotation(wr)")public void before(JoinPoint point, WR wr){String name = wr.value();DynamicDataSource.name.set(name);System.out.println(name);}@Overridepublic int getOrder() {return 0;}//TODO 環繞通知
}
數據庫配置類
import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceBuilder;
import com.lijian.dynamic.datasource.DynamicDataSource;
import com.lijian.dynamic.datasource.plugin.DynamicDataSourcePlugin;
import org.apache.ibatis.plugin.Interceptor;
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.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;import javax.sql.DataSource;/**** @author 黎劍* @slogan 無意與眾不同,只因品位出眾,致敬未來的你*/
@Configuration
public class DataSourceConfig {@Bean@ConfigurationProperties(prefix = "spring.datasource.datasource1")public DataSource dataSource1() {// 底層會自動拿到spring.datasource中的配置, 創建一個DruidDataSourcereturn DruidDataSourceBuilder.create().build();}@Bean@ConfigurationProperties(prefix = "spring.datasource.datasource2")public DataSource dataSource2() {// 底層會自動拿到spring.datasource中的配置, 創建一個DruidDataSourcereturn DruidDataSourceBuilder.create().build();}@Beanpublic DataSourceTransactionManager transactionManager1(DynamicDataSource dataSource){DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();dataSourceTransactionManager.setDataSource(dataSource);return dataSourceTransactionManager;}@Beanpublic DataSourceTransactionManager transactionManager2(DynamicDataSource dataSource){DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();dataSourceTransactionManager.setDataSource(dataSource);return dataSourceTransactionManager;}
}
application.yml
spring:datasource:type: com.alibaba.druid.pool.DruidDataSourcedatasource1:url: jdbc:mysql://127.0.0.1:3306/datasource1?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF8&useSSL=falseusername: rootpassword: 123456initial-size: 1min-idle: 1max-active: 20test-on-borrow: truedriver-class-name: com.mysql.cj.jdbc.Driverdatasource2:url: jdbc:mysql://127.0.0.1:3306/datasource2?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF8&useSSL=falseusername: rootpassword: 123456initial-size: 1min-idle: 1max-active: 20test-on-borrow: truedriver-class-name: com.mysql.cj.jdbc.Driver
服務層實現類
import com.lijian.dynamic.datasource.annotation.WR;
import com.lijian.dynamic.datasource.mapper.FrendMapper;
import com.lijian.dynamic.datasource.entity.Frend;
import com.lijian.dynamic.datasource.service.FrendService;
import org.springframework.aop.framework.AopContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;import java.util.List;@Service
public class FrendImplService implements FrendService {@AutowiredFrendMapper frendMapper;@Override@WR("R") // 庫2public List<Frend> list() {return frendMapper.list();}@Override@WR("W") // 庫1public void save(Frend frend) {frendMapper.save(frend);}
}
啟動類
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.transaction.annotation.EnableTransactionManagement;@SpringBootApplication
@MapperScan("com.lijian.dynamic.datasource.mapper")
@EnableAspectJAutoProxy(exposeProxy=true) // 啟動AOP
public class DynamicDatasourceApplication {public static void main(String[] args) {SpringApplication.run(DynamicDatasourceApplication.class, args);}}
2、使用MyBatis注冊多個SqlSessionFactory
如果使用MyBatis框架,要注冊多個數據源的話,就需要將MyBatis底層的DataSource、SqlSessionFactory、 DataSourceTransactionManager這些核心對象一并進行手動注冊。例如:
import com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceBuilder;
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 org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.support.TransactionTemplate;import javax.sql.DataSource;@Configuration
// 繼承mybatis:
// 1. 指定掃描的mapper接口包(主庫)
// 2. 指定使用sqlSessionFactory是哪個(主庫)
@MapperScan(basePackages = "com.lijian.datasource.dynamic.mybatis.mapper.r",sqlSessionFactoryRef="rSqlSessionFactory")
public class RMyBatisConfig {@Bean@ConfigurationProperties(prefix = "spring.datasource.datasource2")public DataSource dataSource2() {// 底層會自動拿到spring.datasource中的配置, 創建一個DruidDataSourcereturn DruidDataSourceBuilder.create().build();}@Bean@Primarypublic SqlSessionFactory rSqlSessionFactory()throws Exception {final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();// 指定主庫sessionFactory.setDataSource(dataSource2());// 指定主庫對應的mapper.xml文件/*sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/r/*.xml"));*/return sessionFactory.getObject();}@Beanpublic DataSourceTransactionManager rTransactionManager(){DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();dataSourceTransactionManager.setDataSource(dataSource2());return dataSourceTransactionManager;}@Beanpublic TransactionTemplate rTransactionTemplate(){return new TransactionTemplate(rTransactionManager());}
}
import com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceBuilder;
import org.apache.ibatis.logging.stdout.StdOutImpl;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
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 org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.support.TransactionOperations;
import org.springframework.transaction.support.TransactionTemplate;import javax.sql.DataSource;/***** 寫數據源配置*/
@Configuration
// 繼承mybatis:
// 1. 指定掃描的mapper接口包(主庫)
// 2. 指定使用sqlSessionFactory是哪個(主庫)
@MapperScan(basePackages = "com.lijian.datasource.dynamic.mybatis.mapper.w",sqlSessionFactoryRef="wSqlSessionFactory")
public class WMyBatisConfig {@Bean@ConfigurationProperties(prefix = "spring.datasource.datasource1")public DataSource dataSource1() {// 底層會自動拿到spring.datasource中的配置, 創建一個DruidDataSourcereturn DruidDataSourceBuilder.create().build();}@Bean@Primarypublic SqlSessionFactory wSqlSessionFactory()throws Exception {final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();// 指定主庫sessionFactory.setDataSource(dataSource1());// 指定主庫對應的mapper.xml文件/*sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/order/*.xml"));*/return sessionFactory.getObject();}@Bean@Primarypublic DataSourceTransactionManager wTransactionManager(){DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();dataSourceTransactionManager.setDataSource(dataSource1());return dataSourceTransactionManager;}@Beanpublic TransactionTemplate wTransactionTemplate(){return new TransactionTemplate(wTransactionManager());}
}
?注解類
import java.lang.annotation.*;@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MultiTransactional {String[] value() default {};
}
?AOP
import com.lijian.datasource.dynamic.mybatis.service.transaction.ComboTransaction;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;@Aspect
@Component
public class MultiTransactionAop {private final ComboTransaction comboTransaction;@Autowiredpublic MultiTransactionAop(ComboTransaction comboTransaction) {this.comboTransaction = comboTransaction;}@Pointcut("within(com.lijian.datasource.dynamic.mybatis.service.impl.*)")public void pointCut() {}@Around("pointCut() && @annotation(multiTransactional)")public Object inMultiTransactions(ProceedingJoinPoint pjp, MultiTransactional multiTransactional) {return comboTransaction.inCombinedTx(() -> {try {return pjp.proceed(); //執行目標方法} catch (Throwable throwable) {if (throwable instanceof RuntimeException) {throw (RuntimeException) throwable;}throw new RuntimeException(throwable);}}, multiTransactional.value());}
}
import com.alibaba.druid.util.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;import java.util.concurrent.Callable;
import java.util.stream.Stream;@Component
public class ComboTransaction {@Autowiredprivate Db1TxBroker db1TxBroker;@Autowiredprivate Db2TxBroker db2TxBroker;public <V> V inCombinedTx(Callable<V> callable, String[] transactions) {if (callable == null) {return null;}// 相當于循環 [wTransactionManager,wTransactionManager]Callable<V> combined = Stream.of(transactions).filter(ele -> !StringUtils.isEmpty(ele)).distinct().reduce(callable, (r, tx) -> {switch (tx) {case DbTxConstants.DB1_TX:return () -> db1TxBroker.inTransaction(r);case DbTxConstants.DB2_TX:return () -> db2TxBroker.inTransaction(r);default:return null;}}, (r1, r2) -> r2);try {return combined.call();} catch (RuntimeException e) {throw e;} catch (Exception e) {throw new RuntimeException(e);}}
}
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;import java.util.concurrent.Callable;@Component
public class Db1TxBroker {@Transactional(DbTxConstants.DB1_TX)public <V> V inTransaction(Callable<V> callable) {try {return callable.call();} catch (RuntimeException e) {throw e;} catch (Exception e) {throw new RuntimeException(e);}}
}
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;import java.util.concurrent.Callable;@Component
public class Db2TxBroker {@Transactional(DbTxConstants.DB2_TX)public <V> V inTransaction(Callable<V> callable) {try {return callable.call();} catch (RuntimeException e) {throw e;} catch (Exception e) {throw new RuntimeException(e);}}
}
public class DbTxConstants {public static final String DB1_TX = "wTransactionManager";public static final String DB2_TX = "rTransactionManager";
}
服務層類
import com.lijian.datasource.dynamic.mybatis.entity.Frend;
import com.lijian.datasource.dynamic.mybatis.mapper.r.RFrendMapper;
import com.lijian.datasource.dynamic.mybatis.mapper.w.WFrendMapper;
import com.lijian.datasource.dynamic.mybatis.service.FrendService;
import org.springframework.aop.framework.AopContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.transaction.support.TransactionTemplate;import java.util.List;@Service
public class FrendImplService implements FrendService {@Autowiredprivate RFrendMapper rFrendMapper;@Autowiredprivate WFrendMapper wFrendMapper;@AutowiredTransactionTemplate wTransactionTemplate;@AutowiredTransactionTemplate rTransactionTemplate;// 讀-- 讀庫@Overridepublic List<Frend> list() {return rFrendMapper.list();}// 保存-- 寫庫@Overridepublic void save(Frend frend) {wFrendMapper.save(frend);}// 保存-- 寫庫@Overridepublic void saveW(Frend frend) {frend.setName("無羨W");wFrendMapper.save(frend);}// 保存-- 讀庫@Overridepublic void saveR(Frend frend) {frend.setName("無羨R");rFrendMapper.save(frend);}@Transactional(transactionManager = "wTransactionManager")public void saveAll(Frend frend) throws Exception {FrendService frendService = (FrendService) AopContext.currentProxy();frendService.saveAllR(frend);}@Transactional(transactionManager = "rTransactionManager")public void saveAllR(Frend frend) {saveW(frend);saveR(frend);int a = 1 / 0;}
}
這樣就完成了讀庫的注冊。而讀庫與寫庫之間,就可以通過指定不同的 Mapper 和 XML 文件的地址來進行區分。
3、使用dynamic-datasource框架
????????dynamic-datasource是 MyBaits-plus 作者設計的一個多數據源開源方案。使用這個框架需要引入對應的 pom 依賴
<dependency><groupId>com.baomidou</groupId><artifactId>dynamic-datasource-spring-boot-starter</artifactId><version>3.5.0</version></dependency>
這樣就可以在 SpringBoot 的配置文件中直接配置多個數據源,application.yaml
spring:datasource:dynamic:#設置默認的數據源或者數據源組,默認值即為masterprimary: master#嚴格匹配數據源,默認false. true未匹配到指定數據源時拋異常,false使用默認數據源strict: falsedatasource:master:url: jdbc:mysql://127.0.0.1:3306/datasource1?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF8&useSSL=falseusername: rootpassword: 123456initial-size: 1min-idle: 1max-active: 20test-on-borrow: truedriver-class-name: com.mysql.cj.jdbc.Driverslave_1:url: jdbc:mysql://127.0.0.1:3306/datasource2?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF8&useSSL=falseusername: rootpassword: 123456initial-size: 1min-idle: 1max-active: 20test-on-borrow: truedriver-class-name: com.mysql.cj.jdbc.Driver
這樣就配置完成了 master 和 slave_1 兩個數據庫。
接下來在使用時,只要在對應的方法或者類上添加 @DS注解即可。服務層實現類, 例如
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.dynamic.datasource.annotation.DSTransactional;
import com.lijian.dynamic.datasource.mapper.FrendMapper;
import com.lijian.dynamic.datasource.entity.Frend;
import com.lijian.dynamic.datasource.service.FrendService;
import org.springframework.aop.framework.AopContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;import java.util.List;@Service
public class FrendImplService implements FrendService {@AutowiredFrendMapper frendMapper;@Override@DS("slave") // 從庫, 如果按照下劃線命名方式配置多個 , 可以指定前綴即可(組名)public List<Frend> list() {return frendMapper.list();}@Override@DS("#session.userID")@DSTransactional #事務控制public void save(Frend frend) {frendMapper.save(frend);}@DS("master")@DSTransactionalpublic void saveAll(){// 執行多數據源的操作}
}