本文介绍了如何在 spring boot 应用中，根据实例类型（server 或 worker）动态启用或禁用 sqs 监听器。通过配置 `cloud.aws.sqs.autostart` 属性，并在 `simplemessagelistenercontainerfactory` 中使用该属性控制监听器的自动启动，可以实现只在 worker 实例上启动 sqs 监听器的需求。
在构建 Spring Boot 应用时，我们经常需要根据不同的实例类型来调整应用的行为。一个常见的场景是，某些实例负责将消息推送到 SQS 队列（Server 实例），而另一些实例则负责监听并处理这些消息（Worker 实例）。 本文将介绍如何配置 Spring Boot 应用，以在 Server 实例上禁用 SQS 监听器，仅在 Worker 实例上启用它。
实现方案
该方案的核心思想是利用 Spring Boot 的配置管理功能，为不同类型的实例提供不同的配置，并通过这些配置来控制 SimpleMessageListenerContainerFactory 的行为。
1. 配置属性 cloud.aws.sqs.autoStart
首先，我们需要在应用的配置文件中定义一个属性 cloud.aws.sqs.autoStart，用于控制 SQS 监听器的自动启动行为。 为 Server 实例和 Worker 实例创建不同的 YAML 配置文件，并在其中设置 cloud.aws.sqs.autoStart 的值。
- Server 实例的 YAML 配置文件 (例如 application-server.yml):
cloud:
aws:
sqs:
autoStart: false- Worker 实例的 YAML 配置文件 (例如 application-worker.yml):
cloud:
aws:
sqs:
autoStart: true2. 配置 SimpleMessageListenerContainerFactory
接下来，我们需要配置 SimpleMessageListenerContainerFactory，以便它能够根据 cloud.aws.sqs.autoStart 的值来决定是否自动启动 SQS 监听器。
import com.amazonaws.services.sqs.AmazonSQSAsync;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.aws.messaging.listener.SimpleMessageListenerContainerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SqsConfig {
@Value("${cloud.aws.sqs.autoStart}")
private boolean autoStart;
@Bean
public SimpleMessageListenerContainerFactory simpleMessageListenerContainerFactory(AmazonSQSAsync amazonSqs) {
SimpleMessageListenerContainerFactory factory = new SimpleMessageListenerContainerFactory();
factory.setAmazonSqs(amazonSqs);
factory.setAutoStartup(autoStart);
factory.setMaxNumberOfMessages(5);
return factory;
}
}在这个配置类中，我们使用 @Value 注解将 cloud.aws.sqs.autoStart 的值注入到 autoStart 变量中。 然后，在创建 SimpleMessageListenerContainerFactory 的 Bean 时，我们将 autoStart 的值传递给 factory.setAutoStartup() 方法。
3. 使用 @SqsListener 注解
最后，使用 @SqsListener 注解来定义 SQS 监听器。
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.aws.messaging.listener.annotation.SqsListener;
import org.springframework.stereotype.Component;
@Component
@Slf4j
public class SqsMessageListener {
@SqsListener("queue_name")
public void loadMessagesFromQueue(Object message) {
log.info("inside loadMessagesFromQueue");
log.info("Queue Messages: " + message);
}
}运行应用
现在，我们可以运行应用了。 确保 Server 实例和 Worker 实例分别使用对应的 YAML 配置文件启动。 例如，可以使用以下命令启动 Server 实例：
java -jar your-application.jar --spring.profiles.active=server
使用以下命令启动 Worker 实例：
java -jar your-application.jar --spring.profiles.active=worker
通过这种方式，只有 Worker 实例会启动 SQS 监听器，而 Server 实例则不会。
注意事项
- 确保在 Server 实例上禁用 SQS 监听器后，有其他机制来处理队列中的消息，否则消息可能会丢失。
- 可以根据实际需求调整 SimpleMessageListenerContainerFactory 的其他配置，例如 setMaxNumberOfMessages。
- 可以使用 Spring Boot 的 Profile 功能来更灵活地管理不同环境的配置。
总结
通过配置 cloud.aws.sqs.autoStart 属性，并在 SimpleMessageListenerContainerFactory 中使用该属性控制监听器的自动启动，我们可以轻松地在 Spring Boot 应用中动态启用或禁用 SQS 监听器。 这种方法使得我们可以根据实例类型来调整应用的行为，从而更好地满足不同的业务需求。
