从零实现 SpringBoot 简易读写分离，也不难嘛！-

沙海

3179
文章

2
评论

2021年5月23日09:43:36Java评论31字数 9663阅读32分12秒阅读模式

摘要

速读摘要

速读摘要文章源自JAVA秀-https://www.javaxiu.com/24987.html

并未照搬网文，而是独立思考后的成果，写完以后发现从零开始写读写分离并不难!仔细阅读了三个方法，基本上跟方法名的意思一致。之后定义一个切面在事务切面之前执行，确定真实数据源对应的key。但是这又出现了一个问题，如何线程安全的情况下传递每个线程独立的key呢?MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。文章源自JAVA秀-https://www.javaxiu.com/24987.html

原文约 3559 字 | 图片 7 张 | 建议阅读 8 分钟 | 评价反馈文章源自JAVA秀-https://www.javaxiu.com/24987.html

从零实现 SpringBoot 简易读写分离，也不难嘛！

点击关注 ? Java基基文章源自JAVA秀-https://www.javaxiu.com/24987.html

收录于话题文章源自JAVA秀-https://www.javaxiu.com/24987.html

#Java基基文章源自JAVA秀-https://www.javaxiu.com/24987.html

98个文章源自JAVA秀-https://www.javaxiu.com/24987.html

点击上方“Java基基”，选择“设为星标”文章源自JAVA秀-https://www.javaxiu.com/24987.html

做积极的人，而不是积极废人！文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

源码精品专栏文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

原创 | Java 2020 超神之路，很肝~文章源自JAVA秀-https://www.javaxiu.com/24987.html
中文详细注释的开源项目文章源自JAVA秀-https://www.javaxiu.com/24987.html
RPC 框架 Dubbo 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
网络应用框架 Netty 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
消息中间件 RocketMQ 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
数据库中间件 Sharding-JDBC 和 MyCAT 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
作业调度中间件 Elastic-Job 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
分布式事务中间件 TCC-Transaction 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
Eureka 和 Hystrix 源码解析文章源自JAVA秀-https://www.javaxiu.com/24987.html
Java 并发源码文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

来源：my.oschina.net/floor/blog/1632565文章源自JAVA秀-https://www.javaxiu.com/24987.html

大家好，我是基基！文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

最近在学习Spring boot，写了个读写分离。并未照搬网文，而是独立思考后的成果，写完以后发现从零开始写读写分离并不难！文章源自JAVA秀-https://www.javaxiu.com/24987.html

我最初的想法是：读方法走读库，写方法走写库（一般是主库），保证在Spring提交事务之前确定数据源.文章源自JAVA秀-https://www.javaxiu.com/24987.html

从零实现 SpringBoot 简易读写分离，也不难嘛！文章源自JAVA秀-https://www.javaxiu.com/24987.html

保证在Spring提交事务之前确定数据源，这个简单，利用AOP写个切换数据源的切面，让他的优先级高于Spring事务切面的优先级。至于读，写方法的区分可以用2个注解。文章源自JAVA秀-https://www.javaxiu.com/24987.html

但是如何切换数据库呢？我完全不知道！多年经验告诉我文章源自JAVA秀-https://www.javaxiu.com/24987.html

当完全不了解一个技术时，先搜索学习必要知识，之后再动手尝试。文章源自JAVA秀-https://www.javaxiu.com/24987.html

我搜索了一些网文，发现都提到了一个AbstractRoutingDataSource类。查看源码注释如下文章源自JAVA秀-https://www.javaxiu.com/24987.html

/** Abstract {@link javax.sql.DataSource} implementation that routes {@link #getConnection()}* calls to one of various target DataSources based on a lookup key. The latter is usually* (but not necessarily) determined through some thread-bound transaction context.** @author Juergen Hoeller* @since 2.0.1* @see #setTargetDataSources* @see #setDefaultTargetDataSource* @see #determineCurrentLookupKey()*/文章源自JAVA秀-https://www.javaxiu.com/24987.html

AbstractRoutingDataSource就是DataSource的抽象，基于lookup key的方式在多个数据库中进行切换。重点关注setTargetDataSources，setDefaultTargetDataSource，determineCurrentLookupKey三个方法。那么AbstractRoutingDataSource就是Spring读写分离的关键了。文章源自JAVA秀-https://www.javaxiu.com/24987.html

仔细阅读了三个方法，基本上跟方法名的意思一致。setTargetDataSources设置备选的数据源集合。setDefaultTargetDataSource设置默认数据源，determineCurrentLookupKey决定当前数据源的对应的key。文章源自JAVA秀-https://www.javaxiu.com/24987.html

