SpringBoot實現(xiàn)動態(tài)數(shù)據(jù)源切換的項目實踐

更新時間：2024年04月12日 10:39:22 作者：擁抱AI

在實際開發(fā)過程中,我們經(jīng)常遇到需要同時操作多個數(shù)據(jù)源的情況,本文主要介紹了SpringBoot實現(xiàn)動態(tài)數(shù)據(jù)源切換的項目實踐,具有一定的參考價值,感興趣的可以了解一下

一. 引言

在實際開發(fā)過程中，我們經(jīng)常遇到需要同時操作多個數(shù)據(jù)源的情況。例如，可能需要從不同的數(shù)據(jù)庫中讀取數(shù)據(jù)，或者根據(jù)業(yè)務(wù)需求將數(shù)據(jù)寫入不同的數(shù)據(jù)庫。在這種情況下，動態(tài)數(shù)據(jù)源切換就變得尤為重要。Spring Boot 提供了強大的數(shù)據(jù)源配置功能，使得動態(tài)數(shù)據(jù)源切換變得相對簡單。本文將詳細介紹如何在 Spring Boot 應用中實現(xiàn)動態(tài)數(shù)據(jù)源切換。

二. 準備工作

在開始實現(xiàn)動態(tài)數(shù)據(jù)源切換之前，我們需要做一些準備工作：

1.創(chuàng)建 Spring Boot 項目

首先，我們需要創(chuàng)建一個 Spring Boot 項目?？梢允褂?Spring Initializr（https://start.spring.io/）快速生成項目骨架。在創(chuàng)建項目時，選擇合適的 JDK 版本、項目構(gòu)建工具（如 Maven 或 Gradle）以及項目元數(shù)據(jù)（如項目名稱、描述、包名等）。

2.添加依賴

在項目的 pom.xml 文件中添加以下依賴：

<dependencies>
    <!-- Spring Boot Web 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Boot 數(shù)據(jù)源依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <!-- 數(shù)據(jù)庫驅(qū)動依賴，以 MySQL 為例 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

三. 實現(xiàn)動態(tài)數(shù)據(jù)源切換

接下來，我們將介紹如何實現(xiàn)動態(tài)數(shù)據(jù)源切換。主要分為以下幾個步驟：

1.配置數(shù)據(jù)源

在 application.properties 或 application.yml 文件中配置多個數(shù)據(jù)源，如下所示：

spring:
  datasource:
    primary:
      url: jdbc:mysql://localhost:3306/db1?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
    secondary:
      url: jdbc:mysql://localhost:3306/db2?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver

2.創(chuàng)建數(shù)據(jù)源配置類

創(chuàng)建一個數(shù)據(jù)源配置類，用于生成 DataSource 對象。這里我們使用 Java 配置的方式，如下所示：

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

3.創(chuàng)建動態(tài)數(shù)據(jù)源路由

創(chuàng)建一個動態(tài)數(shù)據(jù)源路由類，用于根據(jù)不同的條件切換不同的數(shù)據(jù)源。如下所示：

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

4.配置數(shù)據(jù)源路由

在 application.properties 或 application.yml 文件中配置數(shù)據(jù)源路由，如下所示：

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    dynamic:
      primary: primaryDataSource
      secondary: secondaryDataSource

5.創(chuàng)建數(shù)據(jù)源切換切面

創(chuàng)建一個切面類，用于在方法執(zhí)行前切換數(shù)據(jù)源，在方法執(zhí)行后恢復數(shù)據(jù)源。如下所示：

@Aspect
@Component
public class DynamicDataSourceAspect {
    @Before("@annotation(TargetDataSource)")
    public void switchDataSource(JoinPoint point) {
        // 獲取方法上的注解
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        TargetDataSource ds = method.getAnnotation(TargetDataSource.class);
        // 判斷注解是否為空
        if (ds == null) {
            return;
        }
        // 切換數(shù)據(jù)源
        DynamicDataSourceContextHolder.setDataSourceType(ds.name());
    }
    @After("@annotation(TargetDataSource)")
    public void restoreDataSource(JoinPoint point) {
        // 獲取方法上的注解
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        TargetDataSource ds = method.getAnnotation(TargetDataSource.class);
        // 判斷注解是否為空
        if (ds == null) {
            return;
        }
        // 恢復數(shù)據(jù)源
        DynamicDataSourceContextHolder.clearDataSourceType();
    }
}

