• base hook

###配置文件包括1个主数据源和多个数据源，
###其中主数据源在Spring中的beanName默认为dataSource，
###另外几个数据源的beanName分包为：ds1、ds2、ds3
###其中datasource的type属性可以具体指定到我们需要的数据源上面，
###不指定情况下默认为：org.apache.tomcat.jdbc.pool.DataSource
###当然你也可以把这些数据源配置到主dataSource数据库中，然后读取数据库生成多数据源。当然这样做的必要性并不大，难不成数据源还会经常变吗。
########################################################
 
# 主数据源，默认的
#spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root

# 更多数据源
custom.datasource.names=ds1,ds2,ds3

#custom.datasource.ds1.type=com.zaxxer.hikari.HikariDataSource
custom.datasource.ds1.driverClassName =com.mysql.jdbc.Driver
custom.datasource.ds1.url=jdbc:mysql://localhost:3306/test1
custom.datasource.ds1.username=root
custom.datasource.ds1.password=root
 
#custom.datasource.ds2.type=com.zaxxer.hikari.HikariDataSource
custom.datasource.ds2.driverClassName =com.mysql.jdbc.Driver
custom.datasource.ds2.url=jdbc:mysql://localhost:3306/test
custom.datasource.ds2.username=root
custom.datasource.ds2.password=root
 
custom.datasource.ds3.type=com.zaxxer.hikari.HikariDataSource
custom.datasource.ds3.driverClassName =com.mysql.jdbc.Driver
custom.datasource.ds3.url=jdbc:mysql://localhost:3306/test
custom.datasource.ds3.username=root
custom.datasource.ds3.password=root
 
# 下面为连接池的补充设置，应用到上面所有数据源中
spring.datasource.maximum-pool-size=100
spring.datasource.max-idle=10
spring.datasource.max-wait=10000
spring.datasource.min-idle=5
spring.datasource.initial-size=5
spring.datasource.validation-query=SELECT 1
spring.datasource.test-on-borrow=false
spring.datasource.test-while-idle=true
spring.datasource.time-between-eviction-runs-millis=18800
 

核心定义

• setEnvironment()-->postProcessBeanDefinitionRegistry() --> postProcessBeanFactory()

动态数据源路由类

• AbstractRoutingDataSource
  • 动态数据源能进行自动切换的核心就是spring底层提供了AbstractRoutingDataSource类进行数据源的路由的，
  • 继承这个类，实现里面的方法即可实现我们想要的，这里主要是实现方法：determineCurrentLookupKey（），而此方法只需要返回一个数据库的名称即可，
  • 所以我们核心的是有一个类来管理数据源的线程池，这个类才是动态数据源的核心处理类。还有另外就是我们使用aop技术在执行事务方法前进行数据源的切换。

实现

package com.osvue.win.app.spr.config;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
/**
 * 
 * @ClassName:  DynamicDataSource   
 * @Description:TODO(动态路由数据源)   
 * @author: hzq 
 * @date:   2022-7-26 10:03:15    
 * @Copyright: 2022
 */
public class DynamicDataSource extends AbstractRoutingDataSource{
   /**
   *代码中的determineCurrentLookupKey方法取得一个字符串，
   *该字符串将与配置文件中的相应字符串进行匹配以定位数据源，配置文件，即applicationContext.xml文件中需要要如下代码：(non-Javadoc)
  * 
  * Title: determineCurrentLookupKey   
  * Description:
  * @return   
  * @see org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource#determineCurrentLookupKey()
  */
 @Override
 protected Object determineCurrentLookupKey() {
    /*
      * DynamicDataSourceContextHolder代码中使用setDataSourceType
           *设置当前的数据源，在路由类中使用getDataSourceType进行获取，
           * 交给AbstractRoutingDataSource进行注入使用。
         */

        return DynamicDataSourceContextHolder.getDataSourceType();
 
 }

}



package com.osvue.win.app.spr.config;

import java.util.ArrayList;
import java.util.List;

public class DynamicDataSourceContextHolder {
 /*
  * 
  * 当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，
  * 
  * 所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。
  * 
  */

 private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();

 /*
  * 
  * 管理所有的数据源id;
  * 
  * 主要是为了判断数据源是否存在;
  * 
  */

 public static List<String> dataSourceIds = new ArrayList<String>();

