SSM项目下多数据源配置与使用

2021-05-26

背景

因线上业务平台数据量巨大单库操作性能已经非常缓慢,所以需要对web应用进行模块拆分与数据库分库分表的改造.

配置

SSM 多数据源配置,以及使用 org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource 动态切换数据源

SSM项目首先还是从web.xml配置文件开始, 其中重点在applicationContext.xml它是多数据源以及动态数据源的配置文件

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath*:applicationContext.xml</param-value>
</context-param>
<!-- 监听器拉起spring容器 -->
<listener>
    <display-name>spring</display-name>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- 过滤器过滤字符编码 -->
<filter>
    <filter-name>encodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    ...
</filter>
<filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

<servlet>
    <servlet-name>mvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath*:spring-mvc.xml</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>mvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

applicationContext.xml

<bean id="resource" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
        <list>
            <value>classpath*: *.properties</value>
        </list>
    </property>
</bean>
<!-- 多数据源配置 -->
<bean id="dataSource01" class="com.alibaba...DruidDataSource" init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.username1}"/>
    <property name="password" value="${jdbc.password1}"/>
</bean>
<bean id="dataSource02" class="com.alibaba...DruidDataSource" init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.username2}"/>
    <property name="password" value="${jdbc.password2}"/>
</bean>
<bean id="dataSourceXX" class="com.alibaba...DruidDataSource" init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.usernameXX}"/>
    <property name="password" value="${jdbc.passwordXX}"/>
</bean>
<!-- 这里需要自己写一个动态数据源的获取类 DynamicDataSource,该类继承自Spring的AbstractRoutingDataSource -->
<bean id="dataSource" class="com.test.util.DynamicDataSource">
    <!-- 默认库 -->
    <property name="defaultTargetDataSource" ref="dataSource01" />
    <property name="targetDataSources">
        <map key-type="java.lang.String">
            <!-- 指定lookupKey和与之对应的数据源 -->
            <entry key="dataSource02" value-ref="dataSource02"></entry>
            <entry key="dataSourceXX" value-ref="dataSourceXX"></entry>
            ...
        </map>
    </property>
</bean>

<!-- mybatis文件配置,扫描所有mapper文件,并将数据源指向自己实现的动态数据源id -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean" p:dataSource-ref="dataSource"
      p:mapperLocations="classpath*:mappers/**/*.xml"/>
<!-- spring与mybatis整合配置，扫描所有dao -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" p:basePackage="com.test.*.dao"
      p:sqlSessionFactoryBeanName="sqlSessionFactory"/>
<!-- 对dataSource 数据源进行事务管理 -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"
      p:dataSource-ref="dataSource"/>

DynamicDataSource 自定义的动态数据源切换类

public class DynamicDataSource extends AbstractRoutingDataSource {
    // 动态切换数据源
    @Override
    protected Object determineCurrentLookupKey() {
        System.out.println("===== 当前数据源" + DynamicDataSourceContextHolder.get() + " =====");
        return DynamicDataSourceContextHolder.get();
    }
}

DynamicDataSourceContextHolder 数据源变量类

public class DynamicDataSourceContextHolder {
	
    private static final ThreadLocal<String> currenDataSource = new ThreadLocal<>();

    // 清除数据源
    public static void clear() {
        currenDataSource.remove();
    }

    // 获取数据源
    public static String get() {
        return currenDataSource.get();
    }

    // 设置数据源
    public static void setDataSource(String datasource) {
        currenDataSource.set(datasource);
    }

}

有了以上的配置,则可以在controller进行测试动态数据源是否配置成功.

@Controller
@RequestMapping(value = "/test/")
public class TestController {

    @Autowired
    TestService testService;

    @RequestMapping(value = "select")
    @ResponseBody
    public String select(String datasource){
        // 例如请求: http://127.0.0.1:80/web/test/select?datasource=datasource01
        // 这里的datasource参数的值与applicationContext.xml配置文件中的datasource的id一致即可测试
        DynamicDataSourceContextHolder.setDataSource(datasource);
        return testService.selectOne(datasource);
    }

}

selectOne方法sql以及表结构如下
1
2
3
4
create table temp_001(name varchar2(20));
select name from temp_001
-- 只要保证每个数据库都有这张表,每个表中的数据值不同,就可以请求...test/select?datasource=datasource01 
-- 根据不同的数据源名称查看效果
至此SSM下配置多数据源以及使用Spring的AbstractRoutingDataSource 动态切换数据源Demo结束.

知识点：在何处切换数据源? 需要根据业务具体场景去判断到底是在controller还是service层去切换数据源

例如: 需要根据web前端查询的参数来匹配对应的数据源,则可以考虑在过滤器层面找到查询参数对应的数据源然后

DynamicDataSourceContextHolder.setDataSource(datasource);

切换数据源即可.

再比如: 根据模块拆分的库, 则可以考虑使用aop 对某个模块进行特征匹配, 统一该模块对应的数据源.