6.創(chuàng)建自定義注解

創(chuàng)建一個自定義注解，用于標記需要切換數(shù)據(jù)源的方法。如下所示：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TargetDataSource {
    String name();
}

7.使用自定義注解

在需要切換數(shù)據(jù)源的方法上使用自定義注解，如下所示：

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;
    @TargetDataSource(name = "primary")
    public List<User> findUsersFromPrimary() {
        return userMapper.findAll();
    }
    @TargetDataSource(name = "secondary")
    public List<User> findUsersFromSecondary() {
        return userMapper.findAll();
    }
}

四. 測試動態(tài)數(shù)據(jù)源切換

為了驗證我們的動態(tài)數(shù)據(jù)源切換是否生效，我們可以編寫一些測試用例來模擬不同的數(shù)據(jù)源切換場景。
首先，我們需要創(chuàng)建一個簡單的實體類和對應的倉庫接口：

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    // 省略 getter 和 setter
}
public interface UserRepository extends JpaRepository<User, Long> {
}

然后，我們可以編寫一個測試類來測試動態(tài)數(shù)據(jù)源的切換：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;
    @Test
    public void testDynamicDataSource() {
        List<User> usersFromPrimary = userService.findUsersFromPrimary();
        List<User> usersFromSecondary = userService.findUsersFromSecondary();
        
        // 假設(shè)我們期望從主數(shù)據(jù)源和從數(shù)據(jù)源分別查詢到不同的用戶列表
        assertNotNull(usersFromPrimary);
        assertNotNull(usersFromSecondary);
        assertNotEquals(usersFromPrimary, usersFromSecondary);
    }
}

在這個測試類中，我們注入了 UserService，并調(diào)用了兩個方法來分別從主數(shù)據(jù)源和從數(shù)據(jù)源查詢用戶列表。我們使用了 assertNotNull 和 assertNotEquals 來驗證查詢結(jié)果，確保我們從兩個不同的數(shù)據(jù)源獲取到了不同的數(shù)據(jù)。

五. 注意事項

在實現(xiàn)動態(tài)數(shù)據(jù)源切換時，有幾個注意事項需要牢記：

確保所有的數(shù)據(jù)源配置都是正確的，包括URL、用戶名、密碼和驅(qū)動類名。
在切換數(shù)據(jù)源時，要確保在操作完成后恢復到默認數(shù)據(jù)源，以避免影響其他業(yè)務(wù)邏輯。
在生產(chǎn)環(huán)境中，要考慮數(shù)據(jù)源切換的性能影響，尤其是在高并發(fā)場景下。
動態(tài)數(shù)據(jù)源切換可能會增加代碼的復雜性，因此要謹慎使用，確保它帶來的好處大于維護成本。

六. 總結(jié)

本文詳細介紹了在 Spring Boot 應用中實現(xiàn)動態(tài)數(shù)據(jù)源切換的方法。通過配置多個數(shù)據(jù)源、創(chuàng)建數(shù)據(jù)源路由、使用切面編程和自定義注解，我們可以在運行時根據(jù)業(yè)務(wù)需求靈活地切換數(shù)據(jù)源。這種方法特別適合于需要同時訪問多個數(shù)據(jù)庫或數(shù)據(jù)源的應用場景。雖然動態(tài)數(shù)據(jù)源切換增加了系統(tǒng)的復雜性，但正確使用它可以為應用帶來更高的靈活性和可擴展性。

到此這篇關(guān)于SpringBoot實現(xiàn)動態(tài)數(shù)據(jù)源切換的項目實踐的文章就介紹到這了,更多相關(guān)SpringBoot 動態(tài)數(shù)據(jù)源切換內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: