Use Azure Service Bus in Spring applications

This article shows you how to use Azure Service Bus in Java applications built with Spring Framework.

Azure provides an asynchronous messaging platform called Azure Service Bus (Service Bus), which is based on the Advanced Message Queueing Protocol 1.0 (AMQP 1.0) standard. You can use Service Bus across the range of supported Azure platforms.

Spring Cloud Azure provides various modules for sending messages to and receiving messages from Service Bus queues and topics/subscriptions using Spring frameworks.

You can use the following modules independently or combine them for different use cases:

• Spring Cloud Azure Service Bus Starter enables you to send and receive messages with the Service Bus Java SDK client library with Spring Boot features.

• Spring Cloud Azure Service Bus JMS Starter enables you to use the JMS API to send and receive messages with Service Bus queues and topics/subscriptions.

• Spring Messaging Azure Service Bus enables you to interact with Service Bus via the Spring Messaging API.

• Spring Integration Azure Service Bus enables you to connect Spring Integration Message Channels with Service Bus.

• Spring Cloud Stream Binder for Service Bus enables you to use Service Bus as a messaging middleware in Spring Cloud Stream applications.

Prerequisites

• An Azure subscription - create one for free.
• Java Development Kit (JDK) version 8 or higher.
• Apache Maven, version 3.0 or higher.
• An Azure Service Bus and queue or topic/subscription. If you don't have one, create a Service Bus queue or topic. For more information, see Use Azure portal to create a Service Bus namespace and a queue or Use the Azure portal to create a Service Bus topic and subscriptions to the topic.
• If you don't have a Spring Boot application, create a Maven project with the Spring Initializr. Be sure to select Maven Project and, under Dependencies, add the Spring Web dependency, and then select Java version 8 or higher.

Prepare your local environment

In this tutorial, the configurations and code don't have any authentication operations. However, connecting to an Azure service requires authentication. To complete the authentication, you need to use the Azure Identity client library. Spring Cloud Azure uses DefaultAzureCredential, which the Azure Identity library provides to help you get credentials without any code changes.

DefaultAzureCredential supports multiple authentication methods and determines which method to use at runtime. This approach enables your app to use different authentication methods in different environments - such as local or production environments - without implementing environment-specific code. For more information, see the DefaultAzureCredential section of Authenticate Azure-hosted Java applications.

To use Azure CLI, IntelliJ, or other methods to complete the authentication in local development environments, see Azure authentication in Java development environments. To complete the authentication in Azure hosting environments, we recommend using managed identity. For more information, see What are managed identities for Azure resources?

Use the Spring Cloud Azure Service Bus Starter

The Spring Cloud Azure Service Bus Starter module imports Service Bus Java client library with Spring Boot framework. You can use Spring Cloud Azure and the Azure SDK together, in a non-mutually-exclusive pattern. Thus, you can continue using the Service Bus Java client API in your Spring application.

Add the Service Bus dependency

To install the Spring Cloud Azure Service Bus Starter module, add the following dependencies to your pom.xml file:

• The Spring Cloud Azure Bill of Materials (BOM):

  <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-dependencies</artifactId>
         <version>5.19.0</version>
         <type>pom</type>
         <scope>import</scope>
         </dependency>
     </dependencies>
  </dependencyManagement>
  

  Note

  If you're using Spring Boot 2.x, be sure to set the spring-cloud-azure-dependencies version to 4.19.0. This Bill of Material (BOM) should be configured in the <dependencyManagement> section of your pom.xml file. This ensures that all Spring Cloud Azure dependencies are using the same version. For more information about the version used for this BOM, see Which Version of Spring Cloud Azure Should I Use.

• The Spring Cloud Azure Service Bus artifact:

  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-servicebus</artifactId>
  </dependency>
  

Code the application to send and receive messages

This guide teaches you how to use the Service Bus Java clients in the context of a Spring application. Here we introduce two alternatives. The recommended way is to use Spring Boot Autoconfiguration and use out-of-the-box clients from the Spring context. The alternative way is to build clients on your own programmatically.

