springboot添加多數(shù)據(jù)源的方法實(shí)例教程

更新時(shí)間：2023年09月12日 10:51:51 作者：清風(fēng)怎不知意

這篇文章主要給大家介紹了關(guān)于springboot添加多數(shù)據(jù)源方法的相關(guān)資料,在實(shí)際開發(fā)中經(jīng)?？赡苡龅皆谝粋€(gè)應(yīng)用中可能要訪問多個(gè)數(shù)據(jù)庫多的情況,需要的朋友可以參考下

前言
添加多數(shù)據(jù)源的配置類
在application.yml中添加數(shù)據(jù)源配置
配置JdbcTemplate來訪問多個(gè)數(shù)據(jù)源
定義數(shù)據(jù)源配置類
實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源
實(shí)現(xiàn)數(shù)據(jù)源上下文
切換數(shù)據(jù)源
總結(jié)

前言

Spring Boot可以通過配置多個(gè)數(shù)據(jù)源來支持多數(shù)據(jù)源訪問，以下是一個(gè)基本的多數(shù)據(jù)源配置實(shí)例：

添加多數(shù)據(jù)源的配置類

創(chuàng)建一個(gè)配置類來配置多個(gè)數(shù)據(jù)源，可以使用@Configuration和@Primary注解來標(biāo)識(shí)主數(shù)據(jù)源，示例代碼如下：

@Configuration
public class DataSourceConfig {
    @Bean(name = "primaryDataSource")
    @Primary
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }
    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

在這個(gè)配置類中，我們定義了兩個(gè)數(shù)據(jù)源，一個(gè)是主數(shù)據(jù)源，一個(gè)是次要數(shù)據(jù)源。我們使用@ConfigurationProperties注解來設(shè)置每個(gè)數(shù)據(jù)源的配置參數(shù)。

在application.yml中添加數(shù)據(jù)源配置

添加application.yml配置文件，并在文件中添加多個(gè)數(shù)據(jù)源的配置信息，例如：

spring:
  datasource:
    primary:
      driver-class-name: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/test1
      username: root
      password: root
    secondary:
      driver-class-name: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/test2
      username: root
      password: root

我們使用了Spring Boot的默認(rèn)配置規(guī)則，通過指定數(shù)據(jù)源的名稱和屬性前綴來配置每個(gè)數(shù)據(jù)源。

配置JdbcTemplate來訪問多個(gè)數(shù)據(jù)源

現(xiàn)在我們已經(jīng)定義了兩個(gè)數(shù)據(jù)源，我們需要配置JdbcTemplate來訪問它們。我們可以在使用JdbcTemplate的每個(gè)方法中指定要使用的數(shù)據(jù)源，示例代碼如下：

@Repository
public class UserRepository {
    @Autowired
    @Qualifier("primaryDataSource")
    private DataSource primaryDataSource;
    @Autowired
    @Qualifier("secondaryDataSource")
    private DataSource secondaryDataSource;
    public List<User> getUsersFromPrimary() {
        JdbcTemplate jdbcTemplate = new JdbcTemplate(primaryDataSource);
        List<User> users = jdbcTemplate.query("SELECT * FROM users", new BeanPropertyRowMapper(User.class));
        return users;
    }
    public List<User> getUsersFromSecondary() {
        JdbcTemplate jdbcTemplate = new JdbcTemplate(secondaryDataSource);
        List<User> users = jdbcTemplate.query("SELECT * FROM users", new BeanPropertyRowMapper(User.class));
        return users;
    }
}

我們?cè)谧⑷隞dbcTemplate之前使用@Autowired注解將每個(gè)數(shù)據(jù)源注入到存儲(chǔ)庫類中。然后，我們可以在每個(gè)方法中使用JdbcTemplate來訪問不同的數(shù)據(jù)源。

這是一個(gè)基本的多數(shù)據(jù)源配置實(shí)例，你可以在此基礎(chǔ)上進(jìn)一步調(diào)整以滿足你的具體需求。

如果你使用的是MyBatis框架，你可以使用MyBatis的動(dòng)態(tài)數(shù)據(jù)源來實(shí)現(xiàn)多數(shù)據(jù)源配置，具體步驟如下

定義數(shù)據(jù)源配置類

首先，你需要定義一個(gè)數(shù)據(jù)源配置類來讀取和解析配置文件，然后根據(jù)配置創(chuàng)建數(shù)據(jù)源并將其添加到數(shù)據(jù)源列表中，示例代碼如下：

