2020-09-18 springboot 多数据源配置

神作!!! https://www.jianshu.com/p/dd9f79723c68
神作! https://blog.csdn.net/jinglakers1111/article/details/88869865
多数据源我认为分两种,一种是同源多库,一种是多元多库
我准备用两个mysql 和 mysql+redis两种作为该多数据源配置的说明

整体结构如图

image.png

aop 为了减少代码入侵,通过此种方式动态切换数据源
config 是动态数据源切换的核心配置

DataSource 自定义注解


import com.example.mutilsource.config.DataSourceType;

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    /**
     * 切换数据源名称
     */
    DataSourceType value() default DataSourceType.DATASOURCE1;
}

DataSourceAspect aop切面织入数据源

import com.example.mutilsource.config.DynamicDataSourceContextHolder;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Order(1)
@Component
public class DataSourceAspect {
    private Logger log = LoggerFactory.getLogger(getClass());

    @Pointcut("@annotation(com.example.mutilsource.aop.DataSource)")
    public void dsPointCut() {

    }

    @Around("dsPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        DataSource dataSource = method.getAnnotation(DataSource.class);
        if (dataSource != null) {
            DynamicDataSourceContextHolder.setDataSourceType(dataSource.value().name());
        }
        try {
            return point.proceed();
        } finally {
            // 销毁数据源 在执行方法之后
            DynamicDataSourceContextHolder.clearDataSourceType();
        }
    }
}

DataSourceConfig 数据源注入


import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;

@Configuration
public class DataSourceConfig {

    @Bean
    @ConfigurationProperties("spring.mybatis.datasource1")
    public DataSource datasource1() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    @ConfigurationProperties("spring.mybatis.datasource2")
    @ConditionalOnProperty(prefix = "spring.mybatis.datasource2", name = "enabled", havingValue = "true")
    public DataSource datasource2() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "dynamicDataSource")
    @Primary
    public DynamicDataSource dataSource(DataSource datasource1, DataSource datasource2) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceType.DATASOURCE1.name(), datasource1);
        targetDataSources.put(DataSourceType.DATASOURCE2.name(), datasource2);
        return new DynamicDataSource(datasource2, targetDataSources);
    }
}

DataSoureceType 数据源枚举类

public enum DataSourceType {
    /**
     * 数据库1
     */
    DATASOURCE1,

    /**
     * 数据库2
     */
    DATASOURCE2
}

DynamicDataSource 动态切换数据源核心类

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

import javax.sql.DataSource;
import java.util.Map;

/**
 * 动态数据设置以及获取，本类属于单例
 *
 * @author lxf 2018-09-29
 */
@Component
public class DynamicDataSource extends AbstractRoutingDataSource {

    public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
        super.setDefaultTargetDataSource(defaultTargetDataSource);
        super.setTargetDataSources(targetDataSources);
        // afterPropertiesSet()方法调用时用来将targetDataSources的属性写入resolvedDataSources中的
        super.afterPropertiesSet();
    }

    /**
     * 根据Key获取数据源的信息
     *
     * @return
     */
    @Override
    protected Object determineCurrentLookupKey() {
        return DynamicDataSourceContextHolder.getDataSourceType();
    }
}

DynamicDataSourceContextHolder 多数据源切换加载

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DynamicDataSourceContextHolder {
    public static final Logger log = LoggerFactory.getLogger(DynamicDataSourceContextHolder.class);

    /**
     * 使用ThreadLocal维护变量，ThreadLocal为每个使用该变量的线程提供独立的变量副本，
     *  所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。
     */
    private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();

    /**
     * 设置数据源变量
     * @param dataSourceType
     */
    public static void setDataSourceType(String dataSourceType){
        log.info("切换到{}数据源", dataSourceType);
        CONTEXT_HOLDER.set(dataSourceType);
    }

    /**
     * 获取数据源变量
     * @return
     */
    public static String getDataSourceType(){
        return CONTEXT_HOLDER.get();
    }

    /**
     * 清空数据源变量
     */
    public static void clearDataSourceType(){
        CONTEXT_HOLDER.remove();
    }
}

