SpringBoot 实现 MySQL 读写分离技术

数据库 MySQL
在实际的使用中,凡是涉及到写的部分直接切换到主库,读的部分直接切换到读库,这就是典型的读写分离技术。本篇博文将聚焦读写分离,探讨如何实现它。

 前言

首先思考一个问题:在高并发的场景中,关于数据库都有哪些优化的手段?常用的有以下的实现方法:读写分离、加缓存、主从架构集群、分库分表等,在互联网应用中,大部分都是读多写少 的场景,设置两个库,主库和读库。

主库的职能是负责写,从库主要是负责读,可以建立读库集群,通过读写职能在数据源上的隔离达到减少读写冲突、释压数据库负载 、保护数据库的目的 。在实际的使用中,凡是涉及到写的部分直接切换到主库,读的部分直接切换到读库,这就是典型的读写分离技术。本篇博文将聚焦读写分离,探讨如何实现它。

图片

主从同步的局限性 :这里分为主数据库和从数据库,主数据库和从数据库保持数据库结构的一致,主库负责写,当写入数据的时候,会自动同步数据到从数据库;从数据库负责读,当读请求来的时候,直接从读库读取数据,主数据库会自动进行数据复制到从数据库中。不过本篇博客不介绍这部分配置的知识,因为它更偏运维工作一点。

这里涉及到一个问题:主从复制的延迟问题,当写入到主数据库的过程中,突然来了一个读请求,而此时数据还没有完全同步,就会出现读请求的数据读不到或者读出的数据比原始值少的情况。具体的解决方法最简单的就是将读请求暂时指向主库,但是同时也失去了主从分离的部分意义。也就是说在严格意义上的数据一致性场景中,读写分离并非是完全适合的,注意更新的时效性是读写分离使用的缺点。

好了,这部分只是了解,接下来我们看下具体如何通过 java 代码来实现读写分离:

该项目需要引入如下依赖:springBoot、spring-aop、spring-jdbc、aspectjweaver 等

一: 主从数据源的配置

我们需要配置主从数据库,主从数据库的配置一般都是写在配置文件里面。通过@ConfigurationProperties 注解,可以将配置文件(一般命名为:application.Properties)里的属性映射到具体的类属性上,从而读取到写入的值注入到具体的代码配置中,按照习惯大于约定的原则,主库我们都是注为 master,从库注为 slave。

