root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Polish AMQP doc

Browse Source 
Closes gh-3431
pull/3435/head
Stephane Nicoll 10 years ago
parent 0ce7be4413
commit 4602558a73
2 changed files with 28 additions and 68 deletions
Show Stats Download Patch File Download Diff File

1
spring-boot-docs/src/main/asciidoc/index.adoc
Unescape Escape View File

@ -34,6 +34,7 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
:spring-reference: http://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/htmlsingle
:spring-security-reference: http://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle
:spring-javadoc: http://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework
:spring-amqp-javadoc: http://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp
:spring-data-javadoc: http://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa
:spring-data-commons-javadoc: http://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data
:spring-data-mongo-javadoc: http://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb

95
spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
Unescape Escape View File

@ -2867,7 +2867,6 @@ locate a JMS `ConnectionFactory` using JNDI. By default the locations `java:/Jms
[[boot-features-using-jms-template]]
[[boot-features-using-jms-sending]]
==== Sending a message
Spring's `JmsTemplate` is auto-configured and you can autowire it directly into your own
@ -2936,14 +2935,14 @@ more details.
[[boot-features-amqp]]
=== AMQP
The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level protocol for
message-oriented middleware. The Spring AMQP project applies core Spring concepts to the development of
AMQP-based messaging solutions.
The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level protocol
for message-oriented middleware. The Spring AMQP project applies core Spring concepts to
the development of AMQP-based messaging solutions.
[[boot-features-rabbitmq]]
==== RabbitMQ support
RabbitMQ is a lightweight, reliable, scalable and portable message broker based on the AMQP protocol.
Spring uses RabbitMQ to communicate using the AMQP protocol.
RabbitMQ is a lightweight, reliable, scalable and portable message broker based on the
AMQP protocol. Spring uses `RabbitMQ` to communicate using the AMQP protocol.
RabbitMQ configuration is controlled by external configuration properties in
`+spring.rabbitmq.*+`. For example, you might declare the following section in
@ -2953,8 +2952,8 @@ RabbitMQ configuration is controlled by external configuration properties in
----
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
spring.rabbitmq.username=admin
spring.rabbitmq.password=secret
----
See
@ -2964,24 +2963,22 @@ for more of the supported options.
TIP: Check http://spring.io/blog/2010/06/14/understanding-amqp-the-protocol-used-by-rabbitmq/[Understanding AMQP, the protocol used by RabbitMQ]
for more details.
[[boot-features-using-amqp-template]]
[[boot-features-using-amqp-sending]]
==== Sending a message
Spring's `AmqpTemplate` and `AmqpAdmin` are auto-configured and you can autowire them directly into your own
beans:
Spring's `AmqpTemplate` and `AmqpAdmin` are auto-configured and you can autowire them
directly into your own beans:
[source,java,indent=0]
----
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.amqp.core.AmqpAdmin;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
private final AmqpAdmin amqpAdmin;
private final AmqpTemplate amqpTemplate;
@Autowired
@ -2995,76 +2992,38 @@ beans:
}
----
To send a message you should declare a queue using `AmqpAdmin` and then use `AmqpTemplate` to send
the message to the declared queue.
NOTE: {spring-amqp-javadoc}/rabbit/core/RabbitMessagingTemplate.{dc-ext}[`RabbitMessagingTemplate`]
can be injected in a similar manner.
[source,java,indent=0]
----
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.amqp.core.AmqpAdmin;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
// ...
@PostConstruct
public void setUpQueue() {
this.amqpAdmin.declareQueue(new Queue("foo"));
}
public void send() {
this.rabbitTemplate.convertAndSend("foo", "hello");
}
}
----
Any `org.springframework.amqp.core.Queue` that is defined as a bean will be automatically
used to declare a corresponding queue on the RabbitMQ instance if necessary.
[[boot-features-using-amqp-receiving]]
==== Receiving a message
Spring's `ConnectionFactory` is auto-configured and you can autowire it directly into your own
beans.
To receive a message from a queue you should create a `SimpleMessageListenerContainer`
using the configured `ConnectionFactory`. The `SimpleMessageListenerContainer` is
responsible for handling incoming messages through it's `MessageListenerAdapter`.
When the Rabbit infrastructure is present, any bean can be annotated with `@RabbitListener`
to create a listener endpoint. If no `RabbitListenerContainerFactory` has been defined, a
default one is configured automatically.
[source,java,indent=0]
----
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
import org.springframework.amqp.rabbit.listener.adapter.MessageListenerAdapter;
The following component creates a listener endpoint on the `someQueue` queue:
@SpringBootApplication
public class AmqpDemoApplication {
@Autowired
private ConnectionFactory connectionFactory;
[source,java,indent=0]
----
@Component
public class MyBean {
@Bean
public SimpleMessageListenerContainer container() {
SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(
this.connectionFactory);
MessageListenerAdapter adapter = new MessageListenerAdapter(new Object() {
public void handleMessage(String msg) {
System.out.println(msg);
}
});
container.setMessageListener(adapter);
container.setQueueNames("foo");
return container;
@RabbitListener(queues = "someQueue")
public void processMessage(String content) {
// ...
}
// ...
}
----
In the code above the `SimpleMessageListenerContainer` was configured to receive messages from the declared "foo" queue.
When a message is sent to "foo" queue it will be delivered to the handleMessage(String msg) method.
TIP: Check {spring-amqp-javadoc}/rabbit/annotation/EnableRabbit.{dc-ext}[the Javadoc of `@EnableRabbit`]
for more details.

Write Preview
Loading…
Cancel
Save