您的位置: 首页  >  文章  >  Spring配置多数据源实现数据库读写分离

Spring配置多数据源实现数据库读写分离

分类: 文章 • 2023-12-04 10:17:58

之前一直想要实现通过Spring进行多数据源的配置，偶然发现一篇极好的博客！


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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

Java代码  Spring配置多数据源实现数据库读写分离
  1. public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean  {}  

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {  
  2.   
  3.     private Map<Object, Object> targetDataSources;  
  4.   
  5.     private Object defaultTargetDataSource;  
  6.   
  7.     private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();  
  8.   
  9.     private Map<Object, DataSource> resolvedDataSources;  
  10.   
  11.     private DataSource resolvedDefaultDataSource;  

 

　　  AbstractRoutingDataSource继承了AbstractDataSource ，而AbstractDataSource 又是DataSource 的子类。

DataSource   是javax.sql 的数据源接口，定义如下：

Java代码  Spring配置多数据源实现数据库读写分离
  1. public interface DataSource  extends CommonDataSource,Wrapper {  
  2.   
  3.   Connection getConnection() throws SQLException;  
  4.    
  5.   Connection getConnection(String username, String password)  
  6.     throws SQLException;  
  7. }  

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

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. public Connection getConnection() throws SQLException {  
  2.     return determineTargetDataSource().getConnection();  
  3. }  
  4.   
  5. public Connection getConnection(String username, String password) throws SQLException {  
  6.     return determineTargetDataSource().getConnection(username, password);  
  7. }  

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

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. protected DataSource determineTargetDataSource() {  
  2.         Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");  
  3.         Object lookupKey = determineCurrentLookupKey();  
  4.         DataSource dataSource = this.resolvedDataSources.get(lookupKey);  
  5.         if (dataSource == null && (this.lenientFallback || lookupKey == null)) {  
  6.             dataSource = this.resolvedDefaultDataSource;  
  7.         }  
  8.         if (dataSource == null) {  
  9.             throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");  
  10.         }  
  11.         return dataSource;  
  12.     }  

 

我们最关心的还是下面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的定义：

Java代码  Spring配置多数据源实现数据库读写分离
  1. @Retention(RetentionPolicy.RUNTIME)  
  2. @Target(ElementType.METHOD)  
  3. public @interface DataSource {  
  4.     String value();  
  5. }  

 

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

Java代码  Spring配置多数据源实现数据库读写分离
  1. public class DynamicDataSource extends AbstractRoutingDataSource {  
  2.   
  3.     @Override  
  4.     protected Object determineCurrentLookupKey() {  
  5.         // TODO Auto-generated method stub  
  6.         return DynamicDataSourceHolder.getDataSouce();  
  7.     }  
  8.   
  9. }  
  10.   
  11.   
  12. public class DynamicDataSourceHolder {  
  13.     public static final ThreadLocal<String> holder = new ThreadLocal<String>();  
  14.   
  15.     public static void putDataSource(String name) {  
  16.         holder.set(name);  
  17.     }  
  18.   
  19.     public static String getDataSouce() {  
  20.         return holder.get();  
  21.     }  
  22. }  

 

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

Java代码  Spring配置多数据源实现数据库读写分离
  1. public class DataSourceAspect {  
  2.   
  3.     public void before(JoinPoint point)  
  4.     {  
  5.         Object target = point.getTarget();  
  6.         String method = point.getSignature().getName();  
  7.   
  8.         Class<?>[] classz = target.getClass().getInterfaces();  
  9.   
  10.         Class<?>[] parameterTypes = ((MethodSignature) point.getSignature())  
  11.                 .getMethod().getParameterTypes();  
  12.         try {  
  13.             Method m = classz[0].getMethod(method, parameterTypes);  
  14.             if (m != null && m.isAnnotationPresent(DataSource.class)) {  
  15.                 DataSource data = m  
  16.                         .getAnnotation(DataSource.class);  
  17.                 DynamicDataSourceHolder.putDataSource(data.value());  
  18.                 System.out.println(data.value());  
  19.             }  
  20.               
  21.         } catch (Exception e) {  
  22.             // TODO: handle exception  
  23.         }  
  24.     }  
  25. }  

 

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

Xml代码  Spring配置多数据源实现数据库读写分离
  1. <bean id="masterdataSource"  
  2.         class="org.springframework.jdbc.datasource.DriverManagerDataSource">  
  3.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />  
  4.         <property name="url" value="jdbc:mysql://127.0.0.1:3306/shop" />  
  5.         <property name="username" value="root" />  
  6.         <property name="password" value="yangyanping0615" />  
  7.     </bean>  
  8.   
  9.     <bean id="slavedataSource"  
  10.         class="org.springframework.jdbc.datasource.DriverManagerDataSource">  
  11.         <property name="driverClassName" value="com.mysql.jdbc.Driver" />  
  12.         <property name="url" value="jdbc:mysql://127.0.0.1:3306/test" />  
  13.         <property name="username" value="root" />  
  14.         <property name="password" value="yangyanping0615" />  
  15.     </bean>  
  16.       
  17.         <beans:bean id="dataSource" class="com.air.shop.common.db.DynamicDataSource">  
  18.         <property name="targetDataSources">    
  19.               <map key-type="java.lang.String">    
  20.                   <!-- write -->  
  21.                  <entry key="master" value-ref="masterdataSource"/>    
  22.                  <!-- read -->  
  23.                  <entry key="slave" value-ref="slavedataSource"/>    
  24.               </map>    
  25.                 
  26.         </property>    
  27.         <property name="defaultTargetDataSource" ref="masterdataSource"/>    
  28.     </beans:bean>  
  29.   
  30.     <bean id="transactionManager"  
  31.         class="org.springframework.jdbc.datasource.DataSourceTransactionManager">  
  32.         <property name="dataSource" ref="dataSource" />  
  33.     </bean>  
  34.   
  35.   
  36.     <!-- 配置SqlSessionFactoryBean -->  
  37.     <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
  38.         <property name="dataSource" ref="dataSource" />  
  39.         <property name="configLocation" value="classpath:config/mybatis-config.xml" />  
  40.     </bean>  

 

　　在spring的配置中增加aop配置

Xml代码  Spring配置多数据源实现数据库读写分离
  1. <!-- 配置数据库注解aop -->  
  2.     <aop:aspectj-autoproxy></aop:aspectj-autoproxy>  
  3.     <beans:bean id="manyDataSourceAspect" class="com.air.shop.proxy.DataSourceAspect" />  
  4.     <aop:config>  
  5.         <aop:aspect id="c" ref="manyDataSourceAspect">  
  6.             <aop:pointcut id="tx" expression="execution(* com.air.shop.mapper.*.*(..))"/>  
  7.             <aop:before pointcut-ref="tx" method="before"/>  
  8.         </aop:aspect>  
  9.     </aop:config>  
  10.     <!-- 配置数据库注解aop -->  

 

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

Java代码  Spring配置多数据源实现数据库读写分离
  1. public interface UserMapper {  
  2.     @DataSource("master")  
  3.     public void add(User user);  
  4.   
  5.     @DataSource("master")  
  6.     public void update(User user);  
  7.   
  8.     @DataSource("master")  
  9.     public void delete(int id);  
  10.   
  11.     @DataSource("slave")  
  12.     public User loadbyid(int id);  
  13.   
  14.     @DataSource("master")  
  15.     public User loadbyname(String name);  
  16.       
  17.     @DataSource("slave")  
  18.     public List<User> list();  
  19. }  

 

 

　　 好了，运行我们的Eclipse看看效果，输入用户名admin 登录看看效果


Spring配置多数据源实现数据库读写分离
 
Spring配置多数据源实现数据库读写分离
 

从图中可以看出，登录的用户和用户列表的数据是不同的，也验证了我们的实现，登录读取Master库，用户列表读取Slave库。

例子来源：

http://www.cnblogs.com/surge/p/3582248.html

 

 

 二、配置动态数据源

Xml代码  Spring配置多数据源实现数据库读写分离
  1.   <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">  
  2.     <property name="jndiName">  
  3.         <value>java:/datasources/visesbdb</value>  
  4.     </property>  
  5.   </bean>  
  6.     
  7.   <!-- config dynamicDataSource -->  
  8.   <bean id="dynamicDataSource" class="com.vispractice.soa.lightesb.common.datasource.MutiDataSourceBean">  
  9. <property name="targetDataSources">  
  10.     <map key-type="java.lang.String">  
  11.         <entry value-ref="dataSource" key="dataSource"></entry>  
  12.     </map>  
  13. </property>  
  14.     <property name="defaultTargetDataSource" ref="dataSource"></property>  
  15.   </bean>  
  16.     
  17.   <bean class="org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor"/>  
  18.   
  19.   <!-- Hibernate SessionFactory -->  
  20.   <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">  
  21.       <property name="dataSource" ref="dynamicDataSource"/>  
  22.       <property name="packagesToScan">  
  23.         <list>  
  24.             <value>com.vispractice.soa.lightesb.bean</value>  
  25.         </list>  
  26.       </property>  
  27.       <property name="hibernateProperties">  
  28.           <props>  
  29. <prop key="connection.useUnicode">true</prop>  
  30. <prop key="connection.characterEncoding">UTF-8</prop>  
  31. <prop key="hibernate.dialect">${hibernate.dialect}</prop>  
  32. <prop key="hibernate.hbm2ddl.auto">${hibernate.hbm2ddl.auto}</prop>  
  33. <prop key="hibernate.show_sql">${hibernate.show_sql}</prop>  
  34. <prop key="hibernate.format_sql">${hibernate.format_sql}</prop>  
  35. <prop key="hibernate.cache.use_second_level_cache">${hibernate.cache.use_second_level_cache}</prop>  
  36. <prop key="hibernate.cache.use_query_cache">${hibernate.cache.use_query_cache}</prop>  
  37.    </props>              
  38.       </property>  
  39.   </bean>  
  40.   
  41.   <!-- Transaction manager for a single Hibernate SessionFactory (alternative to JTA) -->  
  42.   <bean id="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">  
  43.       <property name="sessionFactory" ref="sessionFactory"/>  
  44.   </bean>  

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. /** 
  2.  * 在applicationContext中配置本地数据源作为默认数据源 
  3.  * 读取project-datasource-jndi.properties中的jndi名称获取其他节点的数据源 
  4.  * 该文件放在D:\jboss-5.1.0.GA\server\default\conf\props 目录下 
  5.  * 
  6.  */  
  7. public class MutiDataSourceBean extends AbstractRoutingDataSource implements ApplicationContextAware {  
  8.   
  9.     private static final Logger logger = LoggerFactory.getLogger(MutiDataSourceBean.class);  
  10.   
  11.     private static ApplicationContext ctx;  
  12.       
  13.     private Map<Object,Object> tds = new HashMap<Object,Object>();  
  14.   
  15.     @Override  
  16.     public void setApplicationContext(ApplicationContext applicationContext)  
  17.             throws BeansException {  
  18.         ctx = applicationContext;  
  19.     }  
  20.   
  21.     @Override  
  22.     protected Object determineCurrentLookupKey() {  
  23.         return DataSourceContextHolder.getDataSourceType();  
  24.     }  
  25.   
  26.     //重写InitializingBean类中方法  
  27.     @Override  
  28.     public void afterPropertiesSet() {  
  29.         logger.info("Init MutiDataSource start...");  
  30.         try {  
  31.             initailizeMutiDataSource();  
  32.         } catch (Exception e) {  
  33.             logger.error("Init MutiDataSource error...", e);  
  34.         }  
  35.         logger.info("Init MutiDataSource end...");  
  36.         super.afterPropertiesSet();  
  37.     }  
  38.   
  39.     /** 
  40.      * 读取配置文件中的jndi名称，获取数据源 
  41.      * @throws Exception 
  42.      */  
  43.     private void initailizeMutiDataSource() throws Exception {  
  44.         // 读取数据源配置文件  
  45.         ResourceBundle lw = ResourceBundle.getBundle("props.project-datasource-jndi");  
  46.           
  47.         // 初始化jndi context  
  48.         Context jndiCtx = new InitialContext();  
  49.           
  50.         DefaultListableBeanFactory dlbf  = (DefaultListableBeanFactory) ctx.getAutowireCapableBeanFactory();  
  51.           
  52.         // 获取配置的数据源  
  53.         for(String key : lw.keySet()){  
  54.             Object ds = jndiCtx.lookup(lw.getString(key));  
  55.             // 将数据源交给spring管理  
  56.             dlbf.registerSingleton(key, ds);  
  57.               
  58.             tds.put(key, ds);  
  59.         }  
  60.         super.setTargetDataSources(tds);  
  61.     }  
  62.   
  63.     @Override  
  64.     public void setTargetDataSources(Map<Object, Object> targetDataSources) {  
  65.         tds = targetDataSources;  
  66.         super.setTargetDataSources(targetDataSources);  
  67.     }  
  68.   
  69. }  

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. /** 
  2.  * 通过ThreadLocal来存储当前所使用数据源对应的key 
  3.  *  
  4.  */  
  5. public class DataSourceContextHolder {  
  6.   
  7.     private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();  
  8.   
  9.     public static void setDataSourceType(String dataSourceType) {  
  10.         contextHolder.set(dataSourceType);  
  11.     }  
  12.   
  13.     public static String getDataSourceType() {  
  14.         return contextHolder.get();  
  15.     }  
  16.   
  17.     public static void clearDataSourceType() {  
  18.         contextHolder.remove();  
  19.     }  
  20. }  

 

查询前设置值：

Java代码  Spring配置多数据源实现数据库读写分离
  1. MutiDataSourceUtil.determineTargetDataSourceByInstanceUUID(EsbServiceInstanceV.getInstanceUUID());  
  2.         Map<String,Object> result = esbServiceMonitorDao.findEsbServiceInstanceVPagedList(pageQueryParameter, EsbServiceInstanceV);  
  3.         // reset datasource  
  4.         DataSourceContextHolder.clearDataSourceType();  

 

Java代码  Spring配置多数据源实现数据库读写分离
  1. public class MutiDataSourceUtil {  
  2.       
  3.     /** 
  4.      * 通过实例UUID切换到对应的数据源 
  5.      *  
  6.      * @param instanceUUID 
  7.      */  
  8.     public static void determineTargetDataSourceByInstanceUUID(String instanceUUID) {  
  9.         if(StringUtils.isNotBlank(instanceUUID) && StringUtils.contains(instanceUUID, '-')){  
  10.             DataSourceContextHolder.setDataSourceType(StringUtils.substringBefore(instanceUUID, "-"));  
  11.         }  
  12.     }  
  13.   
  14. }  

 

lightesb-datasource-jndi.properties：

Xml代码  Spring配置多数据源实现数据库读写分离
  1. N1=java:/datasources/visesbdb  
  2. N2=java:/datasources/n2visesbdb  

相关推荐