The first way, which involves auto wiring the client beans from the Spring IoC container, has the following advantages when compared with the second way. These benefits give you a more flexible and efficient experience when developing with Service Bus clients.

• You can use externalized configuration so that you can work with the same application code in different environments.

• You can delegate the process of learning the builder pattern and registering this client to the application context to the Spring Boot framework. This delegation enables you to focus on how to use the clients with your own business requirements.

• You can use health indicator in an easy way to inspect the status and health of your application and internal components.

The following code example shows you how to use ServiceBusSenderClient and ServiceBusProcessorClient with these two alternatives.

Use Spring Boot Autoconfiguration

To send messages to and receive messages from Service Bus, configure the application by using the following steps:

1. Configure your Service Bus namespace and queue, as shown in the following example:

   spring.cloud.azure.servicebus.namespace=<your-servicebus-namespace-name>
   spring.cloud.azure.servicebus.entity-name=<your-servicebus-queue-name>
   spring.cloud.azure.servicebus.entity-type=queue
   

   Tip

   Here we use Service Bus queue as an example. To use topic/subscription, you need to add the spring.cloud.azure.servicebus.processor.subscription-name property and change the entity-type value to topic.

2. Create a new ServiceBusProcessorClientConfiguration Java class as shown in the following example. This class is used to register the message and error handler of ServiceBusProcessorClient.

   @Configuration(proxyBeanMethods = false)
   public class ServiceBusProcessorClientConfiguration {
   
       @Bean
       ServiceBusRecordMessageListener processMessage() {
           return context -> {
               ServiceBusReceivedMessage message = context.getMessage();
               System.out.printf("Processing message. Id: %s, Sequence #: %s. Contents: %s%n", message.getMessageId(),
                       message.getSequenceNumber(), message.getBody());
           };
       }
   
       @Bean
       ServiceBusErrorHandler processError() {
           return context -> {
               System.out.printf("Error when receiving messages from namespace: '%s'. Entity: '%s'%n",
                       context.getFullyQualifiedNamespace(), context.getEntityPath());
           };
       }
   }
   

3. Inject the ServiceBusSenderClient in your Spring application, and call the related APIs to send messages, as shown in the following example:

   @SpringBootApplication
   public class ServiceBusQueueApplication implements CommandLineRunner {
   
       private final ServiceBusSenderClient senderClient;
   
       public ServiceBusQueueApplication(ServiceBusSenderClient senderClient) {
           this.senderClient = senderClient;
       }
   
       public static void main(String[] args) {
           SpringApplication.run(ServiceBusQueueApplication.class, args);
       }
   
       @Override
       public void run(String... args) throws Exception {
           // send one message to the queue
           senderClient.sendMessage(new ServiceBusMessage("Hello, World!"));
           System.out.printf("Sent a message to the queue");
           senderClient.close();
   
           // wait the processor client to consume messages
           TimeUnit.SECONDS.sleep(10);
       }
   
   }
   

   Note

   By default, the lifecycle of the autowired ServiceBusProcessorClient bean is managed by the Spring context. The processor is automatically started when the Spring Application Context starts, and stopped when the Spring Application Context stops. To disable this feature, configure spring.cloud.azure.servicebus.processor.auto-startup=false.

4. Start the application. You're shown logs similar to the following example:

   Sent a message to the queue
   Processing message. Id: 6f405435200047069a3caf80893a80bc, Sequence #: 1. Contents: Hello, World!
   

Build Service Bus clients programmatically

You can build those client beans by yourself, but the process is complicated. In Spring Boot applications, you have to manage properties, learn the builder pattern, and register the client to your Spring application context. The following code example shows how to do that:

