基於MySql主從分離的程式碼層實現

Java伴我餘生發表於2020-07-28

前言

  該文是基於上篇《MySQL主從分離的實現》的程式碼層實現,所以本文配置的主資料庫和從資料庫的資料來源都是在上篇博文中已經介紹了的。

動態選擇資料來源的配置

  由於我們在寫資料的時候需要使用主庫的資料來源,讀的時候需要從庫的資料來源,我們可以在Spring原始碼中,通過DataSource可以找到AbstractDataSource抽象類,由於我們需要動態的選擇資料來源,我們可以通過AbstractDataSource發現他的一個子類是AbstractRoutingDataSource的抽象類,通過類名我們可以知道該類是具有路由功能的,可以路由到不同的資料來源,這個類中有一個方法determineTargetDateSource(),該方法就是決定目標資料來源的,該方法會呼叫determineCurrentLookupKey(),就是決定資料來源的名字了,該方法是一個抽象的,所以我們需要去繼承AbstractRoutingDataSource這個類,並實現determineCurrentLookupKey()這個方法,來動態選擇資料來源,讀資料的時候選擇從庫的資料來源,寫操作的時候選擇主庫的資料來源

public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DynamicDataSourceHolder.getDBType();
    }
}

編寫DynamicDataSourceHolder

public class DynamicDataSourceHolder {
    private static Logger logger = LoggerFactory.getLogger(DynamicDataSourceHolder.class);

    //ThreadLocal是執行緒安全的
    private static ThreadLocal<String> contextHolder = new ThreadLocal<>();
    public static final String DB_MASTER = "master";
    public static final String DB_SLAVE = "slave";

    public static String getDBType() {
        String db = contextHolder.get();
        if (db == null){
            db = DB_MASTER; // 預設為master,因為master即支援讀也支援寫
        }
        return db;
    }

    /**
     * 設定執行緒的dbType
     * @param str
     */
    public static void setDBType(String str) {
        logger.debug("所使用的資料來源:"+ str);
        contextHolder.set(str);
    }

    /**
     * 清理連線型別
     */
    public static void clearDBType(){
        contextHolder.remove();
    }
}

設定mybatis的攔截器

   完成路由後,我們需要依靠攔截器對傳遞進來的SQL資訊來選擇資料來源,例如傳進來的是insert,update,delete語句,就使用主庫的資料來源,如果是select就選擇從庫的資料來源。

@Intercepts({@Signature(type = Executor.class,method = "update",args = {MappedStatement.class,Object.class}),
        @Signature(type = Executor.class,method = "query",
                args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class})})
public class DynamicDataSourceInterceptor implements Interceptor {
    private static Logger logger = LoggerFactory.getLogger(DynamicDataSourceInterceptor.class);
    //使用正規表示式匹配增刪改
    private static final String REGEX = ".*insert\\u0020.*|.*delete\\u0020.*|.*update\\u0020.*";

    /**
     * 攔截方法
     * @param invocation
     * @return
     * @throws Throwable
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 判斷當前操作是否是事務的
        // 使用@Transactional來處理,則會返回true
        boolean transactionActive = TransactionSynchronizationManager.isActualTransactionActive();
        Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        String lookupKey = DynamicDataSourceHolder.DB_MASTER;
        if ( !transactionActive ) {
            // 如果是查詢操作
            if (ms.getSqlCommandType().equals(SqlCommandType.SELECT)) {
                //selectKey 為自增id查詢主鍵SELECT_KEY_SUFFIX()方法,使用主庫
                if (ms.getId().contains(SelectKeyGenerator.SELECT_KEY_SUFFIX)){
                    lookupKey = DynamicDataSourceHolder.DB_MASTER;
                } else {
                    BoundSql boundSql = ms.getSqlSource().getBoundSql(args[1]);
                    // 對製表符,換行符,空格符就行替換
                    String sql = boundSql.getSql().toLowerCase(Locale.CHINA).replaceAll("[\\t\\n\\r]", " ");
                    //增刪改使用主庫,查使用從庫
                    if (sql.matches(REGEX)) {
                        lookupKey = DynamicDataSourceHolder.DB_MASTER;
                    } else {
                        lookupKey = DynamicDataSourceHolder.DB_SLAVE;
                    }
                }
            }

        } else {
            lookupKey = DynamicDataSourceHolder.DB_MASTER;
        }
        logger.debug("設定方法[{}] use [{}] Strategy,SqlCommandType [{}] ...",
                ms.getId(), lookupKey, ms.getSqlCommandType().name());
        DynamicDataSourceHolder.setDBType(lookupKey);
        return invocation.proceed();
    }

    /**
     * 決定返回封裝好的物件還是代理物件
     * 增刪改查得操作
     * @param target
     * @return
     */
    @Override
    public Object plugin(Object target) {
        //當我們攔截的物件是Executor時,就攔截,通過intercept()方法 決定所使用的資料來源
        //為什麼要攔截Executor型別呢?因為在我們的mybatis中,Executor是用來支援一系列增刪改查操作的
        //只要我們檢測到攔截的物件包含增刪改查操作,就攔截下來,使用intercept()方法,決定所使用的資料來源
        if (target instanceof Executor) {
            return Plugin.wrap(target,this);
        } else {
            return target;
        }
    }

