如何让自定义Spring Cloud Stream Binder仅作用于特定绑定？

1. 为自定义Pub/Sub Binder设置唯一标识 #

在自定义Binder的配置类中，给它指定一个独一无二的类型标识（比如custom-pubsub），避免和原生Pub/Sub Binder的默认类型pubsub冲突：

@Configuration
public class CustomPubSubBinderConfiguration {

    @Bean
    public Binder<?, ?, ?> customPubSubBinder(PubSubConfigurationProperties properties,
                                              PubSubMessageChannelBinderFactory factory) {
        PubSubMessageChannelBinder binder = factory.createBinder(properties);
        // 设置自定义binder类型标识
        binder.setBinderType("custom-pubsub");
        // 在这里添加你的自定义逻辑，比如取消订阅名称格式限制
        return binder;
    }
}

如果使用Spring Cloud Stream 3.1+版本，也可以直接用@StreamBinder注解指定binder名称：

@StreamBinder("custom-pubsub")
public class CustomPubSubBinder extends PubSubMessageChannelBinder {
    // 你的自定义实现逻辑
}

2. 在配置文件中明确绑定与Binder的对应关系 #

在application.yml或application.properties里，分别配置自定义Pub/Sub Binder、RabbitMQ Binder，并为每个绑定指定对应的binder：

YAML示例 #

spring:
  cloud:
    stream:
      binders:
        # 配置自定义Pub/Sub binder
        custom-pubsub:
          type: custom-pubsub
          environment:
            spring:
              cloud:
                gcp:
                  pubsub:
                    project-id: your-project-id
        # 配置RabbitMQ binder
        rabbit:
          type: rabbit
          environment:
            spring:
              rabbitmq:
                host: your-rabbit-host
                port: 5672
                username: guest
                password: guest
      bindings:
        # 指定使用自定义Pub/Sub binder的绑定
        pubsub-custom-input:
          destination: your-pubsub-topic
          binder: custom-pubsub
          group: your-sub-group
        # 指定使用RabbitMQ binder的绑定
        rabbit-input:
          destination: your-rabbit-queue
          binder: rabbit

Properties示例 #

# 配置自定义Pub/Sub binder
spring.cloud.stream.binders.custom-pubsub.type=custom-pubsub
spring.cloud.stream.binders.custom-pubsub.environment.spring.cloud.gcp.pubsub.project-id=your-project-id

# 配置RabbitMQ binder
spring.cloud.stream.binders.rabbit.type=rabbit
spring.cloud.stream.binders.rabbit.environment.spring.rabbitmq.host=your-rabbit-host
spring.cloud.stream.binders.rabbit.environment.spring.rabbitmq.port=5672

# 指定绑定对应的binder
spring.cloud.stream.bindings.pubsub-custom-input.destination=your-pubsub-topic
spring.cloud.stream.bindings.pubsub-custom-input.binder=custom-pubsub
spring.cloud.stream.bindings.pubsub-custom-input.group=your-sub-group

spring.cloud.stream.bindings.rabbit-input.destination=your-rabbit-queue
spring.cloud.stream.bindings.rabbit-input.binder=rabbit

3. 排除原生Pub/Sub Binder（可选） #

如果不需要使用原生的Pub/Sub Binder，可以在启动类中排除其自动配置类，彻底避免类型冲突：

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

完成以上配置后，自定义的custom-pubsub binder只会被指定的绑定调用，RabbitMQ绑定会正常使用默认的Rabbit binder。

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