使用Spring Cloud GCP PubSubTemplate发布有序消息遇IllegalStateException报错求助

问题原因 #

你遇到的IllegalStateException是因为发布客户端未启用消息排序功能，但你尝试发布带有排序键（ordering key）的消息，违反了Pub/Sub的约束规则。

解决方案 #

需要修改PublisherFactory的配置，让它创建的Publisher客户端默认启用消息排序。具体通过DefaultPublisherFactory的setPublisherBuilderCustomizer方法，自定义Google Pub/Sub原生Publisher.Builder的配置，开启消息排序开关。

修改后的Bean定义代码 #

@Bean
public Credentials credentials() throws IOException {
    return GoogleCredentials.fromStream(Files.newInputStream(Paths.get(credentialsFilePath)));
}

@Bean
public PublisherFactory publisherFactory(Credentials credentials) {
    DefaultPublisherFactory factory = new DefaultPublisherFactory(() -> projectId);
    // 添加自定义配置，启用消息排序
    factory.setPublisherBuilderCustomizer(publisherBuilder -> 
        publisherBuilder.setEnableMessageOrdering(true)
    );
    return factory;
}

@Bean
public SubscriberFactory subscriberFactory(Credentials credentials) {
    return new DefaultSubscriberFactory(() -> projectId);
}

@Bean
public PubSubTemplate pubSubTemplate(
    PublisherFactory publisherFactory, SubscriberFactory subscriberFactory) {
    return new PubSubTemplate(publisherFactory, subscriberFactory);
}

关键修改说明 #

• 创建DefaultPublisherFactory实例后，调用setPublisherBuilderCustomizer传入Lambda表达式，对原生Publisher.Builder进行配置。
• 通过publisherBuilder.setEnableMessageOrdering(true)开启消息排序功能，后续所有通过该工厂创建的Publisher客户端都会默认支持有序消息发布。

额外注意事项 #

• Pub/Sub主题默认支持有序消息，无需额外配置主题，只要客户端启用排序功能即可。
• 若仅需针对特定主题启用排序，也可在发布消息时单独指定自定义Publisher配置，但全局配置更适合统一需求的场景。

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