3种方式实现多数据源控制/切换、实现读写分离;演示借助AbstractRoutingDataSource实现多数据源的动态切换代码【享学Spring】(下)

本文涉及的产品
RDS MySQL DuckDB 分析主实例,集群系列 4核8GB
RDS Agent(兼容OpenClaw),2核4GB
RDS AI 助手,专业版
简介: 3种方式实现多数据源控制/切换、实现读写分离;演示借助AbstractRoutingDataSource实现多数据源的动态切换代码【享学Spring】(下)

3、实现抽象类AbstractRoutingDataSource定义自己的动态数据源DataSource类


@Slf4j
public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() { //所有的请求都会走此处,所以没有切换的时候,不要输出日志吧
        String dataSourceId = DynamicDataSourceContextHolder.getDataSourceId();
        if (dataSourceId != null) { //有指定切换数据源切换的时候,才给输出日志 并且也只给输出成debug级别的 否则日志太多了
            log.debug("线程[{}],此时切换到的数据源为:{}", Thread.currentThread().getId(), dataSourceId);
        }
        return dataSourceId;
    }
}


就这样三步,我们带有动态切换能力的数据源类DynamicDataSource就完成了。

接下来就可以这么直接使用在项目里了:

Java配置文件JdbcConfig.java如下:


@EnableTransactionManagement
@Configuration
@PropertySource(value = "classpath:jdbc.properties", ignoreResourceNotFound = false, encoding = "UTF-8")
public class JdbcConfig implements TransactionManagementConfigurer {
    @Value("${datasource.username}")
    private String userName;
    @Value("${datasource.password}")
    private String password;
    @Value("${datasource.url}")
    private String url;
    // 从库配置
    @Value("${datasource.slave.username}")
    private String slaveUserName;
    @Value("${datasource.slave.password}")
    private String slavePassword;
    @Value("${datasource.slave.url}")
    private String slaveUrl;
    =====配置好两个数据源:
    @Bean
    public DataSource masterDataSource() {
        MysqlDataSource dataSource = new MysqlDataSource();
        dataSource.setUser(userName);
        dataSource.setPassword(password);
        dataSource.setURL(url);
        return dataSource;
    }
    @Bean
    public DataSource slaveDataSource() {
        MysqlDataSource dataSource = new MysqlDataSource();
        dataSource.setUser(slaveUserName);
        dataSource.setPassword(slavePassword);
        dataSource.setURL(slaveUrl);
        return dataSource;
    }
    // 定义动态数据源
    @Primary
    @Bean
    public DataSource dataSource() {
        DynamicDataSource dataSource = new DynamicDataSource();
        // 初始化值必须设置进去  且给一个默认值
        dataSource.setTargetDataSources(new HashMap<Object, Object>() {{
            put(DynamicDataSourceId.MASTER, masterDataSource());
            put(DynamicDataSourceId.SLAVE1, slaveDataSource());
            //顺手注册上去,方便后续的判断
            DynamicDataSourceId.DATA_SOURCE_IDS.add(DynamicDataSourceId.MASTER);
            DynamicDataSourceId.DATA_SOURCE_IDS.add(DynamicDataSourceId.SLAVE1);
        }});
        dataSource.setDefaultTargetDataSource(masterDataSource());
        return dataSource;
    }
    @Bean
    public JdbcTemplate jdbcTemplate() {
        return new JdbcTemplate(dataSource());
    }
    @Bean
    public PlatformTransactionManager transactionManager() {
        DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager(dataSource());
        dataSourceTransactionManager.setEnforceReadOnly(true); // 让事务管理器进行只读事务层面上的优化  建议开启
        return dataSourceTransactionManager;
    }
    // 指定注解使用的事务管理器
    @Override
    public PlatformTransactionManager annotationDrivenTransactionManager() {
        return transactionManager();
    }
}


可以和上面配置对比,这里并不需要什么都配置两份了,而是都只需要配置一份即可,其余的交给动态去切换吧。


单元测试如下:

@Slf4j
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {JdbcConfig.class})
public class TestSpringBean {
    @Autowired
    private JdbcTemplate jdbcTemplate;
    @Autowired
    private DataSource dataSource;
    @Test
    public void test1() throws SQLException {
        System.out.println(jdbcTemplate.getDataSource() == dataSource); //true
        System.out.println(DataSourceUtils.getConnection(jdbcTemplate.getDataSource())); //com.mysql.jdbc.JDBC4Connection@17503f6b
        DynamicDataSourceContextHolder.setDataSourceId(DynamicDataSourceId.SLAVE1); 
        System.out.println(jdbcTemplate.getDataSource() == dataSource); //true
        System.out.println(DataSourceUtils.getConnection(jdbcTemplate.getDataSource())); //com.mysql.jdbc.JDBC4Connection@20bd8be5
        // 完成操作后  最好把数据源再set回去  否则可能会对该线程后续再使用JdbcTemplate的时候造成影响
        //DynamicDataSourceContextHolder.setDataSourceId(DynamicDataSourceId.MASTER);
    }
}


