界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

spring-amqp

spring-amqp

【开发与工程】Spring AMQP for RabbitMQ integration with RabbitTemplate and @RabbitListener. Covers exchanges, queues, bindings, DLQ, and message conversion. USE WHEN: user mentions "spring amqp", "RabbitTemplate", "@RabbitListener", "RabbitMQ Spring", "AMQP", "message queue Spring Boot" DO NOT USE FOR: raw RabbitMQ - use `rabbitmq` skill, Kafka - use `spring-kaf…

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: spring-amqp description: | Spring AMQP for RabbitMQ integration with RabbitTemplate and @RabbitListener. Covers exchanges, queues, bindings, DLQ, and message conversion.

USE WHEN: user mentions "spring amqp", "RabbitTemplate", "@RabbitListener", "RabbitMQ Spring", "AMQP", "message queue Spring Boot"

DO NOT USE FOR: raw RabbitMQ - use rabbitmq skill, Kafka - use spring-kafka skill, generic messaging patterns - use messaging-expert allowed-tools: Read, Grep, Glob, Write, Edit

Spring AMQP (RabbitMQ) - Quick Reference

Full Reference: See advanced.md for exchange types (topic, fanout), consumer patterns (multi-method, request-reply), error handling, DLQ processing, and testing.

Deep Knowledge: Use mcp__documentation__fetch_docs with technology: rabbitmq for comprehensive documentation.

Dependencies

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>

Configuration

spring:
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest
    listener:
      simple:
        acknowledge-mode: manual
        concurrency: 3
        max-concurrency: 10
        prefetch: 10

Exchange, Queue, Binding Setup

@Configuration
public class RabbitMQConfig {

    public static final String EXCHANGE = "orders.exchange";
    public static final String QUEUE = "orders.queue";
    public static final String ROUTING_KEY = "orders.created";

    @Bean
    public DirectExchange ordersExchange() {
        return new DirectExchange(EXCHANGE);
    }

    @Bean
    public Queue ordersQueue() {
        return QueueBuilder.durable(QUEUE)
            .withArgument("x-dead-letter-exchange", "orders.dlx")
            .withArgument("x-dead-letter-routing-key", "dead")
            .build();
    }

    @Bean
    public Binding ordersBinding() {
        return BindingBuilder.bind(ordersQueue()).to(ordersExchange()).with(ROUTING_KEY);
    }

    @Bean
    public Jackson2JsonMessageConverter messageConverter() {
        return new Jackson2JsonMessageConverter();
    }
}

Producer

@Service
@RequiredArgsConstructor
public class OrderProducer {

    private final RabbitTemplate rabbitTemplate;

    public void sendOrder(OrderEvent event) {
        rabbitTemplate.convertAndSend(EXCHANGE, ROUTING_KEY, event);
    }

    public void sendWithHeaders(OrderEvent event, String correlationId) {
        rabbitTemplate.convertAndSend(EXCHANGE, ROUTING_KEY, event, message -> {
            message.getMessageProperties().setCorrelationId(correlationId);
            message.getMessageProperties().setDeliveryMode(MessageDeliveryMode.PERSISTENT);
            return message;
        });
    }
}

Consumer

@Service
public class OrderConsumer {

    @RabbitListener(queues = "orders.queue")
    public void consume(
            @Payload OrderEvent event,
            @Header(AmqpHeaders.DELIVERY_TAG) long deliveryTag,
            @Header(AmqpHeaders.CORRELATION_ID) String correlationId,
            Channel channel) throws IOException {

        try {
            processOrder(event);
            channel.basicAck(deliveryTag, false);
        } catch (Exception e) {
            channel.basicNack(deliveryTag, false, false); // Send to DLQ
        }
    }
}

Best Practices

DoDon't
Use manual acknowledgmentAuto-ack without processing
Configure DLX/DLQSilently lose failed messages
Set message TTLKeep messages forever
Use persistent deliveryTransient for important messages
Configure prefetchUnbounded prefetch

When NOT to Use This Skill

  • Raw RabbitMQ - Use rabbitmq skill for server configuration
  • Kafka integration - Use spring-kafka skill
  • Generic messaging patterns - Consult messaging-expert

Anti-Patterns

Anti-PatternProblemSolution
Auto-ack without processingMessage lossUse manual acknowledgment
No DLQ configuredLost failed messagesConfigure dead letter exchange
Unbounded prefetchMemory issuesSet appropriate prefetch count
Blocking in listenerThread exhaustionUse async processing
No retry policyTemporary failures cause lossConfigure retry with backoff

Quick Troubleshooting

ProblemDiagnosticFix
Connection refusedCheck RabbitMQ runningVerify host/port
Message not consumedCheck queue bindingVerify routing key
Messages in DLQCheck x-death headerFix processing error
Consumer not startingCheck @RabbitListenerVerify queue exists
Serialization errorCheck message typeConfigure Jackson converter

Production Checklist

  • Connection factory configured
  • Manual acknowledgment mode
  • DLX/DLQ configured
  • Retry policy set
  • Message converter configured
  • Publisher confirms enabled
  • Prefetch count optimized
  • Error handler implemented
  • Message TTL set
  • Monitoring enabled

Reference Documentation

我的收藏