但是我很好奇这3个方法都没有包含切换数据库的逻辑啊！我仔细阅读源码发现一个方法，determineTargetDataSource方法，其实它才是获取数据源的实现。源码如下：文章源自JAVA秀-https://www.javaxiu.com/24987.html

    //切换数据库的核心逻辑    protected DataSource determineTargetDataSource() {  Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");  Object lookupKey = determineCurrentLookupKey();  DataSource dataSource = this.resolvedDataSources.get(lookupKey);  if (dataSource == null && (this.lenientFallback || lookupKey == null)) {   dataSource = this.resolvedDefaultDataSource;  }  if (dataSource == null) {   throw new IllegalStateException              ("Cannot determine target DataSource for lookup key [" + lookupKey + "]");  }  return dataSource; }    //之前的2个核心方法 public void setTargetDataSources(Map<Object, Object> targetDataSources) {  this.targetDataSources = targetDataSources; }    public void setDefaultTargetDataSource(Object defaultTargetDataSource) {  this.defaultTargetDataSource = defaultTargetDataSource; }

简单说就是，根据determineCurrentLookupKey获取的key,在resolvedDataSources这个Map中查找对应的datasource！，注意determineTargetDataSource方法竟然不使用的targetDataSources！文章源自JAVA秀-https://www.javaxiu.com/24987.html

那一定存在resolvedDataSources与targetDataSources的对应关系。我接着翻阅代码，发现一个afterPropertiesSet方法（Spring源码中InitializingBean接口中的方法），这个方法将targetDataSources的值赋予了resolvedDataSources。源码如下：文章源自JAVA秀-https://www.javaxiu.com/24987.html

 @Override public void afterPropertiesSet() {  if (this.targetDataSources == null) {   throw new IllegalArgumentException("Property 'targetDataSources' is required");  }  this.resolvedDataSources = new HashMap<Object, DataSource>(this.targetDataSources.size());  for (Map.Entry<Object, Object> entry : this.targetDataSources.entrySet()) {   Object lookupKey = resolveSpecifiedLookupKey(entry.getKey());   DataSource dataSource = resolveSpecifiedDataSource(entry.getValue());   this.resolvedDataSources.put(lookupKey, dataSource);  }  if (this.defaultTargetDataSource != null) {   this.resolvedDefaultDataSource = resolveSpecifiedDataSource(this.defaultTargetDataSource);  } }

afterPropertiesSet 方法，熟悉Spring的都知道，它在bean实例已经创建好，且属性值和依赖的其他bean实例都已经注入以后执行。文章源自JAVA秀-https://www.javaxiu.com/24987.html

也就是说调用，targetDataSources，defaultTargetDataSource的赋值一定要在afterPropertiesSet前边执行。文章源自JAVA秀-https://www.javaxiu.com/24987.html

AbstractRoutingDataSource简单总结：文章源自JAVA秀-https://www.javaxiu.com/24987.html
AbstractRoutingDataSource，内部有一个Map<Object,DataSource>的域resolvedDataSources文章源自JAVA秀-https://www.javaxiu.com/24987.html
determineTargetDataSource方法通过determineCurrentLookupKey方法获得key，进而从map中取得对应的DataSource。文章源自JAVA秀-https://www.javaxiu.com/24987.html
setTargetDataSources 设置 targetDataSources文章源自JAVA秀-https://www.javaxiu.com/24987.html
setDefaultTargetDataSource 设置 defaultTargetDataSource，文章源自JAVA秀-https://www.javaxiu.com/24987.html
targetDataSources和defaultTargetDataSource 在afterPropertiesSet分别转换为resolvedDataSources和resolvedDefaultDataSource。文章源自JAVA秀-https://www.javaxiu.com/24987.html
targetDataSources，defaultTargetDataSource的赋值一定要在afterPropertiesSet前边执行。文章源自JAVA秀-https://www.javaxiu.com/24987.html

进一步了解理论后，读写分离的方式则基本上出现在眼前了。（“下列方法不唯一”）文章源自JAVA秀-https://www.javaxiu.com/24987.html

先写一个类继承AbstractRoutingDataSource，实现determineCurrentLookupKey方法，和afterPropertiesSet方法。afterPropertiesSet方法中调用setDefaultTargetDataSource和setTargetDataSources方法之后调用super.afterPropertiesSet。文章源自JAVA秀-https://www.javaxiu.com/24987.html

之后定义一个切面在事务切面之前执行，确定真实数据源对应的key。但是这又出现了一个问题，如何线程安全的情况下传递每个线程独立的key呢？没错使用ThreadLocal传递真实数据源对应的key 。文章源自JAVA秀-https://www.javaxiu.com/24987.html

