Spring+SpringMVC+Hibernate框架中,整合数据库读写分离的详细方案。
环境介绍:
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 `schools`;
CREATE TABLE `schools` (
`ID` char(32) NOT NULL,
`SCHO_NAME` varchar(200) DEFAULT NULL,
`SCHO_NAME_PY` varchar(200) DEFAULT NULL,
`SCHO_NAME_PINYIN` varchar(200) DEFAULT NULL,
`PROVINCE_ID` char(32) DEFAULT NULL,
`CITY_ID` char(32) DEFAULT NULL,
`STATUS` int(1) DEFAULT NULL COMMENT '0:未确认;1:已确认;',
`INVIT_CODE` varchar(10) DEFAULT NULL,
`BADGE_URL` varchar(200) DEFAULT NULL,
`CREAT_TIME` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
`CREATE_TIME` datetime DEFAULT NULL,
`THIRD_PLAT_TYPE` varchar(36) DEFAULT NULL,
`THIRD_SCHO_ID` varchar(36) DEFAULT NULL,
`GEN_TYPE` int(11) DEFAULT NULL,
PRIMARY KEY (`ID`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;insert into `schools` (`ID`, `SCHO_NAME`, `SCHO_NAME_PY`, `SCHO_NAME_PINYIN`, `PROVINCE_ID`, `CITY_ID`, `STATUS`, `INVIT_CODE`, `BADGE_URL`, `CREAT_TIME`, `CREATE_TIME`, `THIRD_PLAT_TYPE`, `THIRD_SCHO_ID`, `GEN_TYPE`)
values('40288195653262b20165326e70db0005','北京第一中学','xaskcbd','izhongxue','610000','610100','1','3690','https://a.qingstor.com/ff80808150506c9f015050b7d1f308a3.png','2019-11-13 16:37:03',NULL,NULL,NULL,NULL);
二、多数据源动态切换实现读写分离的核心类
继承AbstractRoutingDataSource,重写determineCurrentLookupKey方法,MultiDataSource.java代码如下:
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource; 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-hibernate.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:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> <context:component-scan base-package="com.zrscsoft"/> <aop:aspectj-autoproxy/> <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> <!-- 配置sessionFactory --> <bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean"> <property name="dataSource" ref="multiDataSource"/> <!-- 注解方式配置 packagesToScan可以自动搜索某个package的全部标记@Entity class --> <property name="packagesToScan"> <list> <value>com.zrscsoft.bean</value> </list> </property> <property name="hibernateProperties"> <props> <!-- 制定Hibernate是否打印SQL语句 --> <prop key="hibernate.show_sql">true</prop> <prop key="hibernate.format_sql">true</prop> </props> </property> </bean> <!-- 配置事务管理器 --> <bean id="txManager" class="org.springframework.orm.hibernate4.HibernateTransactionManager"> <property name="sessionFactory" ref="sessionFactory" /> </bean> <tx:annotation-driven transaction-manager="txManager" /> <!--配置事务的传播特性 --> <tx:advice id="txAdvice" transaction-manager="txManager"> <tx:attributes> <!-- 对增、删、改方法进行事务支持 --> <tx:method name="add*" propagation="REQUIRED" /> <tx:method name="create*" propagation="REQUIRED" /> <tx:method name="save*" propagation="REQUIRED" /> <tx:method name="edit*" propagation="REQUIRED" /> <tx:method name="update*" propagation="REQUIRED" /> <tx:method name="delete*" propagation="REQUIRED" /> <tx:method name="remove*" propagation="REQUIRED" /> <!-- 对查找方法进行只读事务 --> <tx:method name="loadByUsername*" propagation="SUPPORTS" read-only="true" /> <!-- 对其它方法进行只读事务 --> <tx:method name="*" propagation="SUPPORTS" read-only="true" /> </tx:attributes> </tx:advice> <aop:config> <!-- 定义切面,所有的service的所有方法 --> <aop:pointcut id="txPointcut" expression="execution(* com.zrscsoft..*Service.*(..))" /> <!-- 应用事务策略到Service切面 --> <aop:advisor advice-ref="txAdvice" pointcut-ref="txPointcut" order="2"/> </aop:config> </beans>
四、使用及单元调试
@RunWith(SpringJUnit4ClassRunner.class) @WebAppConfiguration @TransactionConfiguration(defaultRollback = true) @ContextConfiguration(locations = { "classpath:spring-hibernate.xml" }) public class SchoolsServiceTest { @Autowired SchoolsService schoolsService; @Test public void getById() { String id="40288195653262b20165326e70db0005";//主库没有,备库有 Schools s=schoolsService.getById(id); System.out.println("查询的记录为:"+s); } }