目录
一、动态数据源介绍
1. AbstractRoutingDataSource
2. 实现逻辑
二、源代码
1. 修改配置文件类
2. 创建数据源枚举
3. 数据源切换处理
4. 继承AbstractRoutingDataSource
5. 注入数据源
6. 自定义多数据源切换注解
7. AOP拦截类的实现
8. 使用切换数据源注解
9. 在启动项目的过程中会发生循环依赖的问题,直接修改启动类即可
10. 启动成功
一、动态数据源介绍
1. AbstractRoutingDataSource
DataSource是和线程绑定的,动态数据源的配置主要是通过继承AbstractRoutingDataSource类实现的,
抽象类AbstractRoutingDataSource,通过扩展这个类实现根据不同的请求切换数据源。
AbstractRoutingDataSource继承AbstractDataSource,如果声明一个类DynamicDataSource继承AbstractRoutingDataSource后,DynamicDataSource本身就相当于一种数据源
AbstractRoutingDataSource的多数据源动态切换的核心逻辑是:在程序运行时,把数据源通过 AbstractRoutingDataSource 动态织入到程序中,灵活的进行数据源切换。
需要实现determineCurrentLookupKey方法。
public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {protected abstract Object determineCurrentLookupKey();}
2. 实现逻辑
1.先创建一个多线程 线程数据隔离的类来存放DataSource。DynamicDataSourceContextHolder
2.determineCurrentLookupKey()方法中通过这个类获取当前线程的DataSource
3.将数据源交给Spring管理。DataSourceConfig
4.AbstractRoutingDataSource类中,DataSource是通过Key-value的方式保存的,我们可以通过ThreadLocal来保存Key,从而实现数据源的动态切换。DynamicDataSource
5.写一个AOP动态的切换数据源。DataSourceAspect
二、源代码
1. 修改配置文件类
server:port: 8085
spring:profiles: testdatasource:local:username: rootpassword: rootdriver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://localhost:3306/hm49?serverTimezone=UTC&useUnicode=true@characterEncoding=utf-8remote:username: rootpassword: rootdriver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://localhost:3306/hm49?serverTimezone=UTC&useUnicode=true@characterEncoding=utf-8
2. 创建数据源枚举
public enum DataSourceType {REMOTE,LOCAL
}
3. 数据源切换处理
创建一个数据源切换处理类,有对数据源变量的获取、设置和情况的方法,其中threadlocal用于保存某个线程共享变量。
public class DynamicDataSourceContextHolder {/*** 使用ThreadLocal维护变量,ThreadLocal为每个使用该变量的线程提供独立的变量副本,* 所以每一个线程都可以独立地改变自己的副本,而不会影响其它线程所对应的副本。*/private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();/*** 设置数据源变量* @param dataSourceType*/public static void setDataSourceType(String dataSourceType){System.out.printf("切换到{%s}数据源", dataSourceType);CONTEXT_HOLDER.set(dataSourceType);}/*** 获取数据源变量* @return*/public static String getDataSourceType(){return CONTEXT_HOLDER.get();}/*** 清空数据源变量*/public static void clearDataSourceType(){CONTEXT_HOLDER.remove();}
}
4. 继承AbstractRoutingDataSource
动态切换数据源主要依靠AbstractRoutingDataSource。创建一个AbstractRoutingDataSource的子类,重写determineCurrentLookupKey方法,用于决定使用哪一个数据源。
这里主要用到AbstractRoutingDataSource的两个属性defaultTargetDataSource和targetDataSources。defaultTargetDataSource默认目标数据源,targetDataSources(map类型)存放用来切换的数据源。
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;import javax.sql.DataSource;
import java.util.Map;public class DynamicDataSource extends AbstractRoutingDataSource {public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {super.setDefaultTargetDataSource(defaultTargetDataSource);super.setTargetDataSources(targetDataSources);// afterPropertiesSet()方法调用时用来将targetDataSources的属性写入resolvedDataSources中的super.afterPropertiesSet();}/*** 根据Key获取数据源的信息** @return*/@Overrideprotected Object determineCurrentLookupKey() {return DynamicDataSourceContextHolder.getDataSourceType();}
}
5. 注入数据源
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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 javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;@Configuration
public class DataSourceConfig {@Bean@ConfigurationProperties("spring.datasource.remote")public DataSource remoteDataSource() {return DataSourceBuilder.create().build();}@Bean@ConfigurationProperties("spring.datasource.local")public DataSource localDataSource() {return DataSourceBuilder.create().build();}@Bean(name = "dynamicDataSource")@Primarypublic DynamicDataSource dataSource(DataSource remoteDataSource, DataSource localDataSource) {Map<Object, Object> targetDataSources = new HashMap<>();targetDataSources.put(DataSourceType.REMOTE.name(), remoteDataSource);targetDataSources.put(DataSourceType.LOCAL.name(), localDataSource);return new DynamicDataSource(remoteDataSource, targetDataSources);}
}
6. 自定义多数据源切换注解
设置拦截数据源的注解,可以设置在具体的类上,或者在具体的方法上
import java.lang.annotation.*;@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {/*** 切换数据源名称*/DataSourceType value() default DataSourceType.REMOTE;
}
7. AOP拦截类的实现
通过拦截上面的注解,在其执行之前处理设置当前执行SQL的数据源的信息,CONTEXT_HOLDER.set(dataSourceType)这里的数据源信息从我们设置的注解上面获取信息,如果没有设置就是用默认的数据源的信息。
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.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;import java.lang.reflect.Method;@Aspect
@Order(1)
@Component
public class DataSourceAspect {@Pointcut("@annotation(com.promsing.mult.DataSource)") //需要切AbstractRoutingDataSource的子类public void dsPointCut() {}@Around("dsPointCut()")public Object around(ProceedingJoinPoint point) throws Throwable {MethodSignature signature = (MethodSignature) point.getSignature();Method method = signature.getMethod();DataSource dataSource = method.getAnnotation(DataSource.class);if (dataSource != null) {DynamicDataSourceContextHolder.setDataSourceType(dataSource.value().name());}try {return point.proceed();} finally {// 销毁数据源 在执行方法之后DynamicDataSourceContextHolder.clearDataSourceType();}}
}
8. 使用切换数据源注解
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.List;
import java.util.Map;@RestController
public class EmpController {@AutowiredJdbcTemplate jdbcTemplate;@GetMapping("/local")@DataSource(value = DataSourceType.LOCAL)public List<Map<String, Object>> local(){String dataSourceType = DynamicDataSourceContextHolder.getDataSourceType();System.out.println(dataSourceType);List<Map<String, Object>> maps = jdbcTemplate.queryForList("select * from tb_user");return maps;}@GetMapping("/remote")@DataSource(value = DataSourceType.REMOTE)public List<Map<String, Object>> remote(){String dataSourceType = DynamicDataSourceContextHolder.getDataSourceType();System.out.println(dataSourceType);List<Map<String, Object>> maps = jdbcTemplate.queryForList("select * from tb_user");return maps;}}
9. 在启动项目的过程中会发生循环依赖的问题,直接修改启动类即可
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class SpringbootDataApplication {public static void main(String[] args) {SpringApplication.run(SpringbootDataApplication.class, args);}
}
10. 启动成功
请求:http://localhost:8085/local
打印日志:切换到{LOCAL}数据源LOCAL
请求:http://localhost:8085/remote
打印日志:切换到{REMOTE}数据源REMOTE