使用Spring解决ibatis多数据源的苦恼

iBatis多数据源的苦恼

在仅使用ibatis时，多数据源简直就是梦魇，每多一个数据源就需要多一份sql-map-config配置文件。

采用spring的AbstractRoutingDataSource就可以简单的解决这个问题。

AbstractRoutingDataSource实现了javax.sql.DataSource接口，因此可以理解为一个虚拟的动态DataSource，在需要的时候根据上下文Context动态决定使用哪个数据源。

Spring+iBatis多数据源的配置

下面是一个完整的配置：

1. < beans xmlns="http://www.springframework.org/schema/beans" 
2.   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
3.   xmlns:aop="http://www.springframework.org/schema/aop" 
4.   xmlns:tx="http://www.springframework.org/schema/tx" 
5.   xmlns:jee="http://www.springframework.org/schema/jee" 
6.   xsi:schemaLocation="  
7.    http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  
8.    http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd  
9.    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd  
10.    http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.5.xsd"> 
11.  
12.  
13.  < !-- ========================= GENERAL DEFINITIONS ========================= --> 
14.  < jee:jndi-lookup id="ds0" jndi-name="jdbc/ds0"/> 
15.  < jee:jndi-lookup id="ds1" jndi-name="jdbc/ds1"/> 
16.  < jee:jndi-lookup id="ds2" jndi-name="jdbc/ds2"/> 
17.    
18.  < bean id="dataSource" class="com.xxx.xxx.util.DynamicDataSource">    
19.          < property name="targetDataSources">    
20.             < map key-type="java.lang.String">    
21.                < entry key="0" value-ref="ds0"/> 
22.                < entry key="1" value-ref="ds1"/> 
23.                < entry key="2" value-ref="ds2"/>    
24.             < /map>    
25.          < /property>    
26.          < property name="defaultTargetDataSource" ref="1"/>    
27.  < /bean> 
28.         < !-- SqlMap setup for iBATIS Database Layer --> 
29.  < bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean"> 
30.   < property name="dataSource" ref="dataSource"/> 
31.   < property name="configLocation" value="classpath:com/xxx/xxx/dao/sqlmap/sql-map-config.xml"/> 
32.  < /bean> 
33.         < bean id="testDAO" class="com.xxx.xxx.dao.impl.TestDAO"> 
34.   < property name="sqlMapClient" ref="sqlMapClient"/> 
35.  < /bean> 
36.         < bean id="testService" class="com.xxx.xxx.service.impl.TestService"> 
37.   < property name="testDAO" ref="testDAO"/> 
38.  < /bean> 
39. < /beans> 
40.    

其核心是DynamicDataSource，代码如下

1. package com.xxx.xxx.util;  
2.  
3. import org.apache.log4j.Logger;  
4. import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;  
5.  
6. public class DynamicDataSource extends AbstractRoutingDataSource {  
7.  
8.  static Logger log = Logger.getLogger("DynamicDataSource");  
9.  @Override 
10.  protected Object determineCurrentLookupKey() {  
11.   // TODO Auto-generated method stub  
12.   return DbContextHolder.getDbType();  
13.  }  
14.  
15. }  

上下文DbContextHolder为一线程安全的ThreadLocal，如下

1. package com.xxx.xxx.util;  
2.  
3. public class DbContextHolder {  
4.  private static final ThreadLocal contextHolder = new ThreadLocal();  
5.  
6.  public static void setDbType(String dbType) {  
7.   contextHolder.set(dbType);  
8.  }  
9.  
10.  public static String getDbType() {  
11.   return (String) contextHolder.get();  
12.  }  
13.  
14.  public static void clearDbType() {  
15.   contextHolder.remove();  
16.  }  
17. }  
18.    

sql-map-config.xml如下

1. < ?xml version="1.0" encoding="UTF-8" standalone="no"?> 
2. < !DOCTYPE sqlMapConfig PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN"  
3.         "http://www.ibatis.com/dtd/sql-map-config-2.dtd"> 
4.  
5. < sqlMapConfig> 
6.  
7.     < sqlMap resource="com/xxx/xxx/dao/sqlmap/Object.xml"/> 
8.  
9. < /sqlMapConfig> 
10.    

这样在调用service之前只需要设置一下上下文即可调用相应的数据源，如下：

1. DbContextHolder.setDbType("2");  
2. //execute services  
3. //.........  

dao如下

1. package com.xxx.xxx.dao.impl;  
2.  
3. import java.util.HashMap;  
4. import java.util.List;  
5. import java.util.Map;  
6.  
7. import org.apache.log4j.Logger;  
8. import org.springframework.orm.ibatis.support.SqlMapClientDaoSupport;  
9.  
10. import com.xxx.xxx.vo.TestObj;  
11.  
12. public class TestDAO extends SqlMapClientDaoSupport implements ITestDAO {  
13.  
14.     static Logger log = Logger.getLogger(TestDAO.class);  
15.  
16.     public TestObj getTestObj(String objID) throws Exception {  
17.         return (TestObj) getSqlMapClientTemplate().queryForObject("getTestObj", objID);  
18.     }  
19. }  

以上就介绍了Spring+iBatis多数据源的配置方案。本文来自eddysheng的博客：《基于spring和ibatis的多数据源切换方案》。

【编辑推荐】

1. 操作更简单 iBatis配置文件方法
2. 详细：iBatis配置实例
3. iBATIS ParameterMap配置实例浅析
4. iBATIS的多对多映射配置浅析
5. iBATIS中添加DAO的配置浅析