application.yml 多数据源配置

spring:
  main:
    allow-bean-definition-overriding: true
  mybatis:
  # 配置数据源
    datasource1:
      # 使用阿里的Druid连接池
      type: com.alibaba.druid.pool.DruidDataSource
      driver-class-name: com.mysql.cj.jdbc.Driver
      # 填写你数据库的url、登录名、密码和数据库名
      jdbc-url: jdbc:mysql://172.18.3.180:3306/sfwl?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8&useSSL=true&tinyInt1isBit=false
      username: root
      password: Abc1234+
    # 配置数据源
    datasource2:
      enabled: true
      # 使用阿里的Druid连接池
      type: com.alibaba.druid.pool.DruidDataSource
      driver-class-name: com.mysql.cj.jdbc.Driver
      # 填写你数据库的url、登录名、密码和数据库名
      jdbc-url: jdbc:mysql://127.0.0.1:3306/sfwl?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8&useSSL=true&tinyInt1isBit=false
      username: root
      password:


  # Redis数据源
  redis:
    # 缓存库默认索引0
    database: 1
    # Redis服务器地址
    host: 172.18.3.9
    # Redis服务器连接端口
    port: 6379
    # Redis服务器连接密码（默认为空）
    password: Mix-redis
    # 连接超时时间（毫秒）
    timeout: 6000
    # 默认的数据过期时间，主要用于shiro权限管理
    expire: 2592000
    jedis:
      pool:
        max-active: 1000  # 连接池最大连接数（使用负值表示没有限制）
        max-wait: -1      # 连接池最大阻塞等待时间（使用负值表示没有限制）
        max-idle: 10      # 连接池中的最大空闲连接
        min-idle: 1       # 连接池中的最小空闲连接

经过这些配置后,可以同过上述的自定义注解在查询时,传入数据源name选择不同的数据源查询
例如

import com.example.mutilsource.aop.DataSource;
import com.example.mutilsource.bean.RSUser;
import com.example.mutilsource.config.DataSourceType;
import com.example.mutilsource.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.stereotype.Service;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;
import java.util.concurrent.TimeUnit;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    JdbcTemplate jdbcTemplate;

    @Autowired
    RedisTemplate redisTemplate;

    @Override
    @DataSource(value = DataSourceType.DATASOURCE1)
    public void test1 (){

        List<RSUser> query = jdbcTemplate.query("select * from sys_rs_user", new RowMapper<RSUser>() {
            @Override
            public RSUser mapRow(ResultSet resultSet, int i) throws SQLException {
                RSUser rsUser = new RSUser();
                rsUser.setUsername(resultSet.getString("username"));
                return rsUser;
            }
        });
        for (RSUser rsUser : query) {
            System.out.println(rsUser.getUsername());
        }
        redisTemplate.opsForValue().set("a",132);
    }

    @DataSource(value = DataSourceType.DATASOURCE2)
    @Override
    public void test2 (){

        System.out.println();
        List<RSUser> query = jdbcTemplate.query("select * from sys_rs_user",  new RowMapper<RSUser>() {
            @Override
            public RSUser mapRow(ResultSet resultSet, int i) throws SQLException {
                RSUser rsUser = new RSUser();
                rsUser.setUsername(resultSet.getString("username"));
                return rsUser;
            }
        });
        for (RSUser rsUser : query) {
            System.out.println(rsUser.getUsername());
        }
    }

}

日常采坑记录:
1 yml中的数据库配置中url 要改为jdbc-url(因为我用的jdbc,其他选择相应的url)
2 springboot启动类上一定要加上去掉默认的数据源的配置

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})

image.png

这是个大坑,一直报循环依赖的错误.......经过不断的百度解决