本项目采用了阿里的 druid 数据库连接池,使用 build 建造者模式创建 DataSource 对象,DataSource 就是代码层面抽象出来的数据源,接着需要配置 sessionFactory、sqlTemplate、事务管理器等 

  1. /**  
  2.  * 主从配置  
  3.  *  
  4.  * @author wyq  
  5.  */  
  6. @Configuration  
  7. @MapperScan(basePackages = "com.wyq.mysqlreadwriteseparate.mapper"sqlSessionTemplateRef = "sqlTemplate" 
  8. public class DataSourceConfig {  
  9.     /**  
  10.      * 主库  
  11.      */  
  12.     @Bean  
  13.     @ConfigurationProperties(prefix = "spring.datasource.master" 
  14.     public DataSource master() {  
  15.         return DruidDataSourceBuilder.create().build();  
  16.     }  
  17.     /**  
  18.      * 从库  
  19.      */  
  20.     @Bean  
  21.     @ConfigurationProperties(prefix = "spring.datasource.slave" 
  22.     public DataSource slaver() {  
  23.         return DruidDataSourceBuilder.create().build();  
  24.     }  
  25.     /**  
  26.      * 实例化数据源路由 
  27.      */  
  28.     @Bean  
  29.     public DataSourceRouter dynamicDB(@Qualifier("master") DataSource masterDataSource,  
  30.                                       @Autowired(required = false) @Qualifier("slaver") DataSource slaveDataSource) {  
  31.         DataSourceRouter dynamicDataSource = new DataSourceRouter();  
  32.         Map<Object, Object> targetDataSources = new HashMap<>();  
  33.         targetDataSources.put(DataSourceEnum.MASTER.getDataSourceName(), masterDataSource);  
  34.         if (slaveDataSource != null) {  
  35.             targetDataSources.put(DataSourceEnum.SLAVE.getDataSourceName(), slaveDataSource);  
  36.         }  
  37.         dynamicDataSource.setTargetDataSources(targetDataSources);  
  38.         dynamicDataSource.setDefaultTargetDataSource(masterDataSource);  
  39.         return dynamicDataSource;  
  40.     }  
  41.     /**  
  42.      * 配置sessionFactory  
  43.      * @param dynamicDataSource  
  44.      * @return  
  45.      * @throws Exception  
  46.      */  
  47.     @Bean  
  48.     public SqlSessionFactory sessionFactory(@Qualifier("dynamicDB") DataSource dynamicDataSource) throws Exception {  
  49.         SqlSessionFactoryBean bean = new SqlSessionFactoryBean();  
  50.         bean.setMapperLocations(  
  51.                 new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/*Mapper.xml"));  
  52.         bean.setDataSource(dynamicDataSource);  
  53.         return bean.getObject();  
  54.     }  
  55.     /**  
  56.      * 创建sqlTemplate  
  57.      * @param sqlSessionFactory  
  58.      * @return  
  59.      */  
  60.     @Bean 
  61.      public SqlSessionTemplate sqlTemplate(@Qualifier("sessionFactory") SqlSessionFactory sqlSessionFactory) {  
  62.         return new SqlSessionTemplate(sqlSessionFactory);  
  63.     }  
  64.     /**  
  65.      * 事务配置  
  66.      *  
  67.      * @param dynamicDataSource  
  68.      * @return  
  69.      */  
  70.     @Bean(name = "dataSourceTx" 
  71.     public DataSourceTransactionManager dataSourceTransactionManager(@Qualifier("dynamicDB") DataSource dynamicDataSource) {  
  72.         DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();  
  73.         dataSourceTransactionManager.setDataSource(dynamicDataSource);  
  74.         return dataSourceTransactionManager;  
  75.     }  

二: 数据源路由的配置

路由在主从分离是非常重要的,基本是读写切换的核心。Spring 提供了 AbstractRoutingDataSource 根据用户定义的规则选择当前的数据源,作用就是在执行查询之前,设置使用的数据源,实现动态路由的数据源,在每次数据库查询操作前执行它的抽象方法 determineCurrentLookupKey() 决定使用哪个数据源。

为了能有一个全局的数据源管理器,此时我们需要引入 DataSourceContextHolder 这个数据库上下文管理器,可以理解为全局的变量,随时可取(见下面详细介绍),它的主要作用就是保存当前的数据源; 

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

三:数据源上下文环境

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

  1. /**  
  2.  * 利用ThreadLocal封装的保存数据源上线的上下文context  
  3.  */  
  4. public class DataSourceContextHolder {  
  5.     private static final ThreadLocal<String> context = new ThreadLocal<>();  
  6.     /**  
  7.      * 赋值  
  8.      *  
  9.      * @param datasourceType  
  10.      */  
  11.     public static void set(String datasourceType) {  
  12.         context.set(datasourceType);  
  13.     }  
  14.     /**  
  15.      * 获取值  
  16.      * @return  
  17.      */  
  18.     public static String get() {  
  19.         return context.get();  
  20.     }  
  21.     public static void clear() {  
  22.         context.remove();  
  23.     }  

四:切换注解和 Aop 配置

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

@DataSourceSwitcher 注解的定义: 

  1. @Retention(RetentionPolicy.RUNTIME)  
  2. @Target(ElementType.METHOD)  
  3. @Documented  
  4. public @interface DataSourceSwitcher {  
  5.     /**  
  6.      * 默认数据源  
  7.      * @return  
  8.      */  
  9.     DataSourceEnum value() default DataSourceEnum.MASTER;  
  10.     /**  
  11.      * 清除  
  12.      * @return  
  13.      */  
  14.     boolean clear() default true;  

DataSourceAop 配置

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

  1. @Slf4j  
  2. @Aspect  
  3. @Order(value = 1 
  4. @Component  
  5. public class DataSourceContextAop {  
  6.     @Around("@annotation(com.wyq.mysqlreadwriteseparate.annotation.DataSourceSwitcher)")  
  7.     public Object setDynamicDataSource(ProceedingJoinPoint pjp) throws Throwable {  
  8.         boolean clear = false 
  9.         try {  
  10.             Method method = this.getMethod(pjp);  
  11.             DataSourceSwitcher dataSourceSwitcher = method.getAnnotation(DataSourceSwitcher.class);  
  12.             clear = dataSourceSwitcher.clear();  
  13.             DataSourceContextHolder.set(dataSourceSwitcher.value().getDataSourceName());  
  14.             log.info("数据源切换至:{}", dataSourceSwitcher.value().getDataSourceName());  
  15.             return pjp.proceed();  
  16.         } finally {  
  17.             if (clear) {  
  18.                 DataSourceContextHolder.clear();  
  19.             }  
  20.         }  
  21.     }  
  22.     private Method getMethod(JoinPoint pjp) {  
  23.         MethodSignature signature = (MethodSignature) pjp.getSignature();  
  24.         return signature.getMethod();  
  25.     }  

五:用法以及测试

在配置好了读写分离之后,就可以在代码中使用了,一般而言我们使用在 service 层或者 dao 层,在需要查询的方法上添加@DataSourceSwitcher(DataSourceEnum.SLAVE),它表示该方法下所有的操作都走的是读库;在需要 update 或者 insert 的时候使用@DataSourceSwitcher(DataSourceEnum.MASTER)表示接下来将会走写库。

其实还有一种更为自动的写法,可以根据方法的前缀来配置 AOP 自动切换数据源,比如 update、insert、fresh 等前缀的方法名一律自动设置为写库,select、get、query 等前缀的方法名一律配置为读库,这是一种更为自动的配置写法。缺点就是方法名需要按照 aop 配置的严格来定义,否则就会失效 

  1. @Service  
  2. public class OrderService {  
  3.     @Resource  
  4.     private OrderMapper orderMapper;  
  5.     /**  
  6.      * 读操作  
  7.      *  
  8.      * @param orderId  
  9.      * @return  
  10.      */  
  11.     @DataSourceSwitcher(DataSourceEnum.SLAVE)  
  12.     public List<Order> getOrder(String orderId) {  
  13.         return orderMapper.listOrders(orderId);   
  14.     }  
  15.     /**  
  16.      * 写操作  
  17.      *  
  18.      * @param orderId  
  19.      * @return  
  20.      */  
  21.     @DataSourceSwitcher(DataSourceEnum.MASTER)  
  22.     public List<Order> insertOrder(Long orderId) {  
  23.         Order order = new Order();  
  24.         order.setOrderId(orderId); 
  25.          return orderMapper.saveOrder(order);  
  26.     }  

六:总结

图片

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

 

责任编辑:庞桂玉 来源: 民工哥技术之路
相关推荐

2020-04-23 15:08:41

SpringBootMyCatJava

2017-05-25 10:22:13

NoSQL数据库主主备份

2017-09-04 09:53:58

MySQLAtlasNavicat

2009-05-04 09:13:52

PHPMySQL读写分离

2011-08-30 09:59:47

Mysql ProxyLUA

2021-09-08 10:23:08

读写分离Java数据库

2021-03-26 08:20:51

SpringBoot读写分离开发

2023-07-07 08:36:45

配置注解jar

2019-09-30 09:19:54

Redis分离云数据库

2020-03-24 14:16:18

ProxySQLMySQL数据库

2022-04-25 08:03:57

MySQL中间件MyCat

2010-05-17 11:19:44

MySQL proxy

2023-02-01 07:34:41

读写分离数据库

2020-12-08 06:17:11

MycatMySQL分离

2011-08-30 12:49:59

Mysql ProxyLua分离

2020-02-28 19:06:21

缓存读写Redis

2022-08-16 08:50:40

微服务动态读写分离

2020-11-24 09:56:12

数据源读写分离

2019-05-13 15:00:14

MySQLMyCat数据库

2017-11-24 17:20:37

数据库数据仓库读写分离
点赞
收藏

51CTO技术栈公众号