1. Create a new ServiceBusClientConfiguration Java class as shown in the following example. This class is used to declare the ServiceBusSenderClient and ServiceBusProcessorClient beans.

   @Configuration(proxyBeanMethods = false)
   public class ServiceBusClientConfiguration {
   
       private static final String SERVICE_BUS_FQDN = "<service-bus-fully-qualified-namespace>";
       private static final String QUEUE_NAME = "<service-bus-queue-name>";
   
       @Bean
       ServiceBusClientBuilder serviceBusClientBuilder() {
           return new ServiceBusClientBuilder()
                      .fullyQualifiedNamespace(SERVICE_BUS_FQDN)
                      .credential(new DefaultAzureCredentialBuilder().build());
       }
   
       @Bean
       ServiceBusSenderClient serviceBusSenderClient(ServiceBusClientBuilder builder) {
           return builder
                  .sender()
                  .queueName(QUEUE_NAME)
                  .buildClient();
       }
   
       @Bean
       ServiceBusProcessorClient serviceBusProcessorClient(ServiceBusClientBuilder builder) {
           return builder.processor()
                         .queueName(QUEUE_NAME)
                         .processMessage(ServiceBusClientConfiguration::processMessage)
                         .processError(ServiceBusClientConfiguration::processError)
                         .buildProcessorClient();
       }
   
       private static void processMessage(ServiceBusReceivedMessageContext context) {
           ServiceBusReceivedMessage message = context.getMessage();
           System.out.printf("Processing message. Id: %s, Sequence #: %s. Contents: %s%n",
               message.getMessageId(), message.getSequenceNumber(), message.getBody());
       }
   
       private static void processError(ServiceBusErrorContext context) {
           System.out.printf("Error when receiving messages from namespace: '%s'. Entity: '%s'%n",
                   context.getFullyQualifiedNamespace(), context.getEntityPath());
       }
   }
   

   Note

   Be sure to replace the <service-bus-fully-qualified-namespace> placeholder with your Service Bus host name from the Azure portal. Replace the <service-bus-queue-name> placeholder with your own queue name configured in your Service Bus namespace.

2. Inject the client beans to your application, as shown in the following example:

   @SpringBootApplication
   public class ServiceBusQueueApplication implements CommandLineRunner {
   
       private final ServiceBusSenderClient senderClient;
   
       private final ServiceBusProcessorClient processorClient;
   
       public ServiceBusQueueApplication(ServiceBusSenderClient senderClient, ServiceBusProcessorClient processorClient) {
           this.senderClient = senderClient;
           this.processorClient = processorClient;
       }
   
       public static void main(String[] args) {
           SpringApplication.run(ServiceBusQueueApplication.class, args);
       }
   
       @Override
       public void run(String... args) throws Exception {
           // send one message to the queue
           senderClient.sendMessage(new ServiceBusMessage("Hello, World!"));
           System.out.printf("Sent a message to the queue");
           senderClient.close();
   
           System.out.printf("Starting the processor");
           processorClient.start();
           TimeUnit.SECONDS.sleep(10);
           System.out.printf("Stopping and closing the processor");
           processorClient.close();
       }
   
   }
   

3. Start the application. You're shown logs similar to the following example:

   Sent a message to the queue
   Starting the processor
   ...
   Processing message. Id: 6f405435200047069a3caf80893a80bc, Sequence #: 1. Contents: Hello, World!
   Stopping and closing the processor
   

The following list shows reasons why this code isn't flexible or graceful:

• The namespace and queue/topic/subscription names are hard coded.
• If you use @Value to get configurations from the Spring environment, you can't have IDE hints in your application.properties file.
• If you have a microservice scenario, you must duplicate the code in each project, and it's easy to make mistakes and hard to be consistent.

Fortunately, building the client beans by yourself isn't necessary with Spring Cloud Azure. Instead, you can directly inject the beans and use the configuration properties that you're already familiar with to configure Service Bus.

Spring Cloud Azure also provides the following global configurations for different scenarios. For more information, see the Global configuration for Azure Service SDKs section of the Spring Cloud Azure configuration.

• Proxy options.
• Retry options.
• AMQP transport client options.

You can also connect to different Azure clouds. For more information, see Connect to different Azure clouds.

Use the Spring Cloud Azure Service Bus JMS Starter

The Spring Cloud Azure Service Bus JMS Starter module provides Spring JMS integration with Service Bus. The following video describes how to integrate Spring JMS applications with Azure Service Bus using JMS 2.0.