    /**
     * 在類初始化的時候,去做一些相關的設定
     * @param properties
     */
    @Override
    public void setProperties(Properties properties) {

    }
}

  只是編寫完這個方法是沒用的,我們還需要在mybaties-config.xml配置檔案中,配置上我們實現的攔截器,如下:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	<!-- 配置全域性屬性 -->
	<settings>
		<!-- 使用jdbc的getGeneratedKeys獲取資料庫自增主鍵值 -->
		<setting name="useGeneratedKeys" value="true" />

		<!-- 使用列別名替換列名 預設:true -->
		<setting name="useColumnLabel" value="true" />

		<!-- 開啟駝峰命名轉換:Table{create_time} -> Entity{createTime} -->
		<setting name="mapUnderscoreToCamelCase" value="true" />
		<!-- 列印查詢語句 -->
		<setting name="logImpl" value="STDOUT_LOGGING" />
	</settings>
	<plugins>
		<plugin interceptor="cn.reminis.o2o.dao.split.DynamicDataSourceInterceptor" />
	</plugins>
</configuration>

配置多資料來源

  將原來配置dataSource的bean,改為abstractDatasource,並增加主庫資料來源和從庫資料來源的配置,如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 配置整合mybatis過程 -->
    <context:property-placeholder location="classpath:jdbc.properties"/>

    <!-- 2.資料庫連線池 -->
    <bean id="abstractDataSource" abstract="true" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
        <!-- 配置連線池屬性 -->
        <!--
        <property name="driverClass" value="${jdbc.driver}" />
        <property name="jdbcUrl" value="${jdbc.url}" />
        <property name="user" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
        -->

        <!-- c3p0連線池的私有屬性 -->
        <property name="maxPoolSize" value="30" />
        <property name="minPoolSize" value="10" />
        <!-- 關閉連線後不自動commit -->
        <property name="autoCommitOnClose" value="false" />
        <!-- 獲取連線超時時間 -->
        <property name="checkoutTimeout" value="10000" />
        <!-- 當獲取連線失敗重試次數 -->
        <property name="acquireRetryAttempts" value="2" />
    </bean>

    <!--主庫的資料來源配置-->
    <bean id="master" parent="abstractDataSource">
        <property name="driverClass" value="${jdbc.master.driver}" />
        <property name="jdbcUrl" value="${jdbc.master.url}" />
        <property name="user" value="${jdbc.master.username}" />
        <property name="password" value="${jdbc.master.password}" />
    </bean>

    <!--從庫的資料來源配置-->
    <bean id="slave" parent="abstractDataSource">
        <property name="driverClass" value="${jdbc.slave.driver}" />
        <property name="jdbcUrl" value="${jdbc.slave.url}" />
        <property name="user" value="${jdbc.slave.username}" />
        <property name="password" value="${jdbc.slave.password}" />
    </bean>

    <!--配置動態資料來源。這裡targetDataSource就是路由資料來源的名稱-->
    <bean id="dynamicDataSource" class="cn.reminis.o2o.dao.split.DynamicDataSource">
        <property name="targetDataSources">
            <map>
                <entry value-ref="master" key="master"></entry>
                <entry value-ref="slave" key="slave"></entry>
            </map>
        </property>
    </bean>

    <!--懶載入,因為資料來源是程式執行時決定的-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.LazyConnectionDataSourceProxy">
        <property name="targetDataSource">
            <ref bean="dynamicDataSource" />
        </property>
    </bean>

    <!-- 3.配置SqlSessionFactory物件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 注入資料庫連線池 -->
        <property name="dataSource" ref="dataSource" />
        <!-- 配置MyBaties全域性配置檔案:mybatis-config.xml -->
        <property name="configLocation" value="classpath:mybatis-config.xml" />
        <!-- 掃描entity包 使用別名 -->
        <property name="typeAliasesPackage" value="cn.reminis.o2o.entity" />
        <!-- 掃描sql配置檔案:mapper需要的xml檔案 -->
        <property name="mapperLocations" value="classpath:mapper/*.xml" />
    </bean>

    <!-- 4.配置掃描Dao介面包,動態實現Dao介面,注入到spring容器中 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 注入sqlSessionFactory -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
        <!-- 給出需要掃描Dao介面包 -->
        <property name="basePackage" value="cn.reminis.o2o.dao" />
    </bean>
</beans>

我們在jdbc.properties配置檔案中,配置主從庫資料來源的地址:

## 主庫資料來源配置
jdbc.master.driver=com.mysql.jdbc.Driver
jdbc.master.url=jdbc:mysql://192.168.0.188:3306/o2o?useUnicode=true&characterEncoding=utf8
jdbc.master.username=root
jdbc.master.password=123456

## 從庫資料來源配置
jdbc.slave.driver=com.mysql.jdbc.Driver
jdbc.slave.url=jdbc:mysql://192.168.0.152:3306/o2o?useUnicode=true&characterEncoding=utf8
jdbc.slave.username=root
jdbc.slave.password=root

測試

  我們在執行查詢操作時,就會從從庫中去查詢,我們可以通過檢視日誌的知,如下:

  當我們執行增刪改操作時,就會使用從庫的資料來源,如下:

  通過測試可知,我們配置主從分離,程式碼層實現已經成功了,我們從日誌也可以看到,我們的系統使用者執行更多的操作都是在執行查詢操作,我們也可以配置一主多從來減輕伺服器的壓力。

相關文章