 /**
  * 
  * 使用setDataSourceType设置当前的
  * 
  * @param dataSourceType
  * 
  */

 public static void setDataSourceType(String dataSourceType) {
  contextHolder.set(dataSourceType);
 }

 public static String getDataSourceType() {
  return contextHolder.get();
 }

 public static void clearDataSourceType() {
  contextHolder.remove();
 }

 /**
  * 
  * 判断指定DataSrouce当前是否存在
  *
  * @param dataSourceId
  * @return
  * 
  * 
  */

 public static boolean containsDataSource(String dataSourceId) {
  return dataSourceIds.contains(dataSourceId);
 }
}

DynamicDataSourceRegister

package com.osvue.win.app.spr.config;

import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.PropertyValues;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotationMetadata;

import java.util.HashMap;
import java.util.Map;

import javax.sql.DataSource;

/**
 * 
 * @ClassName: DynamicDataSourceRegister
 * @Description:TODO(这里用一句话描述这个类的作用)
 * @author: hzq
 * @date: 2022-7-26 10:41:25
 * @Copyright: 2022
 */
public class DynamicDataSourceRegister implements ImportBeanDefinitionRegistrar, EnvironmentAware {

 // 如配置文件中未指定数据源类型，使用该默认值

 private static final Object DATASOURCE_TYPE_DEFAULT = "org.apache.tomcat.jdbc.pool.DataSource";

 private ConversionService conversionService = new DefaultConversionService();

 private PropertyValues dataSourcePropertyValues;

 // 默认数据源

 private DataSource defaultDataSource;

 private Map<String, DataSource> customDataSources = new HashMap<String, DataSource>();

 /**
  * 
  * 加载多数据源配置
  * 
  */

 @Override
 public void setEnvironment(Environment environment) {
  System.out.println("DynamicDataSourceRegister.setEnvironment()");
  initDefaultDataSource(environment);
  initCustomDataSources(environment);

 }

 /**
  * 
  * 加载主数据源配置.
  * 
  * @param env
  * 
  */

 private void initDefaultDataSource(Environment env) {

  // 读取主数据源
  Map<String, Object> dsMap = new HashMap<String, Object>();
  /*
   * RelaxedPropertyResolver propertyResolver =new
   * RelaxedPropertyResolver(env,"spring.datasource."); dsMap.put("type",
   * propertyResolver.getProperty("type")); dsMap.put("driverClassName",
   * propertyResolver.getProperty("driverClassName")); dsMap.put("url",
   * propertyResolver.getProperty("url")); dsMap.put("username",
   * propertyResolver.getProperty("username")); dsMap.put("password",
   * propertyResolver.getProperty("password"));
   */

  // 创建数据源;

  defaultDataSource = buildDataSource(dsMap);

  dataBinder(defaultDataSource, env);

 }

 /**
  * 
  * @Title: initCustomDataSources @Description: TODO(初始化更多数据源) @param: @param
  *         env @return: void @throws
  */
 private void initCustomDataSources(Environment env) {

  // 读取配置文件获取更多数据源，也可以通过defaultDataSource读取数据库获取更多数据源
  RelaxedPropertyResolver propertyResolver = new RelaxedPropertyResolver(env, "custom.datasource.");
  String dsPrefixs = propertyResolver.getProperty("names");
  for (String dsPrefix : dsPrefixs.split(",")) {// 多个数据源
   Map<String, Object> dsMap = propertyResolver.getSubProperties(dsPrefix + ".");
   DataSource ds = buildDataSource(dsMap);
   customDataSources.put(dsPrefix, ds);
   dataBinder(ds, env);
  }
 }

 /**
  * 
  * @Title: buildDataSource @Description: TODO(创建datasource.) @param: @param
  * dsMap @param: @return @return: DataSource @throws
  */
 @SuppressWarnings("unchecked")
 public DataSource buildDataSource(Map<String, Object> dsMap) {
  Object type = dsMap.get("type");
  if (type == null) {
   type = DATASOURCE_TYPE_DEFAULT;// 默认DataSource
  }
  Class<? extends DataSource> dataSourceType;
  try {
   dataSourceType = (Class<? extends DataSource>) Class.forName((String) type);
   String driverClassName = dsMap.get("driverClassName").toString();
   String url = dsMap.get("url").toString();
   String username = dsMap.get("username").toString();
   String password = dsMap.get("password").toString();
   DataSourceBuilder factory = DataSourceBuilder.create().driverClassName(driverClassName).url(url)
     .username(username).password(password).type(dataSourceType);

   return factory.build();

  } catch (ClassNotFoundException e) {
   e.printStackTrace();
  }
  return null;
 }