This guide shows you how to use Spring Cloud Azure Service Bus Starter for JMS API to send messages to and receive messages from Service Bus.

Add the Service Bus dependency

To install the Spring Cloud Azure Service Bus JMS Starter module, add the following dependencies to your pom.xml file:

• The Spring Cloud Azure Bill of Materials (BOM):

  <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-dependencies</artifactId>
         <version>5.19.0</version>
         <type>pom</type>
         <scope>import</scope>
         </dependency>
     </dependencies>
  </dependencyManagement>
  

  Note

  If you're using Spring Boot 2.x, be sure to set the spring-cloud-azure-dependencies version to 4.19.0. This Bill of Material (BOM) should be configured in the <dependencyManagement> section of your pom.xml file. This ensures that all Spring Cloud Azure dependencies are using the same version. For more information about the version used for this BOM, see Which Version of Spring Cloud Azure Should I Use.

• The Spring Cloud Azure Service Bus JMS artifact:

  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-servicebus-jms</artifactId>
  </dependency>
  

Code the application to send and receive messages

1. Configure the connection string and pricing tier for your Service Bus, as shown in the following example:

   spring.jms.servicebus.connection-string=<service-bus-namespace-connection-string>
   spring.jms.servicebus.pricing-tier=<service-bus-pricing-tier>
   

2. Create the message receiver.

   Spring provides the means to publish messages to any POJO (Plain Old Java Object). First, define a generic User class that stores and retrieves user's name, as shown in the following example:

   public class User implements Serializable {
   
       private static final long serialVersionUID = -295422703255886286L;
   
       private String name;
   
       public User() {
       }
   
       public User(String name) {
           setName(name);
       }
   
       public String getName() {
           return name;
       }
   
       public void setName(String name) {
           this.name = name;
       }
   }
   

   Tip

   Serializable is implemented to use the send method in JmsTemplate in the Spring framework. Otherwise, you should define a customized MessageConverter bean to serialize the content to JSON in text format. For more information about MessageConverter, see the official Spring JMS starter project.

3. From here, you can create a new QueueReceiveService Java class as shown in the following example. This class is used to define a message receiver.

   @Component
   public class QueueReceiveService {
   
       private static final String QUEUE_NAME = "<service-bus-queue-name>";
   
       @JmsListener(destination = QUEUE_NAME, containerFactory = "jmsListenerContainerFactory")
       public void receiveMessage(User user) {
           System.out.printf("Received a message from %s.", user.getName());
       }
   }
   

   Note

   Be sure to replace the <service-bus-queue-name> placeholder with your own queue name configured in your Service Bus namespace.

   If you're using a topic/subscription, change the destination parameter as the topic name, and the containerFactory should be topicJmsListenerContainerFactory. Also, add the subscription parameter to describe the subscription name.

4. Wire up a sender and a receiver to send and receive messages with Spring, as shown in the following example:

   @SpringBootApplication
   @EnableJms
   public class ServiceBusJmsStarterApplication {
   
       private static final String QUEUE_NAME = "<service-bus-queue-name>";
   
       public static void main(String[] args) {
           ConfigurableApplicationContext context = SpringApplication.run(ServiceBusJMSQueueApplication.class, args);
           JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
   
           // Send a message with a POJO - the template reuse the message converter
           System.out.println("Sending a user message.");
           jmsTemplate.convertAndSend(QUEUE_NAME, new User("Tom"));
       }
   }
   

   Note

   Be sure to replace the <service-bus-queue-name> placeholder with your own queue name configured in your Service Bus namespace.

   Tip

   Be sure to add the @EnableIntegration annotation, which triggers the discovery of methods annotated with @JmsListener, creating the message listener container under the covers.

5. Start the application. You're shown logs similar to the following example:

   Sending a user message.
   Received a message from Tom.
   

Other information

For more information, see How to use JMS API with Service Bus and AMQP 1.0.

Use Spring Messaging Azure Service Bus

The Spring Messaging Azure Service Bus module provides support for Spring Messaging framework with Service Bus.

If you're using Spring Messaging Azure Service Bus, then you can use the following features:

