基於springboot的mysql實現讀寫分離
前言: 首先思考一個問題:在高併發的場景中,關於資料庫都有哪些優化的手段？常用的有以下的實現方法:讀寫分離、加快取、主從架構叢集、分庫分表等，在網際網路應用中,大部分都是讀多寫少的場景,設定兩個庫,主庫和讀庫,主庫的職能是負責寫,從庫主要是負責讀,可以建立讀庫叢集,通過讀寫職能在資料來源上的隔離達到減少讀寫衝突、釋壓資料庫負載、保護資料庫的目的。在實際的使用中,凡是涉及到寫的部分直接切換到主庫，讀的部分直接切換到讀庫，這就是典型的讀寫分離技術。本篇博文將聚焦讀寫分離,探討如何實現它。
目錄
一: 主從資料來源的配置
二: 資料來源路由的配置
三：資料來源上下文環境
四：切換註解和Aop配置
五：用法以及測試
六：總結
主從同步的侷限性：這裡分為主資料庫和從資料庫,主資料庫和從資料庫保持資料庫結構的一致,主庫負責寫,當寫入資料的時候,會自動同步資料到從資料庫；從資料庫負責讀,當讀請求來的時候,直接從讀庫讀取資料,主資料庫會自動進行資料複製到從資料庫中。不過本篇部落格不介紹這部分配置的知識,因為它更偏運維工作一點。這裡涉及到一個問題:主從複製的延遲問題,當寫入到主資料庫的過程中,突然來了一個讀請求,而此時資料還沒有完全同步,就會出現讀請求的資料讀不到或者讀出的資料比原始值少的情況。具體的解決方法最簡單的就是將讀請求暫時指向主庫,但是同時也失去了主從分離的部分意義。也就是說在嚴格意義上的資料一致性場景中,讀寫分離並非是完全適合的,注意更新的時效性是讀寫分離使用的缺點。
好了,這部分只是瞭解,接下來我們看下具體如何通過java程式碼來實現讀寫分離:
該專案需要引入如下依賴：springBoot、spring-aop、spring-jdbc、aspectjweaver等
一: 主從資料來源的配置
我們需要配置主從資料庫,主從資料庫的配置一般都是寫在配置檔案裡面。通過@ConfigurationProperties註解,可以將配置檔案(一般命名為:application.Properties)裡的屬性對映到具體的類屬性上,從而讀取到寫入的值注入到具體的程式碼配置中,按照習慣大於約定的原則,主庫我們都是注為master,從庫注為slave,本專案採用了阿里的druid資料庫連線池,使用build建造者模式建立DataSource物件,DataSource就是程式碼層面抽象出來的資料來源,接著需要配置sessionFactory、sqlTemplate、事務管理器等
/** * 主從配置 * * @author wyq * @date 2020年07月24日01:24:42 */ @Configuration @MapperScan(basePackages = "com.wyq.mysqlreadwriteseparate.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方法防止記憶體洩漏；
/** * 利用ThreadLocal封裝的儲存資料來源上線的上下文context */ 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層進行操作資料庫的時候,可以在方法上註明表示的是當前使用哪個資料來源;
@DataSourceSwitcher註解的定義:
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented public @interface DataSourceSwitcher { /** * 預設資料來源 * @return */ DataSourceEnum value() default DataSourceEnum.MASTER; /** * 清除 * @return */ boolean clear() default true; }
DataSourceAop配置
為了賦予@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層或者dao層,在需要查詢的方法上新增@DataSourceSwitcher(DataSourceEnum.SLAVE),它表示該方法下所有的操作都走的是讀庫;在需要update或者insert的時候使用@DataSourceSwitcher(DataSourceEnum.MASTER)表示接下來將會走寫庫。其實還有一種更為自動的寫法,可以根據方法的字首來配置AOP自動切換資料來源,比如update、insert、fresh等字首的方法名一律自動設定為寫庫,select、get、query等字首的方法名一律配置為讀庫,這是一種更為自動的配置寫法。缺點就是方法名需要按照aop配置的嚴格來定義,否則就會失效
@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的底層去建立和管理資料來源、事務等，我們的資料庫讀寫分離就完美實現了。