SpringMVC+MyBatis框架中,多数据源动态切换,实现数据库读写分离的详细方案。
环境介绍:
Spring为4.2.4.RELEASE版本
数据库为MySQL
JDK为1.7.0版本
项目结构为:
具体步骤:
一、数据库及SQL脚本
数据库使用的Mysql数据库,版本没要求,创建表结果的SQL如下:
/*!40101 SET NAMES utf8 */; /*!40101 SET SQL_MODE=''*/; /*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */; /*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */; /*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */; /*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */; CREATE DATABASE /*!32312 IF NOT EXISTS*/`datasourcedynamic` /*!40100 DEFAULT CHARACTER SET utf8 */; USE `datasourcedynamic`; DROP TABLE IF EXISTS `cost`; CREATE TABLE `cost` ( `id` int(11) NOT NULL AUTO_INCREMENT, `money` int(11) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
二、多数据源动态切换实现读写分离的核心类
继承AbstractRoutingDataSource,重写determineCurrentLookupKey方法,MultiDataSource.java代码如下:
public class MultiDataSource extends AbstractRoutingDataSource{ /*ThreadLocal线程本地变量或线程本地存储,ThreadLocal为变量在每个线程中都创建了一个副本, * 那么每个线程可以访问自己内部的副本变量。 */ private static final ThreadLocal<String> dataSourceKey = new InheritableThreadLocal<String>(); /** * 设置dataSourceKey的值 * @param dataSource */ public static void setDataSourceKey(String dataSource) { dataSourceKey.set(dataSource); } /** * 清除dataSourceKey的值 */ public static void toDefault() { dataSourceKey.remove(); } /** * 返回当前dataSourceKey的值 */ @Override protected Object determineCurrentLookupKey() { Object obj=dataSourceKey.get(); System.out.println("使用的数据源为:"+obj); return obj; } }
使用@Before和@After,在调用目标方法前,进行aop拦截,通过解析注解上的值来切换数据源。在调用方法结束后,切回默认数据源。如果目标方法无返回值,也可以使用@Around,调用ProceedingJoinPoint的proceed()方法前切换数据源,调用proceed()方法后切回默认数据源。面向切面编程的实现类:
@Aspect @Component public class HandlerDataSourceAop { /** * @within匹配类上的注解 * @annotation匹配方法上的注解 */ @Pointcut("@within(com.zrscsoft.annotation.DynamicRoutingDataSource)||@annotation(com.zrscsoft.annotation.DynamicRoutingDataSource)") public void pointcut() { } @Before(value = "pointcut()") public void beforeOpt(JoinPoint joinPoint) { // 反射获取Method 方法一 Object target = joinPoint.getTarget(); Class<?> clazz = target.getClass(); Method[] methods = clazz.getMethods(); DynamicRoutingDataSource annotation = null; for (Method method : methods) { if (joinPoint.getSignature().getName().equals(method.getName())) { annotation = method.getAnnotation(DynamicRoutingDataSource.class); if (annotation == null) { annotation = joinPoint.getTarget().getClass().getAnnotation(DynamicRoutingDataSource.class); if (annotation == null) { return; } } } } String dataSourceName = annotation.value(); MultiDataSource.setDataSourceKey(dataSourceName); System.out.println("切到" + dataSourceName + "数据库"); } @After(value = "pointcut()") public void afterOpt() { MultiDataSource.toDefault(); System.out.println("切回默认数据库"); } }
定义一个注解,来调用注解切换数据库,数据源切换注解代码如下:
@Target({ElementType.METHOD,ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited public @interface DynamicRoutingDataSource { String value() default "dataSource"; }
三、多数据源配置说明
多数据源配置,主要是如何配置多数据源连接,jdbc.properties文件内容为:
jdbc.driverClassName=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://{主库的IP地址}:3306/datasourcedynamic?useUnicode=true&characterEncoding=utf-8 jdbc.username={主库的账号} jdbc.password={主库的密码} jdbc.driverClassName1=com.mysql.jdbc.Driver jdbc.url1=jdbc:mysql://{备库的IP地址}:3306/datasourcedynamic?useUnicode=true&characterEncoding=utf-8 jdbc.username1={备库的账号} jdbc.password1={备库的密码}
spring-mybatis.xml文件内容:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.2.xsd"> <context:property-placeholder location="classpath:jdbc.properties" /> <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> <property name="driverClassName" value="${jdbc.driverClassName}" /> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> <!-- 配置初始化大小、最小、最大 --> <property name="initialSize" value="1" /> <property name="minIdle" value="1" /> <property name="maxActive" value="10" /> <!-- 配置获取连接等待超时的时间 --> <property name="maxWait" value="10000" /> <!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 --> <property name="timeBetweenEvictionRunsMillis" value="60000" /> <!-- 配置一个连接在池中最小生存的时间,单位是毫秒 --> <property name="minEvictableIdleTimeMillis" value="300000" /> <property name="testWhileIdle" value="true" /> <!-- 这里建议配置为TRUE,防止取到的连接不可用 testOnBorrow:申请连接时执行validationQuery检测连接是否有效,做了这个配置会降低性能 testOnReturn:归还连接时执行validationQuery检测连接是否有效,做了这个配置会降低性能 --> <property name="testOnBorrow" value="true" /> <property name="testOnReturn" value="false" /> <!-- 打开PSCache,并且指定每个连接上PSCache的大小 --> <property name="poolPreparedStatements" value="true" /> <property name="maxPoolPreparedStatementPerConnectionSize" value="20" /> <!-- 开启Druid的监控统计功能 --> <property name="filters" value="stat"></property> </bean> <bean id="dataSource2" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> <property name="driverClassName" value="${jdbc.driverClassName1}" /> <property name="url" value="${jdbc.url1}" /> <property name="username" value="${jdbc.username1}" /> <property name="password" value="${jdbc.password1}" /> <!-- 配置初始化大小、最小、最大 --> <property name="initialSize" value="1" /> <property name="minIdle" value="1" /> <property name="maxActive" value="10" /> <!-- 配置获取连接等待超时的时间 --> <property name="maxWait" value="10000" /> <!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 --> <property name="timeBetweenEvictionRunsMillis" value="60000" /> <!-- 配置一个连接在池中最小生存的时间,单位是毫秒 --> <property name="minEvictableIdleTimeMillis" value="300000" /> <property name="testWhileIdle" value="true" /> <!-- 这里建议配置为TRUE,防止取到的连接不可用 --> <property name="testOnBorrow" value="true" /> <property name="testOnReturn" value="false" /> <!-- 打开PSCache,并且指定每个连接上PSCache的大小 --> <property name="poolPreparedStatements" value="true" /> <property name="maxPoolPreparedStatementPerConnectionSize" value="20" /> <!-- 开启Druid的监控统计功能 --> <property name="filters" value="stat"></property> </bean> <bean id="multiDataSource" class="com.zrscsoft.dataSource.MultiDataSource"> <property name="defaultTargetDataSource" ref="dataSource"></property> <property name="targetDataSources"> <map> <entry key="dataSource2" value-ref="dataSource2"></entry> </map> </property> </bean> <!-- mybatis --> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="multiDataSource"></property> <property name="configLocation" value="classpath:mybatis-config.xml"></property> <property name="mapperLocations" value="classpath:com/zrscsoft/mapper/*.xml"></property> </bean> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property> <property name="basePackage" value="com.zrscsoft.mapper"></property> </bean> <!-- 添加事务管理 --> <tx:annotation-driven transaction-manager="transactionManager" /> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="multiDataSource"></property> </bean> </beans>
利用aop切换数据源,这里记得开启aop,配置文件中使用<aop:aspectj-autoproxy />,spring-mvc.xml文件内容:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xmlns:task="http://www.springframework.org/schema/task" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.2.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.2.xsd"> <context:component-scan base-package="com.zrscsoft"/> <aop:aspectj-autoproxy/> </beans>
四、使用及单元调试
@Service public class CostServiceImpl implements CostService { @Resource private CostMapper costMapper; public void insert(Cost cost) { System.out.println("insert:" + costMapper.insert(cost)); } @DynamicRoutingDataSource("dataSource2") public void insert2(Cost cost) { System.out.println("insert2:" + costMapper.insert(cost)); } }
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(locations = { "classpath:spring-mvc.xml", "classpath:spring-mybatis.xml" }) public class TestDynamicDataSource { @Resource CostService costService; /** * 使用工具类切换数据源 */ @Test public void test(){ Cost cost = new Cost(102); //costService.insert(cost); // MultiDataSource.setDataSourceKey("dataSource2"); // costService.insert(cost); MultiDataSource.toDefault(); costService.insert(cost); } /** * 注解切换数据源 */ @Test public void test2(){ costService.insert2(new Cost(10000)); } }