 /**
  * 
  * 为DataSource绑定更多数据
  * 
  * @param dataSource
  * 
  * @param env
  * 
  */

 private void dataBinder(DataSource dataSource, Environment env) {

  RelaxedDataBinder dataBinder = new RelaxedDataBinder(dataSource);
  dataBinder.setConversionService(conversionService);
  dataBinder.setIgnoreNestedProperties(false);// false
  dataBinder.setIgnoreInvalidFields(false);// false
  dataBinder.setIgnoreUnknownFields(true);// true
  if (dataSourcePropertyValues == null) {
   Map<String, Object> rpr = new RelaxedPropertyResolver(env, "spring.datasource").getSubProperties(".");
   Map<String, Object> values = new HashMap<>(rpr);
   // 排除已经设置的属性
   values.remove("type");

   values.remove("driverClassName");

   values.remove("url");

   values.remove("username");

   values.remove("password");

   dataSourcePropertyValues = new MutablePropertyValues(values);
  }
  dataBinder.bind(dataSourcePropertyValues);

 }

 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

  System.out.println("DynamicDataSourceRegister.registerBeanDefinitions()");

  Map<Object, Object> targetDataSources = new HashMap<Object, Object>();

  // 将主数据源添加到更多数据源中

  targetDataSources.put("dataSource", defaultDataSource);

  DynamicDataSourceContextHolder.dataSourceIds.add("dataSource");

  // 添加更多数据源

  targetDataSources.putAll(customDataSources);

  for (String key : customDataSources.keySet()) {

   DynamicDataSourceContextHolder.dataSourceIds.add(key);

  }

  // 创建DynamicDataSource

  GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
  beanDefinition.setBeanClass(DynamicDataSource.class);
  beanDefinition.setSynthetic(true);
  MutablePropertyValues mpv = beanDefinition.getPropertyValues();

  // 添加属性：AbstractRoutingDataSource.defaultTargetDataSource

  mpv.addPropertyValue("defaultTargetDataSource", defaultDataSource);

  mpv.addPropertyValue("targetDataSources", targetDataSources);

  registry.registerBeanDefinition("dataSource", beanDefinition);

 }

}

数据源注解

package com.osvue.win.app.spr.config.anno;

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;

/**
 * 
 * @ClassName:  TargetDataSource   
 * @Description:TODO(数据源注解 )   
 * @author: hzq 
 * @date:   2022-7-26 10:31:34    
 * @Copyright: 2022
 */
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {

 String value();

}

数据源切面

package com.osvue.win.app.spr.config;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Aspect
@Order(-10) // 保证该AOP在@Transactional之前执行
@Component
public class DynamicDataSourceAspect {

 /*
  * @Before("@annotation(ds)") 的意思是：
  *
  * @Before：在方法执行之前进行执行：
  * 
  * @annotation(targetDataSource)： 会拦截注解targetDataSource的方法，否则不拦截;
  */

 @Before("@annotation(targetDataSource)")
 public void changeDataSource(JoinPoint point, TargetDataSource targetDataSource) throws Throwable {
  // 获取当前的指定的数据源;
  String dsId = targetDataSource.value();
  // 如果不在我们注入的所有的数据源范围之内，那么输出警告信息，系统自动使用默认的数据源。
  if (!DynamicDataSourceContextHolder.containsDataSource(dsId)) {
   System.err.println("数据源[{}]不存在，使用默认数据源 > {}" + targetDataSource.value() + point.getSignature());
  } else {
   System.out.println("UseDataSource : {} > {}" + targetDataSource.value() + point.getSignature());
   // 找到的话，那么设置到动态数据源上下文中。
   DynamicDataSourceContextHolder.setDataSourceType(targetDataSource.value());

  }

 }

 @After("@annotation(targetDataSource)")

 public void restoreDataSource(JoinPoint point, TargetDataSource targetDataSource) {

  System.out.println("RevertDataSource : {} > {}" + targetDataSource.value() + point.getSignature());

  // 方法执行完毕之后，销毁当前数据源信息，进行垃圾回收。

  DynamicDataSourceContextHolder.clearDataSourceType();

 }
}