Spring Boot 實作 MySQL 讀寫分離技術

如何實作讀寫分離，Spring Boot項目，資料庫是MySQL，持久層用的是MyBatis。

其實，實作這個很簡單的，先思考一個問題:

在高並發的場景中，關於資料庫都有哪些優化的手段？

常用的有以下的實作方法：讀寫分離、加上快取、主從架構叢集、分庫分錶等。

在網路應用程式中，大部分都是讀多寫少 的場景，設定兩個庫，主庫和讀庫。

主庫的功能是負責寫，從庫主要是負責讀取,可以建立讀庫集群,透過讀寫職能在資料來源上的隔離達到減少讀寫衝突、釋壓資料庫負載、保護資料庫的目的。在實際的使用中,凡是涉及到寫的部分直接切換到主庫，讀的部分直接切換到讀庫，這就是典型的讀寫分離技術。

本文將聚焦在讀寫分離，探討如何實現它。

主從同步的限制 ：這裡分為主資料庫和從資料庫，主資料庫和從資料庫保持資料庫結構的一致，主庫負責寫，寫入資料的時候，會自動同步資料到從資料庫。從資料庫負責讀，當讀取請求來的時候，直接從讀庫讀取數據，主資料庫會自動進行資料複製到從資料庫。不過本篇部落格不介紹這部分配置的知識，因為它比較偏運維工作一點。

這裡涉及到一個問題:

主從複製的延遲問題，當寫入到主資料庫的過程中，突然來了一個讀取請求，而此時資料還沒有完全同步,就會出現讀取請求的資料讀不到或讀出的資料比原始值少的情況。具體的解決方法最簡單的就是將讀取請求暫時指向主庫,但是同時也失去了主從分離的部分意義。也就是說在嚴格意義上的資料一致性場景中,讀寫分離並非是完全適合的,注意更新的時效性是讀寫分離使用的缺點。

好了，這部分只是了解，接下來我們看下具體如何透過 Java 程式碼來實現讀寫分離：

注意：該專案需要引入如下依賴：Spring Boot、spring-aop、spring-jdbc、aspectjweaver 等

程式媛：只有30天，該怎麼準備？

一: 主從資料來源的設定

我們需要設定主從資料庫，主從資料庫的配置一般都是寫在設定檔裡面。透過@ConfigurationProperties 註解，可以將設定檔(一般命名為：application.Properties)裡的屬性對應到特定的類別屬性上，從而讀取到寫入的值注入到特定的程式碼配置中，依照習慣大於約定的原則，主庫我們都是註為master，從函式庫註為slave。

本專案採用了阿里的 druid 資料庫連接池，使用 build 建造者模式建立 DataSource 對象，DataSource 是程式碼層面抽象化的資料來源，接著需要配置 sessionFactory、sqlTemplate、事務管理器等。

/**
 * 主从配置 
 */
@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 的底層去建立和管理資料來源、交易等，我們的資料庫讀寫分離就完美實現了。

以上是Spring Boot 實作 MySQL 讀寫分離技術的詳細內容。更多資訊請關注PHP中文網其他相關文章！