从上结果,此处有几个细节需要注意:


  1. 数据源DataSource永远没变(用的是我们配置的DynamicDataSource)
  2. DynamicDataSourceContextHolder.setDataSourceId(DynamicDataSourceId.SLAVE1);后JdbcTemplate绑定的数据源肯定是不会变的。只是内部去获取链接的时候,从所属数据源变化了
  3. 用完之后记得还原现场、清理线程(切换数据源源用完之后记得切回来)


附:第一次链接所属的数据源截图:

image.png

切换后为:


image.png

理解了原理之后。其实我们的masterDataSource以及slaveDataSource是完全没有比较放到Spring容器内的,减轻Spring容器容器的负担嘛。使用下面配置效果一样(这样做更能体现对多数据源的理解,逼格更高~~~):


@EnableTransactionManagement
@Configuration
@PropertySource(value = "classpath:jdbc.properties", ignoreResourceNotFound = false, encoding = "UTF-8")
public class JdbcConfig implements TransactionManagementConfigurer {
  ...
    // 定义动态数据源
    @Bean
    public DataSource dataSource() {
        DynamicDataSource dataSource = new DynamicDataSource();
        final DataSource masterDataSource = masterDataSource();
        final DataSource slaveDataSource = slaveDataSource();
        // 初始化值必须设置进去  且给一个默认值
        dataSource.setTargetDataSources(new HashMap<Object, Object>() {{
            put(DynamicDataSourceId.MASTER, masterDataSource);
            put(DynamicDataSourceId.SLAVE1, slaveDataSource);
            //顺手注册上去,方便后续的判断
            DynamicDataSourceId.DATA_SOURCE_IDS.add(DynamicDataSourceId.MASTER);
            DynamicDataSourceId.DATA_SOURCE_IDS.add(DynamicDataSourceId.SLAVE1);
        }});
        dataSource.setDefaultTargetDataSource(masterDataSource);
        return dataSource;
    }
    private DataSource masterDataSource() {
        MysqlDataSource dataSource = new MysqlDataSource();
        dataSource.setUser(userName);
        dataSource.setPassword(password);
        dataSource.setURL(url);
        return dataSource;
    }
    private DataSource slaveDataSource() {
        MysqlDataSource dataSource = new MysqlDataSource();
        dataSource.setUser(slaveUserName);
        dataSource.setPassword(slavePassword);
        dataSource.setURL(slaveUrl);
        return dataSource;
    }
    @Bean
    public JdbcTemplate jdbcTemplate() {
        return new JdbcTemplate(dataSource());
    }
    ...
}


上面讲述了Spring动态切换数据源的核心原理逻辑以及使用方式,但是我们可以看到它使用上还是有一点点代码侵入性的。其实绝大多数情况下我们都希望切换数据源在方法级别即可,并不需要这么细粒度的控制。因此下面继续介绍更加优雅的操作方式(自定义注解+AOP)


使用AOP+自定义注解方式优雅的实现数据源动态切换

为了实现更优雅的动态数据源的切换,我们可以使用Spring AOP+自定义注解的方式实现对方法级别的数据源切换。


因为注解最低只能定义在方法上(而非代码块上),所以此种方式最细粒度为方法级别,99.99%情况下都够用了


自定义切换数据源的注解:(此处我定义的注解表示:可以用在方法上和类上)

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DynamicDataSourceSwitch {
    String dataSourceId() default DynamicDataSourceId.MASTER;
}


书写切面:


@Slf4j
@Order(1)
@Aspect
@Component // 切面必须交给容器管理
public class DynamicDataSourceHandlerAspect {
    @Pointcut("@annotation(com.fsx.dynamic.DynamicDataSourceSwitch)")
    public void pointcut() {
    }
    @Before("pointcut()")
    public void doBefore(JoinPoint joinPoint) {
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        DynamicDataSourceSwitch annotationClass = method.getAnnotation(DynamicDataSourceSwitch.class);//获取方法上的注解
        if (annotationClass == null) {
            annotationClass = joinPoint.getTarget().getClass().getAnnotation(DynamicDataSourceSwitch.class);//获取类上面的注解
            if (annotationClass == null) return;
        }
        //获取注解上的数据源的值的信息(这里最好还判断一下dataSourceId是否是有效的  若是无效的就用warn提醒  此处我就不处理了)
        String dataSourceId = annotationClass.dataSourceId();
    // 此处:切换数据源~~~
        DynamicDataSourceContextHolder.setDataSourceId(dataSourceId);
        log.info("AOP动态切换数据源,className" + joinPoint.getTarget().getClass().getName() + "methodName" + method.getName() + ";dataSourceId:" + dataSourceId == "" ? "默认数据源" : dataSourceId);
    }
    // 清理掉当前设置的数据源,让默认的数据源不受影响
    @After("pointcut()")
    public void after(JoinPoint point) {
        DynamicDataSourceContextHolder.clearDataSourceId();
    }
}


