# springboot-double-data
springboot-double-data
應用場景
項目需要同時連接兩個不同的數據庫A, B,並且它們都為主從架構,一台寫庫,多台讀庫。
多數據源
首先要將spring boot自帶的DataSourceAutoConfiguration禁掉,因為它會讀取application.properties文件的spring.datasource.*屬性並自動配置單數據源。在@SpringBootApplication注解中添加exclude屬性即可:
//一般你啟動springboot項目,都會寫一個有@SpringBootApplication注解的類
//你在這個注解中添加exclude={DataSourceAutoConfiguration.class,HibernateJpaAutoConfiguration.class}
//即可無數據庫運行
//@SpringBootApplication//(exclude={DataSourceAutoConfiguration.class,HibernateJpaAutoConfiguration.class})
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@EnableSwagger2
@EnableDiscoveryClient
@ServletComponentScan
@ComponentScan("app")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
然后在application.properties中配置多數據源連接信息:
#mysql1
spring.datasource.db1.url=jdbc:mysql://10.96.140.136:3306/activiti?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.db1.username=ipdata
spring.datasource.db1.password=open2013
spring.datasource.db1.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.db1.max-idle=10
spring.datasource.db1.max-wait=10000
spring.datasource.db1.min-idle=5
spring.datasource.db1.initial-size=5
#mysql2
spring.datasource.db2.url=jdbc:mysql://10.96.140.136:3306/cmdb_resource_module?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.db2.username=ipdata
spring.datasource.db2.password=open2013
spring.datasource.db2.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.db2.max-idle=10
spring.datasource.db2.max-wait=10000
spring.datasource.db2.min-idle=5
spring.datasource.db2.initial-size=5
由於我們禁掉了自動數據源配置,因些下一步就需要手動將這些數據源創建出來:
package app.configuration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
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.PlatformTransactionManager;
import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;
/**
* 多數據源配置類
* Created by pure on 2018-05-06.
*/
@Configuration
public class DataSourceConfig {
//由於我們禁掉了自動數據源配置,因些下一步就需要手動將這些數據源創建出來:
//數據源1
@Bean(name = "datasource1")
@Primary
@ConfigurationProperties(prefix = "spring.datasource.db1") // application.properteis中對應屬性的前綴
public DataSource dataSource1() {
return DataSourceBuilder.create().build();
}
//數據源2
@Bean(name = "datasource2")
@ConfigurationProperties(prefix = "spring.datasource.db2") // application.properteis中對應屬性的前綴
public DataSource dataSource2() {
return DataSourceBuilder.create().build();
}
}
接下來需要配置兩個mybatis的SqlSessionFactory分別使用不同的數據源:
package app.configuration;
import javax.sql.DataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@MapperScan(basePackages = {"app.mapper.a"}, sqlSessionFactoryRef = "sqlSessionFactory1")
public class MybatisDbAConfig {
@Autowired
@Qualifier("datasource1")
private DataSource ds1;
@Bean
public SqlSessionFactory sqlSessionFactory1() throws Exception {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(ds1); // 使用ds1數據源, 連接ds1庫
return factoryBean.getObject();
}
@Bean
public SqlSessionTemplate sqlSessionTemplate1() throws Exception {
SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory1()); // 使用上面配置的Factory
return template;
}
}
經過上面的配置后,app.mapper.b下的Mapper接口,都會使用titan數據源。同理可配第二個SqlSessionFactory:
package app.configuration;
import javax.sql.DataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@MapperScan(basePackages = {"app.mapper.b"}, sqlSessionFactoryRef = "sqlSessionFactory2")
public class MybatisDbBConfig {
@Autowired
@Qualifier("datasource2")
private DataSource ds2;
@Bean
public SqlSessionFactory sqlSessionFactory2() throws Exception {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(ds2); // 使用ds2數據源, 連接ds2庫
return factoryBean.getObject();
}
@Bean
public SqlSessionTemplate sqlSessionTemplate2() throws Exception {
SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory2()); // 使用上面配置的Factory
return template;
}
}
完成這些配置后,假設有2個Mapper app.mapper.a和app.mapper.b,使用前者時會自動連接ds1庫,后者連接ds2庫。
動態數據源
使用動態數據源的初衷,是能在應用層做到讀寫分離,即在程序代碼中控制不同的查詢方法去連接不同的庫。除了這種方法以外,數據庫中間件也是個不錯的選擇,它的優點是數據庫集群對應用來說只暴露為單庫,不需要切換數據源的代碼邏輯。
我們通過自定義注解 + AOP的方式實現數據源動態切換。
首先定義一個DataSourceContextHolder, 用於保存當前線程使用的數據源名:
package app.configuration;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
public class DataSourceContextHolder {
private static Logger log = LogManager.getLogger(DataSourceContextHolder.class);
/**
* 默認數據源
*/
public static final String DEFAULT_DS = "db1";
private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
// 設置數據源名
public static void setDB(String dbType) {
System.out.println("切換到{}數據源"+ dbType);
contextHolder.set(dbType);
}
// 獲取數據源名
public static String getDB() {
return (contextHolder.get());
}
// 清除數據源名
public static void clearDB() {
contextHolder.remove();
}
}
然后自定義一個javax.sql.DataSource接口的實現,這里只需要繼承Spring為我們預先實現好的父類AbstractRoutingDataSource即可:
package app.configuration;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
public class DynamicDataSource extends AbstractRoutingDataSource{
private static final Logger log = LogManager.getLogger(DynamicDataSource.class);
@Override
protected Object determineCurrentLookupKey() {
System.out.println("數據源為{}"+DataSourceContextHolder.getDB());
return DataSourceContextHolder.getDB();
}
}
創建動態數據源:
/**
* 動態數據源: 通過AOP在不同數據源之間動態切換
* @return
*/
@Bean(name = "datasource1")
public DataSource dynamicDataSource() {
DynamicDataSource dynamicDataSource = new DynamicDataSource();
// 默認數據源
dynamicDataSource.setDefaultTargetDataSource(dataSource1());
// 配置多數據源
Map<Object, Object> dsMap = new HashMap<>(2);
dsMap.put("datasource1", dataSource1());
dsMap.put("datasource2", dataSource2());
dynamicDataSource.setTargetDataSources(dsMap);
return dynamicDataSource;
}
自定義注釋@DS用於在編碼時指定方法使用哪個數據源:
package app.configuration;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 自定義注釋@DS用於在編碼時指定方法使用哪個數據源:
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DS {
String value() default "datasource1";
}
編寫AOP切面,實現切換邏輯:
package app.configuration;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
/**
* 自定義注解 + AOP的方式實現數據源動態切換。
* Created by pure on 2018-05-06.
*/
@Aspect
@Component
public class DynamicDataSourceAspect {
@Before("@annotation(DS)")
public void beforeSwitchDS(JoinPoint point){
//獲得當前訪問的class
Class<?> className = point.getTarget().getClass();
//獲得訪問的方法名
String methodName = point.getSignature().getName();
//得到方法的參數的類型
Class[] argClass = ((MethodSignature)point.getSignature()).getParameterTypes();
String dataSource = DataSourceContextHolder.DEFAULT_DS;
try {
// 得到訪問的方法對象
Method method = className.getMethod(methodName, argClass);
// 判斷是否存在@DS注解
if (method.isAnnotationPresent(DS.class)) {
DS annotation = method.getAnnotation(DS.class);
// 取出注解中的數據源名
dataSource = annotation.value();
}
} catch (Exception e) {
e.printStackTrace();
}
// 切換數據源
DataSourceContextHolder.setDB(dataSource);
}
@After("@annotation(DS)")
public void afterSwitchDS(JoinPoint point){
DataSourceContextHolder.clearDB();
}
}
完成上述配置后,在先前SqlSessionFactory配置中指定使用DynamicDataSource就可以在Service中愉快的切換數據源了:
@DS("datasource2")
public List<PieEcharts> findVmPie() {
List<PieEcharts> findVmPie = echartsMapper.findVmPie();
return findVmPie;
}