Spring使用“最优雅”的方式切换数据源

在日常的业务中我们经常使用到多个数据源，而这样来回切换的代码是可以重用的，那么怎么用最优雅的方式切换呢，我们先来看一下效果。

我们有两个数据源

image.png

image.png

这两个数据都含有一个User表。

image.png

-下面是切换不同数据源的代码

@RestController
public class TestController {
    @Autowired
    IUserDao userDao;

    @DynamicChangeDb(value = DbSources.DB1)
    @PostMapping("/searchDb1")
    public User searchDb1(@RequestParam("id") int id){
       return userDao.search(id);
    }

    @DynamicChangeDb(value = DbSources.DB2)
    @PostMapping("/searchDb2")
    public User searchDb2(@RequestParam("id") int id){
        return userDao.search(id);
    }
}

是的，就使用 @DynamicChangeDb(value = DbSources.DB1)一句话
首先引入aop的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

接着我们定义一下切换数据看的注解

package com.andy.spring.annotation;

import com.andy.spring.conston.DbSources;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by Andy on 2018/8/17.
 */
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DynamicChangeDb {
    String value() default DbSources.DB1;
}

@Target({ElementType.METHOD,ElementType.TYPE}) -> 这个注解可以修饰方法和类。

@Retention(RetentionPolicy.RUNTIME) -> 代表运行时注解。

String value() default DbSources.DB1; -> 用来记录所使用的数据源。

添加基本数据

mysql.driver=com.mysql.jdbc.Driver
mysql.url.wgq=jdbc:mysql://127.0.0.1:3306/music
mysql.url.jd=jdbc:mysql://127.0.0.1:3306/crawer
mysql.username=root
mysql.password=root
mysql.initialSize=1
mysql.maxAcitve=10
mysql.maxIdle=25
mysql.maxWaitTime=60000

这里使用druid作为连接池，定义连个url即两个数据源（都是使用本地数据库）
下面配置applicationContext.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:comtext="http://www.springframework.org/schema/context"

    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.xsd">
<bean id="abstractDataSource" class="com.alibaba.druid.pool.DruidDataSource">
    <property name="driverClassName" value="${mysql.driver}"></property>
    <property name="maxActive" value="10"></property>
    <property name="username" value="${mysql.username}"></property>
    <property name="password" value="${mysql.password}"></property>
</bean>
   <comtext:component-scan base-package="com.andy.spring">

   </comtext:component-scan>
    <bean id="dbwgq" parent="abstractDataSource">
        <property name="url" value="${mysql.url.wgq}"></property>
    </bean>
    <bean id="dbjd" parent="abstractDataSource">
        <property name="url" value="${mysql.url.jd}"></property>
    </bean>
<bean id="dataSource" class="com.andy.spring.db.MultipelDatasource">
    <description>数据源</description>
    <property name="targetDataSources">
        <map key-type="java.lang.String" value-type="javax.sql.DataSource">
            <entry key="dbwgq" value-ref="dbwgq"></entry>
            <entry key="dbjd" value-ref="dbjd"></entry>
        </map>
    </property>
    <property name="defaultTargetDataSource" ref="dbjd"></property>
</bean>
    <bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
        <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"></property>
        <property name="mapperLocations">
            <array>
                <value>classpath:mapper/*Mapper.xml</value>
            </array>
        </property>
    </bean>
</beans>

ORM框架使用Mybatis，所以配置mybatis的SqlsessionFactory

<bean id="dataSource" class="com.andy.spring.db.MultipelDatasource">
    <description>数据源</description>
    <property name="targetDataSources">
        <map key-type="java.lang.String" value-type="javax.sql.DataSource">
            <entry key="dbwgq" value-ref="dbwgq"></entry>
            <entry key="dbjd" value-ref="dbjd"></entry>
        </map>
    </property>
    <property name="defaultTargetDataSource" ref="dbjd"></property>
</bean>

这里是切换数据库的关键，Spring切换数据库需要继承AbstractRoutingDataSource，重写他的determineCurrentLookupKey方法，这个方法返回的东西和key相对应就可以进行切换。

package com.andy.spring.db;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

public class MultipelDatasource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DatasorceHandler.getThreadLocalDataSource();
    }
}

这里面定义一个切换数据库的工具类DatasorceHandler。

DatasorceHandler如下：

package com.andy.spring.db;

import com.andy.spring.conston.DbSources;

public class DatasorceHandler {
    private static ThreadLocal<String> threadLocalDataSource=new ThreadLocal<String>();
    public static void setDataSource(String value){
        threadLocalDataSource.set(value);
    }

    public static String getThreadLocalDataSource() {
        System.out.println("****************** "+threadLocalDataSource.get());
        return threadLocalDataSource.get();
    }
    public static void setDefault(){
        threadLocalDataSource.set(DbSources.DB1);
    }
}

这里面定义一个ThreadLocal<String> 来存储每个请求对应的数据源。

最后一步就是将上面的东西链接起来，编写一个切面，拦截含有DynamicChangeDb注解的方法或者类，然后调用DatasorceHandler进行切换数据库。

package com.andy.spring.aspect;


import com.andy.spring.annotation.DynamicChangeDb;
import com.andy.spring.db.DatasorceHandler;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class DbMangerAspect implements Ordered {
    @Pointcut("@annotation(com.andy.spring.annotation.DynamicChangeDb)")
    public void DynamicDb() {

    }

    /**获取切面的数据并设置当前的dataSource
     * @param point
     */
    @Before("DynamicDb()")
    public void before(JoinPoint point) {
        Method method = ((MethodSignature) point.getSignature()).getMethod();
        DynamicChangeDb dynamicChangeDb = method.getAnnotation(DynamicChangeDb.class);//获取类上面的注解
        if (dynamicChangeDb == null) {
            dynamicChangeDb = point.getTarget().getClass().getAnnotation(DynamicChangeDb.class);//获取类上面的注解
            if (dynamicChangeDb == null) {
                return;
            }
        }
        String dbSource = dynamicChangeDb.value();
        System.out.print(dbSource+"---------------------");
        if (dbSource != null) {
            DatasorceHandler.setDataSource(dbSource);
        }
    }

    /**
     * 设置切面的等级
     *
     * @return
     */
    @Override
    public int getOrder() {
        return 1;
    }
}

在before方法里面，先从类上获取看有没有这个注解，假如没有再去方法上找，找到之后就使用 DatasorceHandler设置当前的数据库。（当然这里也留了一个后门，我们可以说直接使用DatasorceHandler.setDataSource(dbSource);进行数据库切换）。