如何實(shí)作讀寫分離，Spring Boot項(xiàng)目，資料庫(kù)是MySQL，持久層用的是MyBatis。

其實(shí)，實(shí)作這個(gè)很簡(jiǎn)單的，先思考一個(gè)問(wèn)題:

在高並發(fā)的場(chǎng)景中，關(guān)於資料庫(kù)都有哪些優(yōu)化的手段？

常用的有以下的實(shí)作方法：讀寫分離、加上快取、主從架構(gòu)叢集、分庫(kù)分錶等。

在網(wǎng)路應(yīng)用程式中，大部分都是讀多寫少 的場(chǎng)景，設(shè)定兩個(gè)庫(kù)，主庫(kù)和讀庫(kù)。

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

本文將聚焦在讀寫分離，探討如何實(shí)現(xiàn)它。

主從同步的限制 ：這裡分為主資料庫(kù)和從資料庫(kù)，主資料庫(kù)和從資料庫(kù)保持資料庫(kù)結(jié)構(gòu)的一致，主庫(kù)負(fù)責(zé)寫，寫入資料的時(shí)候，會(huì)自動(dòng)同步資料到從資料庫(kù)。從資料庫(kù)負(fù)責(zé)讀，當(dāng)讀取請(qǐng)求來(lái)的時(shí)候，直接從讀庫(kù)讀取數(shù)據(jù)，主資料庫(kù)會(huì)自動(dòng)進(jìn)行資料複製到從資料庫(kù)。不過(guò)本篇部落格不介紹這部分配置的知識(shí)，因?yàn)樗容^偏運(yùn)維工作一點(diǎn)。

這裡涉及到一個(gè)問(wèn)題:

主從複製的延遲問(wèn)題，當(dāng)寫入到主資料庫(kù)的過(guò)程中，突然來(lái)了一個(gè)讀取請(qǐng)求，而此時(shí)資料還沒有完全同步,就會(huì)出現(xiàn)讀取請(qǐng)求的資料讀不到或讀出的資料比原始值少的情況。具體的解決方法最簡(jiǎn)單的就是將讀取請(qǐng)求暫時(shí)指向主庫(kù),但是同時(shí)也失去了主從分離的部分意義。也就是說(shuō)在嚴(yán)格意義上的資料一致性場(chǎng)景中,讀寫分離並非是完全適合的,注意更新的時(shí)效性是讀寫分離使用的缺點(diǎn)。

好了，這部分只是了解，接下來(lái)我們看下具體如何透過(guò) Java 程式碼來(lái)實(shí)現(xiàn)讀寫分離：

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

程式媛：只有30天，該怎麼準(zhǔn)備？

一: 主從資料來(lái)源的設(shè)定

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

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

/**
 * 主從配置 
 */
@Configuration
@MapperScan(basePackages = "com.wyq.mysqlreadwriteseparate.mapper", sqlSessionTemplateRef = "sqlTemplate")
public class DataSourceConfig {

    /**
     * 主庫(kù)
     */
    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.master")
    public DataSource master() {
        return DruidDataSourceBuilder.create().build();
    }

    /**
     * 從庫(kù)
     */
    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.slave")
    public DataSource slaver() {
        return DruidDataSourceBuilder.create().build();
    }


    /**
     * 實(shí)例化數(shù)據(jù)源路由
     */
    @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();
    }


    /**
     * 創(chuàng)建sqlTemplate
     * @param sqlSessionFactory
     * @return
     */
    @Bean
    public SqlSessionTemplate sqlTemplate(@Qualifier("sessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }


    /**
     * 事務(wù)配置
     *
     * @param dynamicDataSource
     * @return
     */
    @Bean(name = "dataSourceTx")
    public DataSourceTransactionManager dataSourceTransactionManager(@Qualifier("dynamicDB") DataSource dynamicDataSource) {
        DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager();
        dataSourceTransactionManager.setDataSource(dynamicDataSource);
        return dataSourceTransactionManager;
    }
}

二: 資料來(lái)源路由的設(shè)定

#路由在主從分離是非常重要的，基本上是讀寫切換的核心。 Spring 提供了AbstractRoutingDataSource 根據(jù)使用者定義的規(guī)則選擇目前的資料來(lái)源，作用就是在執(zhí)行查詢之前，設(shè)定使用的資料來(lái)源,實(shí)現(xiàn)動(dòng)態(tài)路由的資料來(lái)源，在每次資料庫(kù)查詢操作前執(zhí)行它的抽象方法determineCurrentLookupKey() 決定使用哪個(gè)資料來(lái)源。

為了能有一個(gè)全域的資料來(lái)源管理器，此時(shí)我們需要引入DataSourceContextHolder 這個(gè)資料庫(kù)上下文管理器，可以理解為全域的變數(shù),隨時(shí)可取(見下面詳細(xì)介紹)，它的主要作用就是儲(chǔ)存目前的資料來(lái)源。

public class DataSourceRouter extends AbstractRoutingDataSource {

    /**
     * 最終的determineCurrentLookupKey返回的是從DataSourceContextHolder中拿到的,因此在動(dòng)態(tài)切換數(shù)據(jù)源的時(shí)候注解
     * 應(yīng)該給DataSourceContextHolder設(shè)值
     *
     * @return
     */
    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.get();

    }
}

