Spring动态注册多数据源的实现方法

下面为您详细讲解“Spring动态注册多数据源的实现方法”的完整攻略。

1. 前言

在实际开发中，我们常常会遇到需要使用多个数据源的情况，而且这些数据源可能会在程序运行过程中动态变化。比如说，有些系统会支持多租户，每个租户对应一个数据库，而且租户的数量是不固定的。这种情况下，我们就需要动态注册多个数据源，并在运行时根据需要选择合适的数据源。

Spring提供了很好的支持解决这个问题。在接下来的内容中，我们将演示如何使用Spring动态注册多个数据源，并在运行时选择合适的数据源。

2. 实现方法

2.1 多数据源配置

在Spring中使用多个数据源，我们通常需要配置多个数据源和对应的事务管理器。如下为一个多数据源配置示例：

spring:
  datasource:
    primary:
      url: jdbc:mysql://localhost:3306/primary
      username: root
      password: root
    secondary:
      url: jdbc:mysql://localhost:3306/secondary
      username: root
      password: root

    # 动态数据源配置
    dynamic:
      primary: primary
      secondary: secondary
      enable: true

上述配置我们定义了两个数据源，分别为primary和secondary，且dynamic.enable为true表示启用了动态数据源。

2.2 动态数据源实现

在动态数据源实现中，我们需要实现两个类：DynamicDataSource（动态数据源）和DynamicDataSourceConfig（动态数据源配置）。

其中，DynamicDataSource类为我们动态数据源的核心类，继承AbstractRoutingDataSource，它实现了determineCurrentLookupKey方法，该方法用于返回当前使用的数据源的名称。每次使用JdbcTemplate进行数据操作时，Spring都会调用这个方法来获取当前数据源的名称，然后根据这个名称选择合适的数据源。

public class DynamicDataSource extends AbstractRoutingDataSource {
    /**
     * 获取当前数据源名称
     * @return 数据源名称
     */
    @Override
    protected Object determineCurrentLookupKey() {
        return DynamicDataSourceHolder.getDataSourceName();
    }
}

DynamicDataSourceConfig类用于配置动态数据源。在这个类中，我们需要先定义多个数据源，然后将它们存放到一个Map中，最后将Map注入到动态数据源中即可。

@Configuration
public class DynamicDataSourceConfig {
    /**
     * 动态数据源配置
     * @return 动态数据源
     */
    @Bean
    public DynamicDataSource dynamicDataSource() {
        // 从数据源配置中获取所有数据源
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("primary", primaryDataSource());
        targetDataSources.put("secondary", secondaryDataSource());

        // 创建动态数据源
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setTargetDataSources(targetDataSources);
        dynamicDataSource.setDefaultTargetDataSource(primaryDataSource());

        return dynamicDataSource;
    }

    /**
     * primary数据源配置
     * @return 数据源
     */
    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    /**
     * secondary数据源配置
     * @return 数据源
     */
    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

2.3 动态切换数据源

动态切换数据源是整个动态数据源的核心功能。我们可以通过定义一个DynamicDataSourceHolder类来实现动态切换，该类定义了一个ThreadLocal变量用于存放当前数据源的名称。

public class DynamicDataSourceHolder {
    private static final ThreadLocal<String> dataSourceHolder = new ThreadLocal<>();

    /**
     * 设置数据源名称
     * @param dataSourceName 数据源名称
     */
    public static void setDataSourceName(String dataSourceName) {
        dataSourceHolder.set(dataSourceName);
    }

    /**
     * 获取数据源名称
     * @return 数据源名称
     */
    public static String getDataSourceName() {
        return dataSourceHolder.get();
    }

    /**
     * 清除数据源名称
     */
    public static void clearDataSourceName() {
        dataSourceHolder.remove();
    }
}

在具体业务处理中，我们需要动态切换数据源时，只需要先设置当前数据源的名称（通过DynamicDataSourceHolder.setDataSourceName方法），然后进行数据操作即可。

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    /**
     * 获取所有用户
     * @return 用户列表
     */
    @Override
    public List<User> getUsers() {
        // 动态设置数据源名称
        DynamicDataSourceHolder.setDataSourceName("primary");

        // 执行查询操作
        String sql = "SELECT * FROM user";
        return jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(User.class));
    }
}

3. 示例

下面给出两个示例。第一个示例演示了动态切换数据源的过程，第二个示例演示了如何在程序运行时动态注册新的数据源。

3.1 动态切换数据源示例

在这个示例中，我们先定义两个数据源（primary和secondary），然后通过DynamicDataSourceHolder.setDataSourceName动态切换数据源。

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 获取所有用户（使用primary数据源）
     * @return 用户列表
     */
    @GetMapping("/primary")
    public List<User> getUsersFromPrimary() {
        DynamicDataSourceHolder.setDataSourceName("primary");
        return userService.getUsers();
    }

    /**
     * 获取所有用户（使用secondary数据源）
     * @return 用户列表
     */
    @GetMapping("/secondary")
    public List<User> getUsersFromSecondary() {
        DynamicDataSourceHolder.setDataSourceName("secondary");
        return userService.getUsers();
    }
}

3.2 动态注册新的数据源示例

在这个示例中，我们首先定义了两个数据源（primary和secondary），然后通过注入DynamicDataSourceConfig对象，调用其addDataSource方法动态添加了一个新的数据源（test）。

@RestController
@RequestMapping("/datasource")
public class DynamicDataSourceController {
    @Autowired
    private DynamicDataSourceConfig dynamicDataSourceConfig;

    /**
     * 获取所有数据源名称
     * @return 数据源名称列表
     */
    @GetMapping("/names")
    public List<String> getAllDataSourceNames() {
        return new ArrayList<>(DynamicDataSourceContextHolder.getDataSourceNames());
    }

    /**
     * 添加新数据源
     * @param name 数据源名称
     * @param url 数据库URL
     * @param username 用户名
     * @param password 密码
     * @return 添加结果
     */
    @PostMapping("/add")
    public String addDataSource(@RequestParam String name,
                                @RequestParam String url,
                                @RequestParam String username,
                                @RequestParam String password) {
        dynamicDataSourceConfig.addDataSource(name, url, username, password);
        return "success";
    }
}

4. 结束语

至此，Spring动态注册多数据源的实现方法就讲解完毕了。如果您有任何问题，请随时和我们进行交流。