• ServiceBusTemplate: send messages to Service Bus queues and topics asynchronously and synchronously.
• @ServiceBusListener: mark a method to be the target of a Service Bus message listener on the destination.

This guide shows you how to use Spring Messaging Azure Service Bus to send messages to and receive messages from Service Bus.

Add the Service Bus dependency

To install the Spring Messaging Azure Service Bus module, add the following dependencies to your pom.xml file:

• The Spring Cloud Azure Bill of Materials (BOM):

  <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-dependencies</artifactId>
         <version>5.19.0</version>
         <type>pom</type>
         <scope>import</scope>
         </dependency>
     </dependencies>
  </dependencyManagement>
  

  Note

  If you're using Spring Boot 2.x, be sure to set the spring-cloud-azure-dependencies version to 4.19.0. This Bill of Material (BOM) should be configured in the <dependencyManagement> section of your pom.xml file. This ensures that all Spring Cloud Azure dependencies are using the same version. For more information about the version used for this BOM, see Which Version of Spring Cloud Azure Should I Use.

• The Spring Messaging Service Bus and Spring Cloud Azure starter artifacts:

  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
  </dependency>
  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-messaging-azure-servicebus</artifactId>
  </dependency>
  

Code the application to send and receive messages

1. Configure the namespace and queue type for your Service Bus, as shown in the following example:

   spring.cloud.azure.servicebus.namespace=<service-bus-namespace-name>
   spring.cloud.azure.servicebus.entity-type=queue
   

   Note

   If you're using a topic/subscription, change the spring.cloud.azure.servicebus.entity-type value to topic.

2. Create a new ConsumerService Java class as shown in the following example. This class is used to define a message receiver.

   @Service
   public class ConsumerService {
   
       private static final String QUEUE_NAME = "<service-bus-queue-name>";
   
       @ServiceBusListener(destination = QUEUE_NAME)
       public void handleMessageFromServiceBus(String message) {
           System.out.printf("Consume message: %s%n", message);
       }
   
   }
   

   Note

   If you're using a topic/subscription, change the annotation parameter of destination as the topic name, and add the group parameter to describe the subscription name.

3. Wire up a sender and a receiver to send and receive messages with Spring, as shown in the following example:

   @SpringBootApplication
   @EnableAzureMessaging
   public class Application {
   
       private static final String QUEUE_NAME = "<service-bus-queue-name>";
   
       public static void main(String[] args) {
           ConfigurableApplicationContext applicationContext = SpringApplication.run(Application.class);
           ServiceBusTemplate serviceBusTemplate = applicationContext.getBean(ServiceBusTemplate.class);
           System.out.println("Sending a message to the queue.");
           serviceBusTemplate.sendAsync(QUEUE_NAME, MessageBuilder.withPayload("Hello world").build()).subscribe();
       }
   }
   

   Tip

   Be sure to add the @EnableAzureMessaging annotation, which triggers the discovery of methods annotated with @ServiceBusListener, creating the message listener container under the covers.

4. Start the application. You're shown logs similar to the following example:

   Sending a message to the queue.
   Consume message: Hello world.
   

Use Spring Integration Azure Service Bus

The Spring Integration Azure Service Bus module provides support for the Spring Integration framework with Service Bus.

If your Spring application uses Spring Integration message channels, you can route messages between your message channels and Service Bus using channel adapters.

An inbound channel adapter forwards messages from a Service Bus queue or subscription to a message channel. An outbound channel adapter publishes messages from a message channel to a Service Bus queue and topic.

This guide shows you how to use Spring Integration Azure Service Bus to send messages to and receive messages from Service Bus.

Add the Service Bus dependency

To install the Spring Cloud Azure Service Bus Integration Starter module, add the following dependencies to your pom.xml file:

• The Spring Cloud Azure Bill of Materials (BOM):

  <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-dependencies</artifactId>
         <version>5.19.0</version>
         <type>pom</type>
         <scope>import</scope>
         </dependency>
     </dependencies>
  </dependencyManagement>
  

  Note

  If you're using Spring Boot 2.x, be sure to set the spring-cloud-azure-dependencies version to 4.19.0. This Bill of Material (BOM) should be configured in the <dependencyManagement> section of your pom.xml file. This ensures that all Spring Cloud Azure dependencies are using the same version. For more information about the version used for this BOM, see Which Version of Spring Cloud Azure Should I Use.

