servicebus-messaging

page_type	languages	products	description	urlFragment
sample	java	azure-service-bus	Azure Spring Cloud Sample project for Messaging Service Bus client library	azure-spring-cloud-sample-messaging-service-bus

Spring Cloud Azure Messaging Service Bus Sample shared library for Java

Key concepts

This code sample demonstrates how to use AzureMessageListener.java to listen to messages from Service Bus Topic.

Getting started

Running this sample will be charged by Azure. You can check the usage and bill at this link.

Create Azure resources

1. Create Azure Service Bus Namespace. Please note Basic tier is unsupported.

2. Create Azure Service Bus Topic and named topic. After creating the Azure Service Bus Topic, you can create the subscription Azure Service Bus Topic subscription to the topic and named sub .

Include the package

Because dependency azure-spring-cloud-starter-servicebus does not introduce the dependency about messaging, we need to add dependency azure-spring-cloud-messaging.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>azure-spring-cloud-messaging</artifactId>
    <version>2.10.0</version> <!-- {x-version-update;com.azure.spring:azure-spring-cloud-messaging;dependency} -->
</dependency>

Examples

1. Update application.yaml.

   spring:
     cloud:
       azure:
         servicebus:
           connection-string: [servicebus-namespace-connection-string]

2. Run the mvn spring-boot:run in the root of the code sample to get the app running.

3. Send a POST request

   $ curl -X POST http://localhost:8080/messages?message=hello
   

4. Verify in your app’s logs that a similar message was posted:

   New service bus topic message received: 'hello'
   

5. Delete the resources on Azure Portal to avoid unexpected charges.

Enhancement

Set Service Bus message headers

The following table illustrates how Spring message headers are mapped to Service Bus message headers and properties. When creat a message, developers can specify the header or property of a Service Bus message by below constants.

@Autowired
ServiceBusTopicOperation topicOperation;

@PostMapping("/messages")
public String send(@RequestParam("message") String message) {
    this.topicOperation.sendAsync(TOPIC_NAME,
                                  MessageBuilder.withPayload(message)
                                                .setHeader(SESSION_ID, "group1")
                                                .build());
    return message;
}

For some Service Bus headers that can be mapped to multiple Spring header constants, the priority of different Spring headers is listed.

Service Bus Message Headers and Properties	Spring Message Header Constants	Type	Priority Number (Descending priority)
ContentType	org.springframework.messaging.MessageHeaders.CONTENT_TYPE	String	N/A
CorrelationId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.CORRELATION_ID	String	N/A
MessageId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.MESSAGE_ID	String	1
MessageId	com.azure.spring.integration.core.AzureHeaders.RAW_ID	String	2
MessageId	org.springframework.messaging.MessageHeaders.ID	UUID	3
PartitionKey	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.PARTITION_KEY	String	N/A
ReplyTo	org.springframework.messaging.MessageHeaders.REPLY_CHANNEL	String	N/A
ReplyToSessionId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.REPLY_TO_SESSION_ID	String	N/A
ScheduledEnqueueTimeUtc	com.azure.spring.integration.core.AzureHeaders.SCHEDULED_ENQUEUE_MESSAGE	Integer	1
ScheduledEnqueueTimeUtc	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.SCHEDULED_ENQUEUE_TIME	Instant	2
SessionID	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.SESSION_ID	String	N/A
TimeToLive	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.TIME_TO_LIVE	Duration	N/A
To	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.TO	String	N/A

Troubleshooting

Next steps

Contributing