Spring Boot同结构多数据源代码易维护实现方案咨询

核心思路：复用实体与仓库类，通过配置隔离数据源上下文 #

既然两个数据库表结构完全一致，根本不需要复制实体、仓库代码，核心是通过Spring的数据源配置、JPA配置以及注解/扫描策略来实现同一套代码对应不同数据源。

1. 复用实体类 #

• 实体类只编写一套，移除实体上@Table中硬编码的catalog/schema（如果存在），改为通过JPA配置动态指定。
• 在两个数据源的JPA配置中，设置它们扫描同一个实体包路径，让两套数据源上下文共享同一批实体定义。

2. 复用仓库接口 #

• 仓库接口仅维护一套，通过限定符（Qualifier）和多仓库上下文绑定实现同一接口对应不同数据源实例：
  1. 为两个数据源的EntityManagerFactory分别设置唯一的persistenceUnitName（如db1EntityManagerFactory、db2EntityManagerFactory）。
  2. 创建两个独立的JPA配置类，分别关联对应的EntityManagerFactory和事务管理器，同时配置它们扫描同一个仓库包路径。
  3. 在业务层注入仓库时，用@Qualifier指定使用对应数据源的仓库实例（如@Qualifier("db1UserRepository")）。

3. 配置层面的隔离与复用 #

• 数据源配置：将两个数据库的连接信息放在application.yml中按前缀区分（如spring.datasource.db1.*、spring.datasource.db2.*），通过@ConfigurationProperties绑定到配置类，避免硬编码。
• JPA配置示例（Db1JpaConfig）：

@Configuration
@EnableJpaRepositories(
        basePackages = "com.yourpackage.repository",
        entityManagerFactoryRef = "db1EntityManagerFactory",
        transactionManagerRef = "db1TransactionManager"
)
public class Db1JpaConfig {

    @Bean
    @ConfigurationProperties("spring.datasource.db1")
    public DataSource db1DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    public LocalContainerEntityManagerFactoryBean db1EntityManagerFactory(EntityManagerFactoryBuilder builder) {
        return builder
                .dataSource(db1DataSource())
                .packages("com.yourpackage.entity")
                .persistenceUnit("db1")
                .build();
    }

    @Bean
    public PlatformTransactionManager db1TransactionManager(@Qualifier("db1EntityManagerFactory") EntityManagerFactory emf) {
        return new JpaTransactionManager(emf);
    }
}

Db2JpaConfig结构完全一致，只需替换所有db1前缀为db2即可。

4. 业务层的优雅调用 #

• 在业务类中通过@Qualifier注入不同数据源的仓库实例：

@Service
public class DataService {
    private final UserRepository db1UserRepo;
    private final UserRepository db2UserRepo;

    public DataService(
            @Qualifier("db1UserRepository") UserRepository db1UserRepo,
            @Qualifier("db2UserRepository") UserRepository db2UserRepo) {
        this.db1UserRepo = db1UserRepo;
        this.db2UserRepo = db2UserRepo;
    }

    // 业务方法中按需调用对应数据源的仓库
}

注：db1UserRepository是Spring自动生成的Bean名称，规则为“数据源前缀+仓库接口名”，也可通过@EnableJpaRepositories的repositoryImplementationPostfix自定义。

5. 进阶优化：动态数据源切换（可选） #

如果需要在同一业务逻辑中切换数据源，可通过AbstractRoutingDataSource实现动态路由，无需维护两套仓库：

• 实现数据源上下文持有者：

public class DataSourceContextHolder {
    private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();

    public static void setDataSource(String dataSourceName) {
        CONTEXT_HOLDER.set(dataSourceName);
    }

    public static String getDataSource() {
        return CONTEXT_HOLDER.get();
    }

    public static void clearDataSource() {
        CONTEXT_HOLDER.remove();
    }
}

• 实现动态路由数据源：

public class DynamicRoutingDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDataSource();
    }
}

• 配置动态数据源并关联JPA：

@Configuration
public class DynamicDataSourceConfig {
    @Bean
    @ConfigurationProperties("spring.datasource.db1")
    public DataSource db1DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    @ConfigurationProperties("spring.datasource.db2")
    public DataSource db2DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    public DataSource dynamicDataSource() {
        DynamicRoutingDataSource routingDataSource = new DynamicRoutingDataSource();
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("db1", db1DataSource());
        targetDataSources.put("db2", db2DataSource());
        routingDataSource.setTargetDataSources(targetDataSources);
        routingDataSource.setDefaultTargetDataSource(db1DataSource());
        return routingDataSource;
    }

    // 后续JPA配置关联该dynamicDataSource，仓库仅需一套
}

• 自定义注解+AOP实现数据源切换：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSource {
    String value() default "db1";
}

@Aspect
@Component
public class DataSourceAspect {
    @Before("@annotation(dataSource)")
    public void setDataSource(DataSource dataSource) {
        DataSourceContextHolder.setDataSource(dataSource.value());
    }

    @After("@annotation(dataSource)")
    public void clearDataSource() {
        DataSourceContextHolder.clearDataSource();
    }
}

业务方法只需添加@DataSource("db2")即可切换到对应数据源，无需修改仓库结构。

内容的提问来源于stack exchange，提问作者user2674471