基于Spring的实现数据库读写分离

落日映苍穹つ 2022-07-12 07:20 152阅读 0赞

下面是我参考的文档，后面我直接上代码实现。

现在大型的电子商务系统，在数据库层面大都采用读写分离技术，就是一个Master数据库，多个Slave数据库。Master库负责数据更新和实时数据查询，Slave库当然负责非实时数据查询。因为在实际的应用中，数据库都是读多写少（读取数据的频率高，更新数据的频率相对较少），而读取数据通常耗时比较长，占用数据库服务器的CPU较多，从而影响用户体验。我们通常的做法就是把查询从主库中抽取出来，采用多个从库，使用负载均衡，减轻每个从库的查询压力。

采用读写分离技术的目标：有效减轻Master库的压力，又可以把用户查询数据的请求分发到不同的Slave库，从而保证系统的健壮性。我们看下采用读写分离的背景。

随着网站的业务不断扩展，数据不断增加，用户越来越多，数据库的压力也就越来越大，采用传统的方式，比如：数据库或者SQL的优化基本已达不到要求，这个时候可以采用读写分离的策 略来改变现状。

具体到开发中，如何方便的实现读写分离呢?目前常用的有两种方式：

1 第一种方式是我们最常用的方式，就是定义2个数据库连接，一个是MasterDataSource,另一个是SlaveDataSource。更新数据时我们读取MasterDataSource，查询数据时我们读取SlaveDataSource。这种方式很简单，我就不赘述了。

2 第二种方式动态数据源切换，就是在程序运行时，把数据源动态织入到程序中，从而选择读取主库还是从库。主要使用的技术是：annotation，Spring AOP ，反射。下面会详细的介绍实现方式。

在介绍实现方式之前，我们先准备一些必要的知识，spring 的AbstractRoutingDataSource 类

AbstractRoutingDataSource这个类 是spring2.0以后增加的，我们先来看下AbstractRoutingDataSource的定义：

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean  \{\}

AbstractRoutingDataSource继承了AbstractDataSource ，而AbstractDataSource 又是DataSource 的子类。DataSource   是javax.sql 的数据源接口，定义如下：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

public interface DataSource  extends CommonDataSource,Wrapper {
    
      /**
       * <p>Attempts to establish a connection with the data source that
       * this <code>DataSource</code> object represents.
       *
       * @return  a connection to the data source
       * @exception SQLException if a database access error occurs
       */
      Connection getConnection() throws SQLException;
    
      /**
       * <p>Attempts to establish a connection with the data source that
       * this <code>DataSource</code> object represents.
       *
       * @param username the database user on whose behalf the connection is
       *  being made
       * @param password the user's password
       * @return  a connection to the data source
       * @exception SQLException if a database access error occurs
       * @since 1.4
       */
      Connection getConnection(String username, String password)
        throws SQLException;
    
    }

![复制代码][copycode.gif]

DataSource 接口定义了2个方法，都是获取数据库连接。我们在看下AbstractRoutingDataSource 如何实现了DataSource接口：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

public Connection getConnection() throws SQLException {
            return determineTargetDataSource().getConnection();
        }
    
        public Connection getConnection(String username, String password) throws SQLException {
            return determineTargetDataSource().getConnection(username, password);
        }

![复制代码][copycode.gif]

很显然就是调用自己的determineTargetDataSource()  方法获取到connection。determineTargetDataSource方法定义如下：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

protected DataSource determineTargetDataSource() {
            Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");
            Object lookupKey = determineCurrentLookupKey();
            DataSource dataSource = this.resolvedDataSources.get(lookupKey);
            if (dataSource == null && (this.lenientFallback || lookupKey == null)) {
                dataSource = this.resolvedDefaultDataSource;
            }
            if (dataSource == null) {
                throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");
            }
            return dataSource;
        }

![复制代码][copycode.gif]

我们最关心的还是下面2句话：

Object lookupKey = determineCurrentLookupKey();  
        DataSource dataSource = this.resolvedDataSources.get(lookupKey);

determineCurrentLookupKey方法返回lookupKey,resolvedDataSources方法就是根据lookupKey从Map中获得数据源。resolvedDataSources 和determineCurrentLookupKey定义如下：

private Map<Object, DataSource> resolvedDataSources;

protected abstract Object determineCurrentLookupKey()

看到以上定义，我们是不是有点思路了，resolvedDataSources是Map类型，我们可以把MasterDataSource和SlaveDataSource存到Map中，如下：

key　　　　　　　　value

master　　           MasterDataSource

slave                  SlaveDataSource

我们在写一个类DynamicDataSource  继承AbstractRoutingDataSource，实现其determineCurrentLookupKey() 方法，该方法返回Map的key，master或slave。

好了，说了这么多，有点烦了，下面我们看下怎么实现。

上面已经提到了我们要使用的技术，我们先看下annotation的定义：

![ExpandedBlockStart.gif][]