这样我们只需要在方法上标注一个注解,指定要切换到的数据源key就搞定了,非常的优雅,没有代码侵入性。


    @Transactional
    @DynamicDataSourceSwitch
    @Override
    public Object hello(Integer id) {
      ...
    }


在实际开发中我也是推荐使用此方式,若存在极其特殊的场景,你也可以结合编程的方式进行更细粒度的控制。


请确保标注此注解的Bean是交给Spring容器管理的~

另外一个常识:你的@Aspect切面只能切入同容器内的Bean,而不能切入子容器内的Bean。(这点在常规SpringMVC开发中可能存在Controller标注注解无效的情况吗,但在SpringBoot开发中无此顾虑,因为SpringBoot面向开发者只定义了一个容器)


总结


本文介绍了多种实现同一个工程内对多个数据源管理,但很显然,它的最佳实践是有一个:

Spring在2.0.1引入了AbstractRoutingDataSource,它并不是在1.0里几有的抽象,可见它也是时代的产物。

该类充当了DataSource的路由中介。 能有在运行时, 根据某种key值来动态切换到真正的DataSource上, 同时对于不支持事务隔离级别的JTA事务来说, Spring还提供了另外一个类IsolationLevelDataSourceRouter来处理这个问题。(具体在JTA事务里再会详解)

另外,上面讲述的这些API都在spring-jdbc.jar里。


最后也留一个小悬念:多数据源切换是成功了,但牵涉到事务呢?单数据源事务是ok的,但如果多数据源需要同时使用一个事务呢?

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
相关文章
|
10月前
|
安全 Java 应用服务中间件
Spring Boot + Java 21:内存减少 60%,启动速度提高 30% — 零代码
通过调整三个JVM和Spring Boot配置开关,无需重写代码即可显著优化Java应用性能:内存减少60%,启动速度提升30%。适用于所有在JVM上运行API的生产团队,低成本实现高效能。
1095 3
|
9月前
|
人工智能 监控 Java
零代码改造 + 全链路追踪!Spring AI 最新可观测性详细解读
Spring AI Alibaba 通过集成 OpenTelemetry 实现可观测性,支持框架原生和无侵入探针两种方式。原生方案依赖 Micrometer 自动埋点,适用于快速接入;无侵入探针基于 LoongSuite 商业版,无需修改代码即可采集标准 OTLP 数据,解决了原生方案扩展性差、调用链易断链等问题。未来将开源无侵入探针方案,整合至 AgentScope Studio,并进一步增强多 Agent 场景下的观测能力。
3099 96
|
9月前
|
安全 Java 测试技术
《深入理解Spring》单元测试——高质量代码的守护神
Spring测试框架提供全面的单元与集成测试支持,通过`@SpringBootTest`、`@WebMvcTest`等注解实现分层测试,结合Mockito、Testcontainers和Jacoco,保障代码质量,提升开发效率与系统稳定性。
|
10月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
334 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目,接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件,创建`application.yml`进行相关配置,如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件,包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码,并在主类添加`@MapperScan`注解完成整合
1667 1
Spring boot 使用mybatis generator 自动生成代码插件
|
12月前
|
安全 Java Nacos
0代码改动实现Spring应用数据库帐密自动轮转
Nacos作为国内被广泛使用的配置中心,已经成为应用侧的基础设施产品,近年来安全问题被更多关注,这是中国国内软件行业逐渐迈向成熟的标志,也是必经之路,Nacos提供配置加密存储-运行时轮转的核心安全能力,将在应用安全领域承担更多职责。
|
Java 调度 流计算
基于Java 17 + Spring Boot 3.2 + Flink 1.18的智慧实验室管理系统核心代码
这是一套基于Java 17、Spring Boot 3.2和Flink 1.18开发的智慧实验室管理系统核心代码。系统涵盖多协议设备接入(支持OPC UA、MQTT等12种工业协议)、实时异常检测(Flink流处理引擎实现设备状态监控)、强化学习调度(Q-Learning算法优化资源分配)、三维可视化(JavaFX与WebGL渲染实验室空间)、微服务架构(Spring Cloud构建分布式体系)及数据湖建设(Spark构建实验室数据仓库)。实际应用中,该系统显著提升了设备调度效率(响应时间从46分钟降至9秒)、设备利用率(从41%提升至89%),并大幅减少实验准备时间和维护成本。
605 0
|
人工智能 前端开发 Java
十几行代码实现 Manus,Spring AI Alibaba Graph 快速预览
Spring AI Alibaba Graph 的核心开发已完成,即将发布正式版本。开发者可基于此轻松构建工作流、智能体及多智能体系统,功能丰富且灵活。文章通过三个示例展示了其应用:1) 客户评价处理系统,实现两级问题分类与自动处理;2) 基于 ReAct Agent 的天气预报查询系统,循环执行用户指令直至完成;3) 基于 Supervisor 多智能体的 OpenManus 实现,简化了流程控制逻辑并优化了工具覆盖度。此外,还提供了运行示例的方法及未来规划,欢迎开发者参与贡献。
|
缓存 监控 Java