Spring Boot + Mybatis多數據源和動態數據源配置

網上的文章基本上都是隻有多數據源或只有動態數據源,而最近的項目需要同時使用兩種方式,記錄一下配置方法供大家參考。

應用場景


項目需要同時連接兩個不同的數據庫A, B,並且它們都爲主從架構,一臺寫庫,多臺讀庫。

多數據源


首先要將spring boot自帶的DataSourceAutoConfiguration禁掉,因爲它會讀取application.properties文件的spring.datasource.*屬性並自動配置單數據源。在@SpringBootApplication註解中添加exclude屬性即可:

@SpringBootApplication(exclude = {
        DataSourceAutoConfiguration.class
})
public class TitanWebApplication {
    public static void main(String[] args) {
        SpringApplication.run(TitanWebApplication.class, args);
    }
}


然後在application.properties中配置多數據源連接信息:

# titan庫
spring.datasource.titan-master.url=jdbc:mysql://X.X.X.X:port/titan?characterEncoding=UTF-8
spring.datasource.titan-master.username=
spring.datasource.titan-master.password=
spring.datasource.titan-master.driver-class-name=com.mysql.jdbc.Driver
# 連接池配置
# 省略

# 其它庫
spring.datasource.db2.url=jdbc:mysql://X.X.X.X:port/titan2?characterEncoding=UTF-8
spring.datasource.db2.username=
spring.datasource.db2.password=
spring.datasource.db2.driver-class-name=com.mysql.jdbc.Driver


由於我們禁掉了自動數據源配置,因些下一步就需要手動將這些數據源創建出來:

@Configuration
public class DataSourceConfig {

    @Bean(name = "titanMasterDS")
    @ConfigurationProperties(prefix = "spring.datasource.titan-master") // application.properteis中對應屬性的前綴
    public DataSource dataSource1() {
        return DataSourceBuilder.create().build();
    }




    @Bean(name = "ds2")
    @ConfigurationProperties(prefix = "spring.datasource.db2") // application.properteis中對應屬性的前綴
    public DataSource dataSource2() {
        return DataSourceBuilder.create().build();
    }

}


接下來需要配置兩個mybatis的SqlSessionFactory分別使用不同的數據源:

@Configuration
@MapperScan(basePackages = {"titan.mapper"}, sqlSessionFactoryRef = "sqlSessionFactory1")
public class MybatisDbAConfig {

    @Autowired
    @Qualifier("titanMasterDS")
    private DataSource ds1;


    @Bean
    public SqlSessionFactory sqlSessionFactory1() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(ds1); // 使用titan數據源, 連接titan庫

        return factoryBean.getObject();

    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate1() throws Exception {
        SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory1()); // 使用上面配置的Factory
        return template;
    }
}


經過上面的配置後,titan.mapper下的Mapper接口,都會使用titan數據源。同理可配第二個SqlSessionFactory:

@Configuration
@MapperScan(basePackages = {"other.mapper"}, sqlSessionFactoryRef = "sqlSessionFactory2")
public class MybatisDbBConfig {
    @Autowired
    @Qualifier("ds2")
    private DataSource ds2;

    @Bean
    public SqlSessionFactory sqlSessionFactory2() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(ds2);


        return factoryBean.getObject();

    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate2() throws Exception {
        SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory2());
        return template;
    }
}


完成這些配置後,假設有2個Mapper titan.mapper.UserMapperother.mapper.RoleMapper,使用前者時會自動連接titan庫,後者連接ds2庫。

動態數據源
使用動態數據源的初衷,是能在應用層做到讀寫分離,即在程序代碼中控制不同的查詢方法去連接不同的庫。除了這種方法以外,數據庫中間件也是個不錯的選擇,它的優點是數據庫集羣對應用來說只暴露爲單庫,不需要切換數據源的代碼邏輯。

我們通過自定義註解 + AOP的方式實現數據源動態切換。

首先定義一個ContextHolder, 用於保存當前線程使用的數據源名:

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

    /**
     * 默認數據源
     */
    public static final String DEFAULT_DS = "titan-master";

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

    // 設置數據源名
    public static void setDB(String dbType) {
        log.debug("切換到{}數據源", dbType);
        contextHolder.set(dbType);
    }

    // 獲取數據源名
    public static String getDB() {
        return (contextHolder.get());
    }

    // 清除數據源名
    public static void clearDB() {
        contextHolder.remove();
    }
}


然後自定義一個javax.sql.DataSource接口的實現,這裏只需要繼承Spring爲我們預先實現好的父類AbstractRoutingDataSource即可:

public class DynamicDataSource extends AbstractRoutingDataSource {
    private static final Logger log = LoggerFactory.getLogger(DynamicDataSource.class);

    @Override
    protected Object determineCurrentLookupKey() {
        log.debug("數據源爲{}", DataSourceContextHolder.getDB());

        return DataSourceContextHolder.getDB();
    }

}


創建動態數據源:

/**
     * 動態數據源: 通過AOP在不同數據源之間動態切換
     * @return
     */
    @Bean(name = "dynamicDS1")
    public DataSource dataSource() {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        // 默認數據源
        dynamicDataSource.setDefaultTargetDataSource(dataSource1());

        // 配置多數據源
        Map<Object, Object> dsMap = new HashMap(5);
        dsMap.put("titan-master", dataSource1());
        dsMap.put("ds2", dataSource2());

        dynamicDataSource.setTargetDataSources(dsMap);

        return dynamicDataSource;
    }


自定義註釋@DS用於在編碼時指定方法使用哪個數據源:

@Retention(RetentionPolicy.RUNTIME)
@Target({
        ElementType.METHOD
})
public @interface DS {
    String value() default "titan-master";
}


編寫AOP切面,實現切換邏輯:

@Aspect
@Component
public class DynamicDataSourceAspect {

    @Before("@annotation(DS)")
    public void beforeSwitchDS(JoinPoint point){

        //獲得當前訪問的class
        Class<?> className = point.getTarget().getClass();

        //獲得訪問的方法名
        String methodName = point.getSignature().getName();
        //得到方法的參數的類型
        Class[] argClass = ((MethodSignature)point.getSignature()).getParameterTypes();
        String dataSource = DataSourceContextHolder.DEFAULT_DS;
        try {
            // 得到訪問的方法對象
            Method method = className.getMethod(methodName, argClass);

            // 判斷是否存在@DS註解
            if (method.isAnnotationPresent(DS.class)) {
                DS annotation = method.getAnnotation(DS.class);
                // 取出註解中的數據源名
                dataSource = annotation.value();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        // 切換數據源
        DataSourceContextHolder.setDB(dataSource);

    }


    @After("@annotation(DS)")
    public void afterSwitchDS(JoinPoint point){

        DataSourceContextHolder.clearDB();

    }
}


完成上述配置後,在先前SqlSessionFactory配置中指定使用DynamicDataSource就可以在Service中愉快的切換數據源了:

@Autowired
    private UserAModelMapper userAMapper;

    @DS("titan-master")
    public String ds1() {
        return userAMapper.selectByPrimaryKey(1).getName();
    }

    @DS("ds2")
    public String ds2() {
        return userAMapper.selectByPrimaryKey(1).getName();
    }



原文:https://blog.csdn.net/neosmith/article/details/61202084 
 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章