Spring应用启动失败：缺失SpannerTemplate类型Bean的问题求助

问题概述 #

启动集成Cloud Spanner的Spring应用时，抛出如下错误：

2024-09-24 17:13:12.821 | [main] | ERROR | traceId:  | o.s.b.d.LoggingFailureAnalysisReporter - 

***************************
APPLICATION FAILED TO START
***************************

Description:

Field spannerTemplate in com.sams.payment.common.dbservice.AuthorizationDBService required a bean of type 'org.springframework.cloud.gcp.data.spanner.core.SpannerTemplate' that could not be found.

The injection point has the following annotations:
    - @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'org.springframework.cloud.gcp.data.spanner.core.SpannerTemplate' in your configuration.

使用的Spanner依赖：

<dependency>
  <artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
  <groupId>org.springframework.cloud</groupId>
  <version>1.2.8.RELEASE</version>
</dependency>

application.properties配置：

spring.cloud.gcp.spanner.enabled=xxxx
spring.cloud.gcp.spanner.instance-id=xxxx
spring.cloud.gcp.spanner.database=xxx
spring.cloud.gcp.spanner.project-id=xxx
spring.cloud.gcp.credentials.location=xxxx
spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade=xxxx

可能原因 #

1. 依赖版本过旧：1.2.8.RELEASE是2020年的旧版本，自动配置逻辑存在局限性，且可能与当前使用的Spring Boot版本不兼容，导致SpannerTemplate自动配置Bean未被创建。
2. 配置项无效：spring.cloud.gcp.spanner.enabled=xxxx配置了非布尔值（应为true/false），触发自动配置类跳过初始化；其他配置项若为无效占位符，也会导致自动配置失败。
3. 自动配置未被扫描：Spring Boot启动类的@ComponentScan范围未覆盖Spanner自动配置类，或者旧版本需要额外注解触发配置。
4. 凭证配置错误：spring.cloud.gcp.credentials.location路径无效或凭证文件损坏，导致自动配置类因无法连接Spanner而跳过Bean创建。

解决方案 #

1. 修复配置项有效性 #

将spring.cloud.gcp.spanner.enabled改为true（默认也是true，可省略），确保所有配置项填写实际有效值：

spring.cloud.gcp.spanner.enabled=true
spring.cloud.gcp.spanner.instance-id=你的实例ID
spring.cloud.gcp.spanner.database=你的数据库名
spring.cloud.gcp.spanner.project-id=你的GCP项目ID
spring.cloud.gcp.credentials.location=classpath:你的凭证文件路径.json
spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade=true

2. 升级依赖版本 #

1.2.8.RELEASE已停止维护，建议升级到与Spring Boot版本匹配的稳定版：

• Spring Boot 3.x → Spring Cloud GCP 4.x系列（如4.1.0）
• Spring Boot 2.7.x → Spring Cloud GCP 3.x系列（如3.6.0）

更新后的依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
    <version>4.1.0</version>
</dependency>

3. 确保自动配置被触发 #

• 检查Spring Boot启动类是否在项目根包下，或通过@ComponentScan明确包含自动配置类所在包；
• 旧版本（如1.x）需在启动类添加@EnableSpannerRepositories注解（即使不使用Repository，也能触发SpannerTemplate的自动配置）：

  @SpringBootApplication
  @EnableSpannerRepositories
  public class PaymentApplication {
      public static void main(String[] args) {
          SpringApplication.run(PaymentApplication.class, args);
      }
  }
  

4. 手动配置SpannerTemplate（兜底方案） #

若自动配置仍未生效，可手动创建SpannerTemplate Bean：

@Configuration
public class SpannerConfig {

    @Value("${spring.cloud.gcp.spanner.project-id}")
    private String projectId;

    @Value("${spring.cloud.gcp.spanner.instance-id}")
    private String instanceId;

    @Value("${spring.cloud.gcp.spanner.database}")
    private String database;

    @Value("${spring.cloud.gcp.credentials.location}")
    private Resource credentialsResource;

    @Bean
    public SpannerTemplate spannerTemplate() throws IOException {
        // 加载GCP凭证
        ServiceAccountCredentials credentials = ServiceAccountCredentials.fromStream(credentialsResource.getInputStream());
        
        // 创建Spanner客户端
        Spanner spanner = SpannerOptions.newBuilder()
                .setProjectId(projectId)
                .setCredentials(credentials)
                .build()
                .getService();
                
        DatabaseClient databaseClient = spanner.getDatabaseClient(
                DatabaseId.of(projectId, instanceId, database)
        );
        
        return new SpannerTemplate(databaseClient);
    }
}

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