Spring AOP 实现读写分离（MySQL实现主从复制）

痛定思痛。 2022-07-13 13:41 233阅读 0赞

1、Mysql的主从复制

1.1 mysql主(称master)从(称slave)复制的原理

1、master将数据改变记录到二进制日志(binarylog)中,也即是配置文件log-bin指定的文件(这些记录叫做二进制日志事件，binary log events)

2、slave将master的binary logevents拷贝到它的中继日志(relay log)

3、slave重做中继日志中的事件,将改变反映它自己的数据(数据重演)

![20170111143513773][]

1.2 主从配置需要注意的地方

1、主DB server和从DB server数据库的版本一致

2、主DB server和从DB server数据库数据一致\[ 这里就会可以把主的备份在从上还原，也可以直接将主的数据目录拷贝到从的相应数据目录\]

3、主DB server开启二进制日志,主DB server和从DB server的server\_id都必须唯一

1.3 主从的配置

Mysql主从的配置博客地址  [http://blog.csdn.net/zbw18297786698/article/details/51088292][http_blog.csdn.net_zbw18297786698_article_details_51088292]

2、使用Spring实现Mysql的读写分离

2.1  原理图

![20170111150248819][]

在进入Service之前，使用AOP来做出判断，是使用写库还是读库，判断依据可以根据方法名判断，比如说以query、find、get等开头的就走读库，其他的走写库。

2.2   DynamicDataSource.java

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
    /**
     * 定义动态数据源，实现通过集成Spring提供的AbstractRoutingDataSource，只需要实现determineCurrentLookupKey方法即可
     * 
     * 由于DynamicDataSource是单例的，线程不安全的，所以采用ThreadLocal保证线程安全，由DynamicDataSourceHolder完成。
     * 
     * @author zhijun
     *
     */
    public class DynamicDataSource extends AbstractRoutingDataSource{
    
        @Override
        protected Object determineCurrentLookupKey() {
            // 使用DynamicDataSourceHolder保证线程安全，并且得到当前线程中的数据源key
            return DynamicDataSourceHolder.getDataSourceKey();
        }
    
    }

2.3  DynamicDataSourceHolder.java

/**
     * 
     * 使用ThreadLocal技术来记录当前线程中的数据源的key
     * 
     * @author zhijun
     *
     */
    public class DynamicDataSourceHolder {
        
        //写库对应的数据源key
        private static final String MASTER = "master";
    
        //读库对应的数据源key
        private static final String SLAVE = "slave";
        
        //使用ThreadLocal记录当前线程的数据源key
        private static final ThreadLocal<String> holder = new ThreadLocal<String>();
    
        /**
         * 设置数据源key
         * @param key
         */
        public static void putDataSourceKey(String key) {
            holder.set(key);
        }
    
        /**
         * 获取数据源key
         * @return
         */
        public static String getDataSourceKey() {
            return holder.get();
        }
        
        /**
         * 标记写库
         */
        public static void markMaster(){
            putDataSourceKey(MASTER);
        }
        
        /**
         * 标记读库
         */
        public static void markSlave(){
            putDataSourceKey(SLAVE);
        }
    
    }

2.4 DataSourceAspect.java

import org.apache.commons.lang3.StringUtils;
    import org.aspectj.lang.JoinPoint;/**
     * 定义数据源的AOP切面，通过该Service的方法名判断是应该走读库还是写库
     *  * @author zhijun
     *
     */
    public class DataSourceAspect {
        /**
         * 在进入Service方法之前执行
         * 
         * @param point 切面对象
         */
        public void before(JoinPoint point) {
            // 获取到当前执行的方法名
            String methodName = point.getSignature().getName();
            if (isSlave(methodName)) {
                // 标记为读库
                DynamicDataSourceHolder.markSlave();
            } else {
                // 标记为写库
                DynamicDataSourceHolder.markMaster();
            }
        }
    
        /**
         * 判断是否为读库
         * 
         * @param methodName
         * @return
         */
        private Boolean isSlave(String methodName) {
            // 方法名以query、find、get开头的方法名走从库
            return StringUtils.startsWithAny(methodName, "query", "find", "get");
        }
    
    }

2.5  配置2个数据源

2.5.1  jdbc.properties

jdbc.master.driver=com.mysql.jdbc.Driver
    jdbc.master.url=jdbc:mysql://192.168.2.112:3306/test_bin
    jdbc.master.username=root
    jdbc.master.password=123456
    
    jdbc.slave01.driver=com.mysql.jdbc.Driver
    jdbc.slave01.url=jdbc:mysql://192.168.2.113:3306/test_bin
    jdbc.slave01.username=root
    jdbc.slave01.password=123456

2.5.2   定义连接池

<bean id="masterDataSource" class="com.jolbox.bonecp.BoneCPDataSource"
    		destroy-method="close">
    		
    		<property name="driverClass" value="${jdbc.master.driver}" />
    		
    		<property name="jdbcUrl" value="${jdbc.master.url}" />
    		
    		<property name="username" value="${jdbc.master.username}" />
    		
    		<property name="password" value="${jdbc.master.password}" />
    		
    		<property name="idleConnectionTestPeriod" value="60" />
    		
    		<property name="idleMaxAge" value="30" />
    		
    		<property name="maxConnectionsPerPartition" value="150" />
    		
    		<property name="minConnectionsPerPartition" value="5" />
    	</bean>
    	
    
    	<bean id="slave01DataSource" class="com.jolbox.bonecp.BoneCPDataSource"
    		destroy-method="close">
    		
    		<property name="driverClass" value="${jdbc.slave01.driver}" />
    		
    		<property name="jdbcUrl" value="${jdbc.slave01.url}" />
    		
    		<property name="username" value="${jdbc.slave01.username}" />
    		
    		<property name="password" value="${jdbc.slave01.password}" />
    		
    		<property name="idleConnectionTestPeriod" value="60" />
    		
    		<property name="idleMaxAge" value="30" />
    		
    		<property name="maxConnectionsPerPartition" value="150" />
    		
    		<property name="minConnectionsPerPartition" value="5" />
    	</bean>

2.5.3  定义DataSource

<bean id="dataSource" class="cn.itcast.usermanage.spring.DynamicDataSource">
    		
    		<property name="targetDataSources">
    			<map key-type="java.lang.String">
    				
    				<entry key="master" value-ref="masterDataSource"/>
    				<entry key="slave" value-ref="slave01DataSource"/>
    			</map>
    		</property>
    		
    		<property name="defaultTargetDataSource" ref="masterDataSource"/>
    	</bean>

4、配置事务管理以及动态切换数据源切面

4.1  定义事务管理器

<bean id="transactionManager"
    		class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    		<property name="dataSource" ref="dataSource" />
    	</bean>

4.2  定义事务策略

<tx:advice id="txAdvice" transaction-manager="transactionManager">
    		<tx:attributes>
    			
    			<tx:method name="query*" read-only="true" />
    			<tx:method name="find*" read-only="true" />
    			<tx:method name="get*" read-only="true" />
    
    			
    			<tx:method name="save*" propagation="REQUIRED" />
    			<tx:method name="update*" propagation="REQUIRED" />
    			<tx:method name="delete*" propagation="REQUIRED" />
    
    			
    			<tx:method name="*" />
    		</tx:attributes>
    	</tx:advice>

4.3  定义切面

<bean class="cn.itcast.usermanage.spring.DataSourceAspect" id="dataSourceAspect">
    		
    		<property name="txAdvice" ref="txAdvice" />
    		
    		
    
    	</bean>
    
    	<aop:config>
    		
    		<aop:pointcut id="myPointcut"
    			expression="execution(* cn.itcast.usermanage.service.*.*(..))" />
    		
    		<aop:advisor advice-ref="txAdvice" pointcut-ref="myPointcut" />
    
    		
    		<aop:aspect ref="dataSourceAspect" order="-9999">
    			<aop:before method="before" pointcut-ref="myPointcut" />
    		</aop:aspect>
    	</aop:config>

5、改进切面实现，使用事务策略规则匹配

5.1 改进后的配置

5.2改进后的实现

import java.lang.reflect.Field;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Map;
    
    import org.apache.commons.lang3.StringUtils;
    import org.aspectj.lang.JoinPoint;
    import org.springframework.transaction.interceptor.NameMatchTransactionAttributeSource;
    import org.springframework.transaction.interceptor.TransactionAttribute;
    import org.springframework.transaction.interceptor.TransactionAttributeSource;
    import org.springframework.transaction.interceptor.TransactionInterceptor;
    import org.springframework.util.PatternMatchUtils;
    import org.springframework.util.ReflectionUtils;
    
    /**
     * 定义数据源的AOP切面，该类控制了使用Master还是Slave。
     * 
     * 如果事务管理中配置了事务策略，则采用配置的事务策略中的标记了ReadOnly的方法是用Slave，其它使用Master。
     * 
     * 如果没有配置事务管理的策略，则采用方法名匹配的原则，以query、find、get开头方法用Slave，其它用Master。
     * 
     * @author zhijun
     *
     */
    public class DataSourceAspect {
    
        private List<String> slaveMethodPattern = new ArrayList<String>();
        
        private static final String[] defaultSlaveMethodStart = new String[]{ "query", "find", "get" };
        
        private String[] slaveMethodStart;
    
        /**
         * 读取事务管理中的策略
         * 
         * @param txAdvice
         * @throws Exception
         */
        @SuppressWarnings("unchecked")
        public void setTxAdvice(TransactionInterceptor txAdvice) throws Exception {
            if (txAdvice == null) {
                // 没有配置事务管理策略
                return;
            }
            //从txAdvice获取到策略配置信息
            TransactionAttributeSource transactionAttributeSource = txAdvice.getTransactionAttributeSource();
            if (!(transactionAttributeSource instanceof NameMatchTransactionAttributeSource)) {
                return;
            }
            //使用反射技术获取到NameMatchTransactionAttributeSource对象中的nameMap属性值
            NameMatchTransactionAttributeSource matchTransactionAttributeSource = (NameMatchTransactionAttributeSource) transactionAttributeSource;
            Field nameMapField = ReflectionUtils.findField(NameMatchTransactionAttributeSource.class, "nameMap");
            nameMapField.setAccessible(true); //设置该字段可访问
            //获取nameMap的值
            Map<String, TransactionAttribute> map = (Map<String, TransactionAttribute>) nameMapField.get(matchTransactionAttributeSource);
    
            //遍历nameMap
            for (Map.Entry<String, TransactionAttribute> entry : map.entrySet()) {
                if (!entry.getValue().isReadOnly()) {//判断之后定义了ReadOnly的策略才加入到slaveMethodPattern
                    continue;
                }
                slaveMethodPattern.add(entry.getKey());
            }
        }
    
        /**
         * 在进入Service方法之前执行
         * 
         * @param point 切面对象
         */
        public void before(JoinPoint point) {
            // 获取到当前执行的方法名
            String methodName = point.getSignature().getName();
    
            boolean isSlave = false;
    
            if (slaveMethodPattern.isEmpty()) {
                // 当前Spring容器中没有配置事务策略，采用方法名匹配方式
                isSlave = isSlave(methodName);
            } else {
                // 使用策略规则匹配
                for (String mappedName : slaveMethodPattern) {
                    if (isMatch(methodName, mappedName)) {
                        isSlave = true;
                        break;
                    }
                }
            }
    
            if (isSlave) {
                // 标记为读库
                DynamicDataSourceHolder.markSlave();
            } else {
                // 标记为写库
                DynamicDataSourceHolder.markMaster();
            }
        }
    
        /**
         * 判断是否为读库
         * 
         * @param methodName
         * @return
         */
        private Boolean isSlave(String methodName) {
            // 方法名以query、find、get开头的方法名走从库
            return StringUtils.startsWithAny(methodName, getSlaveMethodStart());
        }
    
        /**
         * 通配符匹配
         * 
         * Return if the given method name matches the mapped name.
         * <p>
         * The default implementation checks for "xxx*", "*xxx" and "*xxx*" matches, as well as direct
         * equality. Can be overridden in subclasses.
         * 
         * @param methodName the method name of the class
         * @param mappedName the name in the descriptor
         * @return if the names match
         * @see org.springframework.util.PatternMatchUtils#simpleMatch(String, String)
         */
        protected boolean isMatch(String methodName, String mappedName) {
            return PatternMatchUtils.simpleMatch(mappedName, methodName);
        }
    
        /**
         * 用户指定slave的方法名前缀
         * @param slaveMethodStart
         */
        public void setSlaveMethodStart(String[] slaveMethodStart) {
            this.slaveMethodStart = slaveMethodStart;
        }
    
        public String[] getSlaveMethodStart() {
            if(this.slaveMethodStart == null){
                // 没有指定，使用默认
                return defaultSlaveMethodStart;
            }
            return slaveMethodStart;
        }
        
    }

6、一主多从的实现

5.1  一主多从的介绍

多实际使用场景下都是采用“一主多从”的架构的，所有我们现在对这种架构做支持，目前只需要修改DynamicDataSource即可。

![20170111161043099][]

5.2 实现

import java.lang.reflect.Field;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Map;
    import java.util.concurrent.atomic.AtomicInteger;
    
    import javax.sql.DataSource;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
    import org.springframework.util.ReflectionUtils;
    
    /**
     * 定义动态数据源，实现通过集成Spring提供的AbstractRoutingDataSource，只需要实现determineCurrentLookupKey方法即可
     * 
     * 由于DynamicDataSource是单例的，线程不安全的，所以采用ThreadLocal保证线程安全，由DynamicDataSourceHolder完成。
     * 
     * @author zhijun
     *
     */
    public class DynamicDataSource extends AbstractRoutingDataSource {
    
        private static final Logger LOGGER = LoggerFactory.getLogger(DynamicDataSource.class);
    
        private Integer slaveCount;
    
        // 轮询计数,初始为-1,AtomicInteger是线程安全的
        private AtomicInteger counter = new AtomicInteger(-1);
    
        // 记录读库的key
        private List<Object> slaveDataSources = new ArrayList<Object>(0);
    
        @Override
        protected Object determineCurrentLookupKey() {
            // 使用DynamicDataSourceHolder保证线程安全，并且得到当前线程中的数据源key
            if (DynamicDataSourceHolder.isMaster()) {
                Object key = DynamicDataSourceHolder.getDataSourceKey(); 
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("当前DataSource的key为: " + key);
                }
                return key;
            }
            Object key = getSlaveKey();
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("当前DataSource的key为: " + key);
            }
            return key;
    
        }
    
        @SuppressWarnings("unchecked")
        @Override
        public void afterPropertiesSet() {
            super.afterPropertiesSet();
    
            // 由于父类的resolvedDataSources属性是私有的子类获取不到，需要使用反射获取
            Field field = ReflectionUtils.findField(AbstractRoutingDataSource.class, "resolvedDataSources");
            field.setAccessible(true); // 设置可访问
    
            try {
                Map<Object, DataSource> resolvedDataSources = (Map<Object, DataSource>) field.get(this);
                // 读库的数据量等于数据源总数减去写库的数量
                this.slaveCount = resolvedDataSources.size() - 1;
                for (Map.Entry<Object, DataSource> entry : resolvedDataSources.entrySet()) {
                    if (DynamicDataSourceHolder.MASTER.equals(entry.getKey())) {
                        continue;
                    }
                    slaveDataSources.add(entry.getKey());
                }
            } catch (Exception e) {
                LOGGER.error("afterPropertiesSet error! ", e);
            }
        }
    
        /**
         * 轮询算法实现
         * 
         * @return
         */
        public Object getSlaveKey() {
            // 得到的下标为：0、1、2、3……
            Integer index = counter.incrementAndGet() % slaveCount;
            if (counter.get() > 9999) { // 以免超出Integer范围
                counter.set(-1); // 还原
            }
            return slaveDataSources.get(index);
        }
    
    }

6、 [源码下载][Link 1]

[20170111143513773]: /images/20220713/a280a80f7bc3461f88134dd53610a64b.png
[http_blog.csdn.net_zbw18297786698_article_details_51088292]: http://blog.csdn.net/zbw18297786698/article/details/51088292
[20170111150248819]: /images/20220713/47f95ac5cd3e434bb041ba8ff61b85c2.png
[20170111161043099]: /images/20220713/156404516b9a4b299fb6e820ae7889e5.png
[Link 1]: http://pan.baidu.com/s/1bo4q2Er