Spring Cloud GCP Firestore @Document注解动态加载集合名失败求助

我们基于Spring Cloud GCP Firestore搭建了包含实体、仓库、服务层的基础架构，想要通过application.properties中的环境配置动态指定@Document注解的collectionName，但调用firestoreEntityRepository.findById(documentId)时返回null；如果硬编码有效的集合名称，就能正常获取文档。试过多种SpEL写法（直接引用属性、通过配置Bean、environment/systemProperties）都没用，不想改用底层Firestore对象操作，求可行解决方案。

现有代码结构 #

Firestore 实体类 #

import com.google.cloud.firestore.annotation.DocumentId;
import com.google.cloud.spring.data.firestore.Document;

@Document(collectionName = "${api.firestore.collection}")
public class FirestoreEntity {
    @DocumentId
    String documentId;
    String fieldOne;
    String fieldTwo;
}

Firestore 实体仓库 #

import com.google.cloud.spring.data.firestore.FirestoreReactiveRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface FirestoreEntityRepository extends FirestoreReactiveRepository<FirestoreEntity> {
}

Firestore 实体服务类 #

@Service
public class FirestoreEntityService {

    private final FirestoreEntityRepository firestoreEntityRepository;
    
    public FirestoreEntityService(FirestoreEntityRepository firestoreEntityRepository) {
        this.firestoreEntityRepository= firestoreEntityRepository;
    }

    public FirestoreEntity getFirestoreEntity(String documentId) {
        return firestoreEntityRepository
                .findById(documentId)
                .block();
    }
}

已尝试的无效写法 #

• 配置FirestoreConfigProperties Bean后引用：

  @Document(collectionName = "#{@firestoreConfigProperties.getCollection()}")
  

• 使用environment或systemProperties：

  @Document(collectionName = "#{@environment.getProperty('api.firestore.collection')}")
  

  @Document(collectionName = "#{systemProperties['api.firestore.collection']}")
  

可行解决方案 #

方案1：自定义仓库实现类，动态绑定集合名 #

Spring Data Firestore的默认仓库实现会在启动时静态解析@Document的集合名，无法动态读取配置。可以自定义仓库实现，借助FirestoreTemplate动态获取配置中的集合名称：

1. 修改仓库接口（保留原有方法即可）：

@Repository
public interface FirestoreEntityRepository extends FirestoreReactiveRepository<FirestoreEntity> {
}

2. 编写仓库实现类：

public class FirestoreEntityRepositoryImpl implements FirestoreEntityRepository {

    private final FirestoreTemplate firestoreTemplate;
    private final Environment environment;

    public FirestoreEntityRepositoryImpl(FirestoreTemplate firestoreTemplate, Environment environment) {
        this.firestoreTemplate = firestoreTemplate;
        this.environment = environment;
    }

    @Override
    public Mono<FirestoreEntity> findById(String documentId) {
        // 从配置中读取集合名
        String collectionName = environment.getProperty("api.firestore.collection");
        return firestoreTemplate.get(documentId, FirestoreEntity.class, collectionName);
    }

    // 其他父接口方法（如save、delete等）若需使用动态集合，需类似实现
    @Override
    public <S extends FirestoreEntity> Mono<S> save(S entity) {
        String collectionName = environment.getProperty("api.firestore.collection");
        return firestoreTemplate.save(entity, collectionName);
    }
}

3. 在配置类中注册自定义仓库：

@Configuration
public class FirestoreConfig {
    @Bean
    public FirestoreEntityRepository firestoreEntityRepository(FirestoreTemplate firestoreTemplate, Environment environment) {
        return new FirestoreEntityRepositoryImpl(firestoreTemplate, environment);
    }
}

方案2：直接使用FirestoreTemplate操作 #

跳过Spring Data仓库，在服务层直接注入FirestoreTemplate，动态读取配置后执行操作：

@Service
public class FirestoreEntityService {

    private final FirestoreTemplate firestoreTemplate;
    private final Environment environment;

    public FirestoreEntityService(FirestoreTemplate firestoreTemplate, Environment environment) {
        this.firestoreTemplate = firestoreTemplate;
        this.environment = environment;
    }

    public FirestoreEntity getFirestoreEntity(String documentId) {
        String collectionName = environment.getProperty("api.firestore.collection");
        return firestoreTemplate.get(documentId, FirestoreEntity.class, collectionName).block();
    }
}

方案3：升级Spring Cloud GCP版本 #

部分旧版本的Spring Cloud GCP Firestarter不支持@Document注解中的占位符解析，升级到4.x及以上版本后，直接使用@Document(collectionName = "${api.firestore.collection}")即可正常解析配置值。

内容的提问来源于stack exchange，提问作者Vivek T S