SpringBoot + MyBatis如何优雅地动态设置数据源

SpringBoot + MyBatis如何优雅地动态设置数据源

前言：

1.Mybatis创建session（）主要通过SqlSessionFactory，一般整个系统的生命周期里面只有一个SqlSessionFactory实例；

2.SqlSessionFactory是一个接口，Mybatis目前使用的实现类是DefaultSqlSessionFactory；

3.DefaultSqlSessionFactory里面有一个属性是Configuration对象，组合在DefaultSqlSessionFactory里面，然而Configuration属性是final的，所以继续看Configuration里面的结构，其中有一个Environment属性，组合在Environment类里面，该类的部分源码如下：

public final class Environment {
  private final String id;
  private final TransactionFactory transactionFactory;
  private final DataSource dataSource;

  public Environment(String id, TransactionFactory transactionFactory, DataSource dataSource) {
    if (id == null) {
      throw new IllegalArgumentException("Parameter 'id' must not be null");
    }
    if (transactionFactory == null) {
      throw new IllegalArgumentException("Parameter 'transactionFactory' must not be null");
    }
    this.id = id;
    if (dataSource == null) {
      throw new IllegalArgumentException("Parameter 'dataSource' must not be null");
    }
    this.transactionFactory = transactionFactory;
    this.dataSource = dataSource;
  }
......
}

思路：分析到这里，其实我们只需要在Service开启事务之前，改变Environment对象，让这次会话连接到相应的数据库即可。也就是说改变DefaultSqlSessionFactory中Configuration的Environment。

步骤：A.新建配置类（拒绝硬编码）

@ConfigurationProperties(prefix = "multiple.datasource")
public class MultipleDataSourceProperties {
    private List<String> urlList;
    private List<String> usernameList;
    private List<String> passwordList;
    private List<String> driverClassNameList;
    //别名列表，别名是必要的，之后使用到
    private List<String> aliasList;

    public void setUsernameList(List<String> usernameList) {
        this.usernameList = usernameList;
    }

    public void setPasswordList(List<String> passwordList) {
        this.passwordList = passwordList;
    }

    public void setDriverClassNameList(List<String> driverClassNameList) {
        this.driverClassNameList = driverClassNameList;
    }

    public void setAliasList(List<String> aliasList) {
        this.aliasList = aliasList;
    }

    public void setUrlList(List<String> urlList){
        this.urlList = urlList;
    }

    public List<String> getAliasList() {
        return aliasList;
    }

    public List<String> getDriverClassNameList() {
        return driverClassNameList;
    }

    public List<String> getPasswordList() {
        return passwordList;
    }

    public List<String> getUrlList() {
        return urlList;
    }

    public List<String> getUsernameList() {
        return usernameList;
    }
}

然后application.properties文件添加新的数据源（DataOrigin是一个自定义注解，稍后解释）：

B.写配置类生成根据配置生成不同的Environment

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(MultipleDataSourceProperties.class)
public class MultipleDataSourceConfiguration {
    @Autowired
    private SqlSessionFactory sessionFactory;
    @Bean("defaultEnvironment")
    public Environment defaultEnvironment(){
        return sessionFactory.getConfiguration().getEnvironment();
    }
    @Bean("environments")
    public HashMap<String, Environment> environments(MultipleDataSourceProperties properties){
        TransactionFactory transactionFactory = sessionFactory.getConfiguration().getEnvironment().getTransactionFactory();
        HashMap<String, Environment> dataSources = new HashMap<>();
        List<String> aliasList = properties.getAliasList();
        for(int i = 0; i < aliasList.size(); i++){
            HikariConfig config = new HikariConfig();
            config.setJdbcUrl(properties.getUrlList().get(i));
            config.setUsername(properties.getUsernameList().get(i));
            config.setPassword(properties.getPasswordList().get(i));
            config.setDriverClassName(properties.getDriverClassNameList().get(i));
            HikariDataSource dataSource = new HikariDataSource(config);
            Environment environment = new Environment(aliasList.get(i), transactionFactory, dataSource);
            dataSources.put(aliasList.get(i), environment);
        }
        return dataSources;
    }
}

C.新建一个数据源注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataOrigin {
    String value();
}

D.使用SpringAop动态解释该注解

@Aspect
@Component
public class DataOriginHandler {
    @Resource(name = "defaultEnvironment")
    private Environment defaultEnvironment;
    @Resource(name = "environments")
    private HashMap<String, Environment> environments;
    @Autowired
    private DefaultSqlSessionFactory sessionFactory;
    @Pointcut("@annotation(com.example.mybatis.annotation.DataOrigin)")
    public void pointCut(){}
    //在调用切入点方法之前改变DefaultSqlSessionFactory中Configuration的Environment
    @Before("pointCut()")
    public void before(JoinPoint joinPoint){
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        DataOrigin dataOrigin = method.getAnnotation(DataOrigin.class);
        String key = dataOrigin.value();
        System.out.println(key);
        Environment environment = environments.get(key);
        sessionFactory.getConfiguration().setEnvironment(environment);
    }
    //在调用完切入点方法之后还原回来原来的Environment
    @After("pointCut()")
    public void after(){
        sessionFactory.getConfiguration().setEnvironment(defaultEnvironment);
    }
}

使用：

效果：