超详细的SpringBoot+MySQL读写分离方案

￡神魔★判官ぃ 2022-11-03 01:38 11阅读 0赞

在互联网应用中，大部分都是读多写少的场景，`设置两个库，主库和读库，主库的职能是负责写，从库主要是负责读`，可以建立读库集群，通过读写职能在数据源上的隔离达到减少读写冲突、释压数据库负载、保护数据库的目的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ21pbmcx_size_16_color_FFFFFF_t_70]

##### 主从数据源的配置 #####

通过@ConfigurationProperties注解，可以将配置文件(一般命名为:application.yml)里的属性映射到具体的类属性上，从而读取到写入的值注入到具体的代码配置中，按照习惯大于约定的原则，主库我们都是注为master，从库注为slave，接着需要配置sessionFactory、sqlTemplate、事务管理器等。

@Configuration
    @MapperScan(basePackages = "com.xxx.xxx.mapper", sqlSessionTemplateRef = "sqlTemplate")
    public class DataSourceConfig {
    
        /**
         * 主库
         */
        @Bean
        @ConfigurationProperties(prefix = "spring.datasource.master")
        public DataSource master() {
            return DruidDataSourceBuilder.create().build();
        }
    
        /**
         * 从库
         */
        @Bean
        @ConfigurationProperties(prefix = "spring.datasource.slave")
        public DataSource slaver() {
            return DruidDataSourceBuilder.create().build();
        }
    
    
        /**
         * 实例化数据源路由
         */
        @Bean
        public DataSourceRouter dynamicDB(@Qualifier("master") DataSource masterDataSource,
                                          @Autowired(required = false) @Qualifier("slaver") DataSource slaveDataSource) {
            DataSourceRouter dynamicDataSource = new DataSourceRouter();
            Map<Object, Object> targetDataSources = new HashMap<>();
            targetDataSources.put(DataSourceEnum.MASTER.getDataSourceName(), masterDataSource);
            if (slaveDataSource != null) {
                targetDataSources.put(DataSourceEnum.SLAVE.getDataSourceName(), slaveDataSource);
            }
            dynamicDataSource.setTargetDataSources(targetDataSources);
            dynamicDataSource.setDefaultTargetDataSource(masterDataSource);
            return dynamicDataSource;
        }
    
    
        /**
         * 配置sessionFactory
         * @param dynamicDataSource
         * @return
         * @throws Exception
         */
        @Bean
        public SqlSessionFactory sessionFactory(@Qualifier("dynamicDB") DataSource dynamicDataSource) throws Exception {
            SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
            bean.setMapperLocations(
                    new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/*Mapper.xml"));
            bean.setDataSource(dynamicDataSource);
            return bean.getObject();
        }
    
    
        /**
         * 创建sqlTemplate
         * @param sqlSessionFactory
         * @return
         */
        @Bean
        public SqlSessionTemplate sqlTemplate(@Qualifier("sessionFactory") SqlSessionFactory sqlSessionFactory) {
            return new SqlSessionTemplate(sqlSessionFactory);
        }
    
    
        /**
         * 事务配置
         *
         * @param dynamicDataSource
         * @return
         */
        @Bean(name = "dataSourceTx")
        public DataSourceTransactionManager dataSourceTransactionManager(@Qualifier("dynamicDB") DataSource dynamicDataSource) {
            DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();
            dataSourceTransactionManager.setDataSource(dynamicDataSource);
            return dataSourceTransactionManager;
        }
    }

##### 数据源路由的配置 #####

路由在主从分离是非常重要的，基本是读写切换的核心。Spring提供了AbstractRoutingDataSource 根据用户定义的规则选择当前的数据源，作用就是在执行查询之前，设置使用的数据源,实现动态路由的数据源，在每次数据库查询操作前执行它的抽象方法 determineCurrentLookupKey() 决定使用哪个数据源,为了能有一个全局的数据源管理器，此时我们需要引入DataSourceContextHolder这个数据库上下文管理器，可以理解为全局的变量，它的主要作用就是保存当前的数据源。

public class DataSourceRouter extends AbstractRoutingDataSource {
    
        /**
         * 最终的determineCurrentLookupKey返回的是从DataSourceContextHolder中拿到的,因此在动态切换数据源的时候注解
         * 应该给DataSourceContextHolder设值
         *
         * @return
         */
        @Override
        protected Object determineCurrentLookupKey() {
            return DataSourceContextHolder.get();
    
        }
    }

##### 数据源上下文环境 #####

数据源上下文保存器，便于程序中可以随时取到当前的数据源，它主要利用ThreadLocal封装，因为ThreadLocal是线程隔离的，天然具有线程安全的优势。这里暴露了set和get、clear方法，set方法用于赋值当前的数据源名，get方法用于获取当前的数据源名称，clear方法用于清除ThreadLocal中的内容，因为ThreadLocal的key是weakReference是有内存泄漏风险的，通过remove方法防止内存泄漏。

public class DataSourceContextHolder {
    
        private static final ThreadLocal<String> context = new ThreadLocal<>();
    
        /**
         * 赋值
         *
         * @param datasourceType
         */
        public static void set(String datasourceType) {
            context.set(datasourceType);
        }
    
        /**
         * 获取值
         * @return
         */
        public static String get() {
            return context.get();
        }
    
        public static void clear() {
            context.remove();
        }
    }

##### 切换注解和Aop配置 #####

首先我们来定义一个`@DataSourceSwitcher`注解，拥有两个属性①当前的数据源②是否清除当前的数据源，并且只能放在方法上，(不可以放在类上，也没必要放在类上，因为我们在进行数据源切换的时候肯定是方法操作)，该注解的主要作用就是进行数据源的切换，在dao层进行操作数据库的时候，可以在方法上注明表示的是当前使用哪个数据源。

@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @Documented
    public @interface DataSourceSwitcher {
        /**
         * 默认数据源
         * @return
         */
        DataSourceEnum value() default DataSourceEnum.MASTER;
        /**
         * 清除
         * @return
         */
        boolean clear() default true;
    
    }

为了赋予@DataSourceSwitcher注解能够切换数据源的能力，我们需要使用AOP，然后使用@Aroud注解找到方法上有@DataSourceSwitcher.class的方法，然后取注解上配置的数据源的值，设置到DataSourceContextHolder中，就实现了将当前方法上配置的数据源注入到全局作用域当中。

@Slf4j
    @Aspect
    @Order(value = 1)
    @Component
    public class DataSourceContextAop {
    
        @Around("@annotation(com.wyq.mysqlreadwriteseparate.annotation.DataSourceSwitcher)")
        public Object setDynamicDataSource(ProceedingJoinPoint pjp) throws Throwable {
            boolean clear = false;
            try {
                Method method = this.getMethod(pjp);
                DataSourceSwitcher dataSourceSwitcher = method.getAnnotation(DataSourceSwitcher.class);
                clear = dataSourceSwitcher.clear();
                DataSourceContextHolder.set(dataSourceSwitcher.value().getDataSourceName());
                log.info("数据源切换至：{}", dataSourceSwitcher.value().getDataSourceName());
                return pjp.proceed();
            } finally {
                if (clear) {
                    DataSourceContextHolder.clear();
                }
    
            }
        }
    
        private Method getMethod(JoinPoint pjp) {
            MethodSignature signature = (MethodSignature) pjp.getSignature();
            return signature.getMethod();
        }
    
    }

##### 用法及测试 #####

@Service
    public class OrderService {
    
        @Resource
        private OrderMapper orderMapper;
    
    
        /**
         * 读操作
         *
         * @param orderId
         * @return
         */
        @DataSourceSwitcher(DataSourceEnum.SLAVE)
        public List<Order> getOrder(String orderId) {
            return orderMapper.listOrders(orderId);
    
        }
    
        /**
         * 写操作
         *
         * @param orderId
         * @return
         */
        @DataSourceSwitcher(DataSourceEnum.MASTER)
        public List<Order> insertOrder(Long orderId) {
            Order order = new Order();
            order.setOrderId(orderId);
            return orderMapper.saveOrder(order);
        }
    }

##### 总结 #####

本篇博客介绍了如何实现数据库读写分离，注意读写分离的核心点就是数据路由，需要继承`AbstractRoutingDataSource`，复写它的`determineCurrentLookupKey`方法，同时需要注意全局的上下文管理器`DataSourceContextHolder`，它是保存数据源上下文的主要类，也是路由方法中寻找的数据源取值，相当于数据源的中转站，再结合jdbc-Template的底层去创建和管理数据源、事务等，我们的数据库读写分离就完美实现了。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ21pbmcx_size_16_color_FFFFFF_t_70]: /images/20221024/01874effc8394590939ba786b0f02142.png