三：數(shù)據(jù)源上下文環(huán)境

數(shù)據(jù)源上下文保存器,便于程序中可以隨時(shí)取到當(dāng)前的數(shù)據(jù)源，它主要利用 ThreadLocal 封裝，因?yàn)?ThreadLocal 是線程隔離的，天然具有線程安全的優(yōu)勢(shì)。這里暴露了 set 和 get、clear 方法，set 方法用于賦值當(dāng)前的數(shù)據(jù)源名，get 方法用于獲取當(dāng)前的數(shù)據(jù)源名稱，clear 方法用于清除 ThreadLocal 中的內(nèi)容，因?yàn)?ThreadLocal 的 key 是 weakReference 是有內(nèi)存泄漏風(fēng)險(xiǎn)的，通過(guò) remove 方法防止內(nèi)存泄漏。

/**
 * 利用ThreadLocal封裝的保存數(shù)據(jù)源上線的上下文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 配置

首先我們來(lái)定義一個(gè)@DataSourceSwitcher 注解,擁有兩個(gè)屬性

① 當(dāng)前的數(shù)據(jù)源② 是否清除當(dāng)前的數(shù)據(jù)源，并且只能放在方法上，(不可以放在類上，也沒必要放在類上，因?yàn)槲覀冊(cè)谶M(jìn)行數(shù)據(jù)源切換的時(shí)候肯定是方法操作)，該注解的主要作用就是進(jìn)行數(shù)據(jù)源的切換，在 dao 層進(jìn)行操作數(shù)據(jù)庫(kù)的時(shí)候，可以在方法上注明表示的是當(dāng)前使用哪個(gè)數(shù)據(jù)源。

@DataSourceSwitcher 注解的定義:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DataSourceSwitcher {
    /**
     * 默認(rèn)數(shù)據(jù)源
     * @return
     */
    DataSourceEnum value() default DataSourceEnum.MASTER;
    /**
     * 清除
     * @return
     */
    boolean clear() default true;

}

DataSourceAop配置：

為了賦予@DataSourceSwitcher 注解能夠切換數(shù)據(jù)源的能力，我們需要使用 AOP，然后使用@Aroud 注解找到方法上有@DataSourceSwitcher.class 的方法，然后取注解上配置的數(shù)據(jù)源的值，設(shè)置到 DataSourceContextHolder 中，就實(shí)現(xiàn)了將當(dāng)前方法上配置的數(shù)據(jù)源注入到全局作用域當(dāng)中。

@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("數(shù)據(jù)源切換至：{}", dataSourceSwitcher.value().getDataSourceName());
            return pjp.proceed();
        } finally {
            if (clear) {
                DataSourceContextHolder.clear();
            }

        }
    }

    private Method getMethod(JoinPoint pjp) {
        MethodSignature signature = (MethodSignature) pjp.getSignature();
        return signature.getMethod();
    }

}

五：用法以及測(cè)試

在配置好了讀寫分離之后,就可以在代碼中使用了，一般而言我們使用在 service 層或者 dao 層，在需要查詢的方法上添加@DataSourceSwitcher(DataSourceEnum.SLAVE)，它表示該方法下所有的操作都走的是讀庫(kù)。在需要 update 或者 insert 的時(shí)候使用@DataSourceSwitcher(DataSourceEnum.MASTER)表示接下來(lái)將會(huì)走寫庫(kù)。

其實(shí)還有一種更為自動(dòng)的寫法,可以根據(jù)方法的前綴來(lái)配置 AOP 自動(dòng)切換數(shù)據(jù)源，比如 update、insert、fresh 等前綴的方法名一律自動(dòng)設(shè)置為寫庫(kù)。select、get、query 等前綴的方法名一律配置為讀庫(kù)，這是一種更為自動(dòng)的配置寫法。缺點(diǎn)就是方法名需要按照 aop 配置的嚴(yán)格來(lái)定義，否則就會(huì)失效。

@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);
    }
}

六：總結(jié)

還是畫張圖來(lái)簡(jiǎn)單總結(jié)一下：

本文介紹如何實(shí)作資料庫(kù)讀寫分離，注意讀寫分離的核心點(diǎn)就是資料路由，需要繼承AbstractRoutingDataSource，複寫它的determineCurrentLookupKey ()方法。同時(shí)需要注意全域的上下文管理器 DataSourceContextHolder，它是保存資料來(lái)源上下文的主要類，也是路由方法中尋找的資料來(lái)源取值。相當(dāng)於資料來(lái)源的中繼站，再結(jié)合 jdbc-Template 的底層去建立和管理資料來(lái)源、交易等，我們的資料庫(kù)讀寫分離就完美實(shí)現(xiàn)了。