• The Spring Cloud Azure Service Bus Integration artifact:

  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-integration-servicebus</artifactId>
  </dependency>
  

Code the application to send and receive messages

1. Configure the namespace of your Service Bus, as shown in the following example:

   spring.cloud.azure.servicebus.namespace=<your-servicebus-namespace-name>
   

2. Create a new QueueReceiveConfiguration Java class as shown in the following example. This class is used to define a message receiver.

   @Configuration
   public class QueueReceiveConfiguration {
   
       private static final String INPUT_CHANNEL = "queue.input";
       private static final String QUEUE_NAME = "<your-servicebus-queue-name>";
       private static final String SERVICE_BUS_MESSAGE_LISTENER_CONTAINER = "queue-listener-container";
   
       /**
        * This message receiver binding with {@link ServiceBusInboundChannelAdapter}
        * via {@link MessageChannel} has name {@value INPUT_CHANNEL}
        */
       @ServiceActivator(inputChannel = INPUT_CHANNEL)
       public void messageReceiver(byte[] payload) {
           String message = new String(payload);
           System.out.printf("New message received: '%s'%n", message);
       }
   
       @Bean(SERVICE_BUS_MESSAGE_LISTENER_CONTAINER)
       public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
           ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
           containerProperties.setEntityName(QUEUE_NAME);
           return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
       }
   
       @Bean
       public ServiceBusInboundChannelAdapter queueMessageChannelAdapter(
           @Qualifier(INPUT_CHANNEL) MessageChannel inputChannel,
           @Qualifier(SERVICE_BUS_MESSAGE_LISTENER_CONTAINER) ServiceBusMessageListenerContainer listenerContainer) {
           ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
           adapter.setOutputChannel(inputChannel);
           return adapter;
       }
   
       @Bean(name = INPUT_CHANNEL)
       public MessageChannel input() {
           return new DirectChannel();
       }
   }
   

3. Create a new QueueSendConfiguration Java class as shown in the following example. This class is used to define a message sender.

   @Configuration
   public class QueueSendConfiguration {
   
       private static final String OUTPUT_CHANNEL = "queue.output";
       private static final String QUEUE_NAME = "<your-servicebus-queue-name>";
   
       @Bean
       @ServiceActivator(inputChannel = OUTPUT_CHANNEL)
       public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) {
           serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE);
           DefaultMessageHandler handler = new DefaultMessageHandler(QUEUE_NAME, serviceBusTemplate);
           handler.setSendCallback(new ListenableFutureCallback<Void>() {
               @Override
               public void onSuccess(Void result) {
                   System.out.println("Message was sent successfully.");
               }
   
               @Override
               public void onFailure(Throwable ex) {
                   System.out.println("There was an error sending the message.");
               }
           });
   
           return handler;
       }
   
       /**
        * Message gateway binding with {@link MessageHandler}
        * via {@link MessageChannel} has name {@value OUTPUT_CHANNEL}
        */
       @MessagingGateway(defaultRequestChannel = OUTPUT_CHANNEL)
       public interface QueueOutboundGateway {
           void send(String text);
       }
   }
   

4. Wire up a sender and a receiver to send and receive messages with Spring, as shown in the following example:

   @SpringBootApplication
   @EnableIntegration
   @Configuration(proxyBeanMethods = false)
   public class ServiceBusIntegrationApplication {
   
       public static void main(String[] args) {
           ConfigurableApplicationContext applicationContext = SpringApplication.run(ServiceBusIntegrationApplication.class, args);
           QueueSendConfiguration.QueueOutboundGateway outboundGateway = applicationContext.getBean(QueueSendConfiguration.QueueOutboundGateway.class);
           System.out.println("Sending a message to the queue");
           outboundGateway.send("Hello World");
       }
   
   }
   

   Tip

   Be sure to add the @EnableIntegration annotation, which enables the Spring Integration infrastructure.

