如何用Spring Cloud GCP Starter连接GCP Spanner多数据库及实例？

Spring Cloud GCP Spanner的自动配置默认只支持单实例/数据库连接，要实现多数据源或运行时切换，需要手动构建多组Spanner核心Bean，替代自动配置的单例组件，具体步骤如下：

1. 禁用自动配置，避免冲突 #

在Spring Boot启动类上排除Spanner的自动配置类，防止默认单例Bean干扰自定义配置：

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

2. 配置多组Spanner参数 #

在application.properties中定义多套实例/数据库配置（以两组为例）：

# 第一组Spanner配置
spanner.first.project-id=proj-1
spanner.first.instance-id=inst-1
spanner.first.database=db-1

# 第二组Spanner配置
spanner.second.project-id=proj-2
spanner.second.instance-id=inst-2
spanner.second.database=db-2

3. 手动构建多组Spanner核心Bean #

创建配置类，为每组配置生成独立的SpannerOptions、DatabaseClient、SpannerTemplate：

@Configuration
public class MultiSpannerConfig {

    // 第一组配置绑定
    @Bean
    @ConfigurationProperties(prefix = "spanner.first")
    public SpannerProperties firstSpannerProps() {
        return new SpannerProperties();
    }

    @Bean
    public SpannerOptions firstSpannerOptions(SpannerProperties firstProps) {
        return SpannerOptions.newBuilder()
                .setProjectId(firstProps.getProjectId())
                .build();
    }

    @Bean
    public DatabaseClient firstDbClient(SpannerOptions firstOptions, SpannerProperties firstProps) {
        DatabaseId dbId = DatabaseId.of(
                firstProps.getProjectId(),
                firstProps.getInstanceId(),
                firstProps.getDatabase()
        );
        return firstOptions.getServiceClient().getDatabaseClient(dbId);
    }

    @Bean("firstSpannerTemplate")
    public SpannerTemplate firstSpannerTemplate(DatabaseClient firstDbClient) {
        return new SpannerTemplate(firstDbClient);
    }

    // 第二组配置绑定（逻辑与第一组一致）
    @Bean
    @ConfigurationProperties(prefix = "spanner.second")
    public SpannerProperties secondSpannerProps() {
        return new SpannerProperties();
    }

    @Bean
    public SpannerOptions secondSpannerOptions(SpannerProperties secondProps) {
        return SpannerOptions.newBuilder()
                .setProjectId(secondProps.getProjectId())
                .build();
    }

    @Bean
    public DatabaseClient secondDbClient(SpannerOptions secondOptions, SpannerProperties secondProps) {
        DatabaseId dbId = DatabaseId.of(
                secondProps.getProjectId(),
                secondProps.getInstanceId(),
                secondProps.getDatabase()
        );
        return secondOptions.getServiceClient().getDatabaseClient(dbId);
    }

    @Bean("secondSpannerTemplate")
    public SpannerTemplate secondSpannerTemplate(DatabaseClient secondDbClient) {
        return new SpannerTemplate(secondDbClient);
    }
}

4. 为每组数据源绑定独立Repository #

通过@EnableSpannerRepositories为不同包下的Repository指定对应的SpannerTemplate，实现数据源隔离：

// 第一组Repository配置
@Configuration
@EnableSpannerRepositories(
        basePackages = "com.yourproject.repo.first",
        spannerTemplateRef = "firstSpannerTemplate"
)
public class FirstSpannerRepoConfig {
}

// 第二组Repository配置
@Configuration
@EnableSpannerRepositories(
        basePackages = "com.yourproject.repo.second",
        spannerTemplateRef = "secondSpannerTemplate"
)
public class SecondSpannerRepoConfig {
}

将对应的数据模型和SpannerRepository实现类分别放在com.yourproject.repo.first和com.yourproject.repo.second包下即可。

5. 运行时动态切换数据源 #

如果需要根据请求参数（如Header、Query Param）动态选择数据库，可以创建一个模板管理器，统一管理所有SpannerTemplate：

@Component
public class SpannerTemplateManager {

    private final Map<String, SpannerTemplate> templateMap;

    // 注入所有自定义的SpannerTemplate，按标识映射
    public SpannerTemplateManager(
            @Qualifier("firstSpannerTemplate") SpannerTemplate firstTemplate,
            @Qualifier("secondSpannerTemplate") SpannerTemplate secondTemplate
    ) {
        templateMap = new HashMap<>();
        templateMap.put("db1", firstTemplate);
        templateMap.put("db2", secondTemplate);
    }

    public SpannerTemplate getTemplate(String dbKey) {
        return templateMap.getOrDefault(dbKey, templateMap.get("db1"));
    }
}

在控制器中，根据请求参数获取对应模板执行操作：

@RestController
@RequestMapping("/data")
public class DataController {

    private final SpannerTemplateManager templateManager;

    public DataController(SpannerTemplateManager templateManager) {
        this.templateManager = templateManager;
    }

    @GetMapping
    public List<YourModel> getData(@RequestParam String dbKey) {
        SpannerTemplate template = templateManager.getTemplate(dbKey);
        return template.query(YourModel.class, "SELECT * FROM your_table");
    }
}

为什么之前的方案无效？ #

• 自动配置生成的SpannerTemplate等Bean是单例且启动时初始化，运行时修改application.properties不会触发Bean重建；
• Spring容器中的Bean默认是不可变的，直接修改自动生成的组件会导致全局状态混乱，无法实现多数据源隔离。

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