@Configuration
public class DataSourceConfig {
    @Value("${spring.datasource.type}")
    private Class<? extends DataSource> dataSourceType;
    @Bean(name = "masterDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.master")
    public DataSource masterDataSource() {
        return DataSourceBuilder.create().type(dataSourceType).build();
    }
    @Bean(name = "slaveDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.slave")
    public DataSource slaveDataSource() {
        return DataSourceBuilder.create().type(dataSourceType).build();
    }
    @Bean(name = "dynamicDataSource")
    public DataSource dynamicDataSource() {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceType.MASTER.name(), masterDataSource());
        targetDataSources.put(DataSourceType.SLAVE.name(), slaveDataSource());
        dynamicDataSource.setTargetDataSources(targetDataSources);
        dynamicDataSource.setDefaultTargetDataSource(masterDataSource());
        return dynamicDataSource;
    }
}

在這個(gè)配置類中，我們使用@ConfigurationProperties注解來讀取每個(gè)數(shù)據(jù)源的配置信息，然后使用DataSourceBuilder創(chuàng)建數(shù)據(jù)源對(duì)象。接著，我們使用DynamicDataSource類來管理多個(gè)數(shù)據(jù)源，將所有數(shù)據(jù)源添加到targetDataSources中并設(shè)置默認(rèn)數(shù)據(jù)源為masterDataSource。

實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源

接下來，你需要實(shí)現(xiàn)一個(gè)動(dòng)態(tài)數(shù)據(jù)源，它可以根據(jù)需要選擇不同的數(shù)據(jù)源，示例代碼如下：

public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DynamicDataSourceContextHolder.getDataSourceType();
    }
}

我們繼承了AbstractRoutingDataSource類，覆蓋了它的determineCurrentLookupKey()方法來獲取當(dāng)前線程所需的數(shù)據(jù)源類型，并返回?cái)?shù)據(jù)源名稱。

實(shí)現(xiàn)數(shù)據(jù)源上下文

最后，你需要?jiǎng)?chuàng)建一個(gè)數(shù)據(jù)源上下文來保存當(dāng)前線程所需的數(shù)據(jù)源類型，示例代碼如下：

public class DynamicDataSourceContextHolder {
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
    public static void setDataSourceType(String dataSourceType) {
        contextHolder.set(dataSourceType);
    }
    public static String getDataSourceType() {
        return contextHolder.get();
    }
    public static void clearDataSourceType() {
        contextHolder.remove();
    }
}

我們使用了ThreadLocal來保存當(dāng)前線程所需的數(shù)據(jù)源類型。你可以在需要訪問不同數(shù)據(jù)源的方法中調(diào)用setDataSourceType()方法來設(shè)置當(dāng)前線程所需的數(shù)據(jù)源類型，調(diào)用clearDataSourceType()方法來清除上下文。

最后，在你的MyBatis配置文件中，你可以使用${}占位符引用定義的動(dòng)態(tài)數(shù)據(jù)源，示例代碼如下：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dynamicDataSource"/>
    <property name="typeAliasesPackage" value="com.example.model"/>
</bean>

我們將MyBatis的SqlSessionFactoryBean中的dataSource屬性設(shè)置為定義的動(dòng)態(tài)數(shù)據(jù)源dynamicDataSource即可。

切換數(shù)據(jù)源

最后，你可以在需要訪問不同數(shù)據(jù)源的方法中調(diào)用DynamicDataSourceContextHolder.setDataSourceType()方法來設(shè)置當(dāng)前線程所需的數(shù)據(jù)源類型。例如，你可以定義一個(gè)注解來標(biāo)識(shí)使用哪個(gè)數(shù)據(jù)源，然后在方法上加上這個(gè)注解即可自動(dòng)切換數(shù)據(jù)源。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    DataSourceType value() default DataSourceType.MASTER;
}
@Aspect
@Component
public class DynamicDataSourceAspect {
    @Pointcut("@annotation(com.example.annotation.DataSource)")
    public void dataSourcePointcut() {
    }
    @Before("dataSourcePointcut()")
    public void before(JoinPoint joinPoint) {
        DataSource dataSource = getDataSource(joinPoint);
        if (dataSource != null) {
            DynamicDataSourceContextHolder.setDataSourceType(dataSource.value().name());
        }
    }
    @After("dataSourcePointcut()")
    public void after(JoinPoint joinPoint) {
        DynamicDataSourceContextHolder.clearDataSourceType();
    }
    private DataSource getDataSource(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        if (method.isAnnotationPresent(DataSource.class)) {
            return method.getAnnotation(DataSource.class);
        }
        return null;
    }
}

在這個(gè)例子中，我們定義了一個(gè)@DataSource注解來標(biāo)識(shí)使用哪個(gè)數(shù)據(jù)源，然后使用AOP來自動(dòng)切換數(shù)據(jù)源。在DynamicDataSourceAspect類中，我們使用@Pointcut注解來定義切點(diǎn)，然后使用@Before和@After注解來分別在方法調(diào)用前和方法調(diào)用后切換數(shù)據(jù)源。在切換數(shù)據(jù)源時(shí)，我們可以通過getDataSource()方法獲取方法上的@DataSource注解，并使用注解中定義的數(shù)據(jù)源類型來設(shè)置當(dāng)前線程所需的數(shù)據(jù)源類型。