ThreadLocal，Thread的局部变量，确保每一个线程都维护变量的一个副本文章源自JAVA秀-https://www.javaxiu.com/24987.html

到这里基本逻辑就想通了，之后就是写了。文章源自JAVA秀-https://www.javaxiu.com/24987.html

DataSourceContextHolder 使用ThreadLocal存储真实数据源对应的key文章源自JAVA秀-https://www.javaxiu.com/24987.html

public class DataSourceContextHolder {    private static Logger log = LoggerFactory.getLogger(DataSourceContextHolder.class); //线程本地环境    private static final ThreadLocal<String> local = new ThreadLocal<String>();    public static void setRead() {        local.set(DataSourceType.read.name());        log.info("数据库切换到读库...");    }    public static void setWrite() {        local.set(DataSourceType.write.name());        log.info("数据库切换到写库...");    }    public static String getReadOrWrite() {        return local.get();    }}

DataSourceAopAspect 切面切换真实数据源对应的key，并设置优先级保证高于事务切面文章源自JAVA秀-https://www.javaxiu.com/24987.html

@Aspect@EnableAspectJAutoProxy(exposeProxy=true,proxyTargetClass=true)@Componentpublic class DataSourceAopAspect implements PriorityOrdered{  @Before("execution(* com.springboot.demo.mybatis.service.readorwrite..*.*(..)) "            + " and @annotation(com.springboot.demo.mybatis.readorwrite.annatation.ReadDataSource) ")    public void setReadDataSourceType() {        //如果已经开启写事务了，那之后的所有读都从写库读            DataSourceContextHolder.setRead();    }    @Before("execution(* com.springboot.demo.mybatis.service.readorwrite..*.*(..)) "            + " and @annotation(com.springboot.demo.mybatis.readorwrite.annatation.WriteDataSource) ")    public void setWriteDataSourceType() {        DataSourceContextHolder.setWrite();    } @Override public int getOrder() {  /**         * 值越小，越优先执行 要优于事务的执行         * 在启动类中加上了@EnableTransactionManagement(order = 10)         */  return 1; }}

RoutingDataSouceImpl实现AbstractRoutingDataSource的逻辑文章源自JAVA秀-https://www.javaxiu.com/24987.html

@Componentpublic class RoutingDataSouceImpl extends AbstractRoutingDataSource { @Override public void afterPropertiesSet() {  //初始化bean的时候执行，可以针对某个具体的bean进行配置  //afterPropertiesSet 早于init-method  //将datasource注入到targetDataSources中，可以为后续路由用到的key  this.setDefaultTargetDataSource(writeDataSource);  Map<Object,Object>targetDataSources=new HashMap<Object,Object>();  targetDataSources.put( DataSourceType.write.name(), writeDataSource);  targetDataSources.put( DataSourceType.read.name(),  readDataSource);  this.setTargetDataSources(targetDataSources);  //执行原有afterPropertiesSet逻辑，  //即将targetDataSources中的DataSource加载到resolvedDataSources  super.afterPropertiesSet(); } @Override protected Object determineCurrentLookupKey() {  //这里边就是读写分离逻辑，最后返回的是setTargetDataSources保存的Map对应的key  String typeKey = DataSourceContextHolder.getReadOrWrite();  Assert.notNull(typeKey, "数据库路由发现typeKey is null，无法抉择使用哪个库");  log.info("使用"+typeKey+"数据库.............");  return typeKey; }   private static Logger log = LoggerFactory.getLogger(RoutingDataSouceImpl.class); @Autowired @Qualifier("writeDataSource") private DataSource writeDataSource; @Autowired @Qualifier("readDataSource") private DataSource readDataSource;}

基本逻辑实现完毕了就进行，通用设置,设置数据源，事务，SqlSessionFactory等文章源自JAVA秀-https://www.javaxiu.com/24987.html

 @Primary@Bean(name = "writeDataSource", destroyMethod = "close")@ConfigurationProperties(prefix = "test_write")public DataSource writeDataSource() {        return new DruidDataSource();        }@Bean(name = "readDataSource", destroyMethod = "close")@ConfigurationProperties(prefix = "test_read")public DataSource readDataSource() {        return new DruidDataSource();        }@Bean(name = "writeOrReadsqlSessionFactory")public SqlSessionFactory        sqlSessionFactorys(RoutingDataSouceImpl roundRobinDataSouceProxy)        throws Exception {        try {        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();        bean.setDataSource(roundRobinDataSouceProxy);        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();        // 实体类对应的位置        bean.setTypeAliasesPackage("com.springboot.demo.mybatis.model");        // mybatis的XML的配置        bean.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));        return bean.getObject();        } catch (IOException e) {        log.error("" + e);        return null;        } catch (Exception e) {        log.error("" + e);        return null;        }        }@Bean(name = "writeOrReadTransactionManager")public DataSourceTransactionManager transactionManager(RoutingDataSouceImpl        roundRobinDataSouceProxy) {        //Spring 的jdbc事务管理器        DataSourceTransactionManager transactionManager = new        DataSourceTransactionManager(roundRobinDataSouceProxy);        return transactionManager;        }

其他代码，就不在这里赘述了，有兴趣可以移步完整代码。文章源自JAVA秀-https://www.javaxiu.com/24987.html

使用Spring写读写分离，其核心就是AbstractRoutingDataSource，源码不难，读懂之后，写个读写分离就简单了！。文章源自JAVA秀-https://www.javaxiu.com/24987.html

AbstractRoutingDataSource重点回顾：文章源自JAVA秀-https://www.javaxiu.com/24987.html
AbstractRoutingDataSource，内部有一个Map<Object,DataSource>的域resolvedDataSources文章源自JAVA秀-https://www.javaxiu.com/24987.html
determineTargetDataSource方法通过determineCurrentLookupKey方法获得key，进而从map中取得对应的DataSource。文章源自JAVA秀-https://www.javaxiu.com/24987.html
setTargetDataSources 设置 targetDataSources文章源自JAVA秀-https://www.javaxiu.com/24987.html
setDefaultTargetDataSource 设置 defaultTargetDataSource，文章源自JAVA秀-https://www.javaxiu.com/24987.html
targetDataSources和defaultTargetDataSource 在afterPropertiesSet分别转换为resolvedDataSources和resolvedDefaultDataSource。文章源自JAVA秀-https://www.javaxiu.com/24987.html
targetDataSources，defaultTargetDataSource的赋值一定要在afterPropertiesSet前边执行。文章源自JAVA秀-https://www.javaxiu.com/24987.html

这周确实有点忙，周五花费了些时间不过总算实现了自己的诺言。文章源自JAVA秀-https://www.javaxiu.com/24987.html

完成承诺不容易，喜欢您就点个赞！文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：文章源自JAVA秀-https://www.javaxiu.com/24987.html

从零实现 SpringBoot 简易读写分离，也不难嘛！文章源自JAVA秀-https://www.javaxiu.com/24987.html

已在知识星球更新源码解析如下：文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

最近更新《芋道 SpringBoot 2.X 入门》系列，已经 20 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。文章源自JAVA秀-https://www.javaxiu.com/24987.html

提供近 3W 行代码的 SpringBoot 示例，以及超 4W 行代码的电商微服务项目。文章源自JAVA秀-https://www.javaxiu.com/24987.html

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章源自JAVA秀-https://www.javaxiu.com/24987.html

文章有帮助的话，在看，转发吧。谢谢支持哟 (*^__^*）

文章源自JAVA秀-https://www.javaxiu.com/24987.html

阅读原文文章源自JAVA秀-https://www.javaxiu.com/24987.html

继续阅读

历史上的今天

5月

速蛙云 - 极致体验，强烈推荐！！！购买套餐就免费送各大视频网站会员！快速稳定、独家福利社、流媒体稳定解锁！速度快，全球上网、视频、游戏加速、独立IP均支持！基础套餐性价比很高！这里不多说，我一直正在使用，推荐购买：https://www.javaxiu.com/59919.html

资源分享QQ群

本站是JAVA秀团队的技术分享社区, 会经常分享资源和教程; 分享的时代, 请别再沉默！

从零实现 SpringBoot 简易读写分离，也不难嘛！

从零实现 SpringBoot 简易读写分离，也不难嘛！

历史上的今天

面试官：你对 Java线程池了解多少？

图解 SQL，这也太形象了吧！

太强了，一个注解搞定接口返回数据脱敏

涨姿势，Java 重构设计模式，厉害！

面了个 5 年 Java，两个线程进行数据交换都不会，我真是醉了。。

我们公司用了 6 年的网关服务，动态路由、鉴权、限流等都有，稳的一批!

MySQL 默认隔离级别是RR，为什么阿里等大厂会改成RC？

7种实现web实时消息推送的方案！

巨坑系列：Java Bean 转 Map 的坑要注意！

手把手教你用代码实现 SSO 单点登录

发表评论

在线咨询

微信