5. Start the application. You're shown logs similar to the following example:

   Message was sent successfully.
   New message received: 'Hello World'
   

Use Spring Cloud Stream Service Bus Binder

To call the Service Bus API in a Spring Cloud Stream application, use the Spring Cloud Azure Service Bus Stream Binder module.

This guide shows you how to use Spring Cloud Stream Service Bus Binder to send messages to and receive messages from Service Bus.

Add the Service Bus dependency

To install the Spring Cloud Azure Service Bus Stream Binder module, add the following dependencies to your pom.xml file:

• The Spring Cloud Azure Bill of Materials (BOM):

  <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-dependencies</artifactId>
         <version>5.19.0</version>
         <type>pom</type>
         <scope>import</scope>
         </dependency>
     </dependencies>
  </dependencyManagement>
  

  Note

  If you're using Spring Boot 2.x, be sure to set the spring-cloud-azure-dependencies version to 4.19.0. This Bill of Material (BOM) should be configured in the <dependencyManagement> section of your pom.xml file. This ensures that all Spring Cloud Azure dependencies are using the same version. For more information about the version used for this BOM, see Which Version of Spring Cloud Azure Should I Use.

• The Spring Cloud Azure Service Bus Integration artifact:

  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-stream-binder-servicebus</artifactId>
  </dependency>
  

Code the application to send and receive messages

1. Configure the namespace of your Service Bus, as shown in the following example:

   spring.cloud.azure.servicebus.namespace=<service-bus-namespace-name>
   

2. Create the message receiver.

   To use your application as an event sink, configure the input binder by specifying the following information:

   • Declare a Consumer bean that defines message handling logic. For example, the following Consumer bean is named consume:

     @Bean
     public Consumer<Message<String>> consume() {
         return message -> {
             System.out.printf("New message received: '%s'.%n", message.getPayload());
         };
     }
     

   • Add the configuration to specify the queue name for consuming by replacing the <service-bus-queue-name> placeholder, as shown in the following example:

     # name for the `Consumer` bean
     spring.cloud.function.definition=consume
     spring.cloud.stream.bindings.consume-in-0.destination=<service-bus-queue-name>
     

     Note

     To consume from a Service Bus subscription, be sure to change the consume-in-0 binding properties as shown in the following example:

     spring.cloud.stream.bindings.consume-in-0.destination=<service-bus-topic-name>
     spring.cloud.stream.bindings.consume-in-0.group=<service-bus-subscription-name>
     

3. Create the message sender.

   To use your application as an event source, configure the output binder by specifying the following information:

   • Define a Supplier bean that defines where messages come from within your application.

     @Bean
     return () -> {
             System.out.println("Sending a message.");
             return MessageBuilder.withPayload("Hello world").build();
         };
     }
     

   • Add the configuration to specify the queue name for sending by replacing the <your-servicebus-queue-name> placeholder in the following example:

     # "consume" is added from the previous step
     spring.cloud.function.definition=consume;supply
     spring.cloud.stream.bindings.supply-out-0.destination=<your-servicebus-queue-name>
     spring.cloud.stream.servicebus.bindings.supply-out-0.producer.entity-type=queue
     

     Note

     To send to a Service Bus topic, be sure to change the entity-type to topic.

4. Start the application. You're shown see logs similar to the following example:

   Sending a message.
   New message received: 'Hello world'.
   

Deploy to Azure Spring Apps

Now that you have the Spring Boot application running locally, it's time to move it to production. Azure Spring Apps makes it easy to deploy Spring Boot applications to Azure without any code changes. The service manages the infrastructure of Spring applications so developers can focus on their code. Azure Spring Apps provides lifecycle management using comprehensive monitoring and diagnostics, configuration management, service discovery, CI/CD integration, blue-green deployments, and more. To deploy your application to Azure Spring Apps, see Deploy your first application to Azure Spring Apps.

Next steps

See also

For more information about more Spring Boot Starters available for Microsoft Azure, see What is Spring Cloud Azure?