@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface DataSource {
        String value();
    }

我们还需要实现spring的抽象类AbstractRoutingDataSource，就是实现determineCurrentLookupKey方法：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

public class DynamicDataSource extends AbstractRoutingDataSource {
    
        @Override
        protected Object determineCurrentLookupKey() {
            // TODO Auto-generated method stub
            return DynamicDataSourceHolder.getDataSouce();
        }
    
    }
    
    
    public class DynamicDataSourceHolder {
        public static final ThreadLocal<String> holder = new ThreadLocal<String>();
    
        public static void putDataSource(String name) {
            holder.set(name);
        }
    
        public static String getDataSouce() {
            return holder.get();
        }
    }

![复制代码][copycode.gif]

从DynamicDataSource 的定义看出，他返回的是DynamicDataSourceHolder.getDataSouce()值，我们需要在程序运行时调用DynamicDataSourceHolder.putDataSource()方法，对其赋值。下面是我们实现的核心部分，也就是AOP部分，DataSourceAspect定义如下:

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

public class DataSourceAspect {
    
        public void before(JoinPoint point)
        {
            Object target = point.getTarget();
            String method = point.getSignature().getName();
    
            Class<?>[] classz = target.getClass().getInterfaces();
    
            Class<?>[] parameterTypes = ((MethodSignature) point.getSignature())
                    .getMethod().getParameterTypes();
            try {
                Method m = classz[0].getMethod(method, parameterTypes);
                if (m != null && m.isAnnotationPresent(DataSource.class)) {
                    DataSource data = m
                            .getAnnotation(DataSource.class);
                    DynamicDataSourceHolder.putDataSource(data.value());
                    System.out.println(data.value());
                }
                
            } catch (Exception e) {
                // TODO: handle exception
            }
        }
    }

![复制代码][copycode.gif]

为了方便测试，我定义了2个数据库，shop模拟Master库，test模拟Slave库，shop和test的表结构一致，但数据不同，数据库配置如下：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

![复制代码][copycode.gif]

在spring的配置中增加aop配置

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
        <beans:bean id="manyDataSourceAspect" class="com.air.shop.proxy.DataSourceAspect" />
        <aop:config>
            <aop:aspect id="c" ref="manyDataSourceAspect">
                <aop:pointcut id="tx" expression="execution(* com.air.shop.mapper.*.*(..))"/>
                <aop:before pointcut-ref="tx" method="before"/>
            </aop:aspect>
        </aop:config>

![复制代码][copycode.gif]

下面是MyBatis的UserMapper的定义，为了方便测试，登录读取的是Master库，用户列表读取Slave库：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

public interface UserMapper {
        @DataSource("master")
        public void add(User user);
    
        @DataSource("master")
        public void update(User user);
    
        @DataSource("master")
        public void delete(int id);
    
        @DataSource("slave")
        public User loadbyid(int id);
    
        @DataSource("master")
        public User loadbyname(String name);
        
        @DataSource("slave")
        public List<User> list();
    }

自己的aop切面代理类：

import org.apache.commons.lang3.StringUtils;
    import org.apache.logging.log4j.LogManager;
    import org.apache.logging.log4j.Logger;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.context.annotation.EnableAspectJAutoProxy;
    /**
     * 切换数据源(不同方法调用不同数据源)
     */
    @Aspect
    @EnableAspectJAutoProxy(proxyTargetClass = true)
    public class DataSourceAspect {
     private final Logger logger = LogManager.getLogger();
    
     @Pointcut("execution(* com.innotek.dao..*.*(..))")
     public void aspect() {
     }
    
     /**
      * 配置前置通知,使用在方法aspect()上注册的切入点
      */
     @Before("aspect()")
     public void before(JoinPoint point) {
     String className = point.getTarget().getClass().getName();
     String method = point.getSignature().getName();
     /*logger.info(className + "." + method + "(" + StringUtils.join(point.getArgs(), ",") + ")");*/
     try {
     L: for (String key : ChooseDataSource.METHODTYPE.keySet()) {
     for (String type : ChooseDataSource.METHODTYPE.get(key)) {
     if (method.startsWith(type)) {
     HandleDataSource.putDataSource(key);
     break L;
     }
     }
     }
     } catch (Exception e) {
     logger.error(e);
     HandleDataSource.putDataSource("write");
     }
     }
    }

datasource.xml文件配置如下：

<bean id="readDataSource" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close" init-method="init" lazy-init="true"> 		<description>只读数据库连接</description> <property name="driverClassName" value="${driver}" /> <property name="url" value="${reader.url}" /> <property name="username" value="${reader.username}" /> <property name="password" value="${reader.password}" />  <property name="initialSize" value="${initialSize}" />  <property name="maxActive" value="${maxActive}" />  <property name="minIdle" value="${minIdle}" />  <property name="maxWait" value="${maxWait}" />  <property name="defaultReadOnly" value="true" /> 		<property name="proxyFilters"> 			<list> 				<ref bean="stat-filter" /> 			</list> 		</property> <property name="filters" value="${druid.filters}" /> <property name="connectionProperties" value="password=${reader.password}" /> <property name="passwordCallback" ref="dbPasswordCallback" /> <property name="testWhileIdle" value="true" /> <property name="testOnBorrow" value="false" /> <property name="testOnReturn" value="false" /> <property name="validationQuery" value="SELECT 'x' from dual" /> <property name="timeBetweenLogStatsMillis" value="60000" />  <property name="minEvictableIdleTimeMillis" value="${minEvictableIdleTimeMillis}" />  <property name="timeBetweenEvictionRunsMillis" value="${timeBetweenEvictionRunsMillis}" /> 	</bean> <bean id="writeDataSource" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close" init-method="init" lazy-init="true"> 		<description>只写数据库连接</description> <property name="driverClassName" value="${driver}" /> <property name="url" value="${writer.url}" /> <property name="username" value="${writer.username}" /> <property name="password" value="${writer.password}" /> <property name="initialSize" value="${initialSize}" /> <property name="maxActive" value="${maxActive}" /> <property name="minIdle" value="${minIdle}" /> <property name="maxWait" value="${maxWait}" /> 		<property name="proxyFilters"> 			<list> 				<ref bean="stat-filter" /> 			</list> 		</property> <property name="filters" value="${druid.filters}" /> <property name="connectionProperties" value="password=${writer.password}" /> <property name="passwordCallback" ref="dbPasswordCallback" /> <property name="testWhileIdle" value="true" /> <property name="testOnBorrow" value="false" /> <property name="testOnReturn" value="false" /> <property name="validationQuery" value="SELECT 'x' from dual" /> <property name="timeBetweenLogStatsMillis" value="60000" /> <property name="minEvictableIdleTimeMillis" value="${minEvictableIdleTimeMillis}" /> <property name="timeBetweenEvictionRunsMillis" value="${timeBetweenEvictionRunsMillis}" /> 	</bean> <bean id="dataSource" class="com.innotek.core.aspect.ChooseDataSource" lazy-init="true"> 		<description>数据源</description> <property name="targetDataSources"> <map key-type="java.lang.String" value-type="javax.sql.DataSource">  <entry key="write" value-ref="writeDataSource" />  <entry key="read" value-ref="readDataSource" /> 			</map> 		</property> <property name="defaultTargetDataSource" ref="writeDataSource" /> 		<property name="methodType"> <map key-type="java.lang.String">  <entry key="read" value=",get,select,count,list,query," />  <entry key="write" value=",add,insert,create,update,delete,remove," /> 			</map> 		</property> 	</bean> <bean class="*.DataSourceAspect" /> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> 		<description>spring和MyBatis完美整合，不需要mybatis的配置映射文件</description> <property name="dataSource" ref="dataSource" /> <property name="configLocation" value="classpath:mybatis-config.xml" />  <property name="mapperLocations" value="classpath:mappers/**/*.xml" /> 	</bean> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 		<description>DAO接口所在包名，Spring会自动查找其下的类</description> <property name="basePackage" value="com.innotek.dao.*" /> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" /> 	</bean>      <bean id="transactionManager"           class="org.springframework.jdbc.datasource.DataSourceTransactionManager">         <property name="dataSource" ref="dataSource"/>     </bean>     <tx:annotation-driven transaction-manager="transactionManager"/>

public class ChooseDataSource extends AbstractRoutingDataSource {
         	public static Map<String, List<String>> METHODTYPE = new HashMap<String, List<String>>(); 
     // 获取数据源名称 	protected Object determineCurrentLookupKey() {
         		return HandleDataSource.getDataSource(); 	} 
     // 设置方法名前缀对应的数据源 	public void setMethodType(Map<String, String> map) {
         		for (String key : map.keySet()) {
         			List<String> v = new ArrayList<String>(); 			String[] types = map.get(key).split(","); 			for (String type : types) {
         				if (StringUtils.isNotBlank(type)) {
         					v.add(type); 				} 			} 			METHODTYPE.put(key, v); 		} 	} }

public class HandleDataSource {
         // 数据源名称线程池 	private static final ThreadLocal<String> holder = new ThreadLocal<String>(); 
     	public static void putDataSource(String datasource) {
         holder.set(datasource); 	} 
     	public static String getDataSource() {
         		return holder.get(); 	} } 
     
     initialSize=20 maxActive=40 maxIdle=20 minIdle=1 maxWait=60000 timeBetweenEvictionRunsMillis=3000 minEvictableIdleTimeMillis=300000 maxPoolPreparedStatementPerConnectionSize=20

[ExpandedBlockStart.gif]: /images/20220711/8156f31fc8474098bb3cd94b9f492de9.png
[copycode.gif]: /images/20220711/da5cb175e75f4982b6a13ed3fbd36e49.png