-
Notifications
You must be signed in to change notification settings - Fork 244
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add spring messaging azure servicebus sample
- Loading branch information
Showing
10 changed files
with
387 additions
and
0 deletions.
There are no files selected for viewing
194 changes: 194 additions & 0 deletions
194
servicebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
--- | ||
page_type: sample | ||
languages: | ||
- java | ||
products: | ||
- azure-service-bus | ||
name: Sending and Receiving Message by Spring Messaging Azure Service Bus (Queue) in Spring Boot Application | ||
description: This sample demonstrates how to send and receive message by Spring Messaging Azure Service Bus (queue) in Spring Boot application. | ||
--- | ||
|
||
# Sending and Receiving Message by Spring Messaging Azure Service Bus (Queue) in Spring Boot Application | ||
|
||
This code sample demonstrates how to use Spring Messaging Azure Service Bus (queue) sending and receiving Message. | ||
|
||
## What You Will Build | ||
You will build an application using `ServiceBusTemplate` send messages and `@ServiceBusListener` receive messages for Azure Service Bus Queue. | ||
|
||
## What You Need | ||
|
||
- [An Azure subscription](https://azure.microsoft.com/free/) | ||
- [Terraform](https://www.terraform.io/) | ||
- [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli) | ||
- [JDK8](https://www.oracle.com/java/technologies/downloads/) or later | ||
- Maven | ||
- You can also import the code straight into your IDE: | ||
- [IntelliJ IDEA](https://www.jetbrains.com/idea/download) | ||
|
||
## Provision Azure Resources Required to Run This Sample | ||
This sample will create Azure resources using Terraform. If you choose to run it without using Terraform to provision resources, please pay attention to: | ||
> [!IMPORTANT] | ||
> If you choose to use a security principal to authenticate and authorize with Microsoft Entra ID for accessing an Azure resource | ||
> please refer to [Authorize access with Microsoft Entra ID](https://learn.microsoft.com/azure/developer/java/spring-framework/authentication#authorize-access-with-microsoft-entra-id) to make sure the security principal has been granted the sufficient permission to access the Azure resource. | ||
### Authenticate Using the Azure CLI | ||
Terraform must authenticate to Azure to create infrastructure. | ||
|
||
In your terminal, use the Azure CLI tool to setup your account permissions locally. | ||
|
||
```shell | ||
az login | ||
``` | ||
|
||
Your browser window will open and you will be prompted to enter your Azure login credentials. After successful authentication, your terminal will display your subscription information. You do not need to save this output as it is saved in your system for Terraform to use. | ||
|
||
```shell | ||
You have logged in. Now let us find all the subscriptions to which you have access... | ||
|
||
[ | ||
{ | ||
"cloudName": "AzureCloud", | ||
"homeTenantId": "home-Tenant-Id", | ||
"id": "subscription-id", | ||
"isDefault": true, | ||
"managedByTenants": [], | ||
"name": "Subscription-Name", | ||
"state": "Enabled", | ||
"tenantId": "0envbwi39-TenantId", | ||
"user": { | ||
"name": "[email protected]", | ||
"type": "user" | ||
} | ||
} | ||
] | ||
``` | ||
|
||
If you have more than one subscription, specify the subscription-id you want to use with command below: | ||
```shell | ||
az account set --subscription <your-subscription-id> | ||
``` | ||
|
||
### Provision the Resources | ||
|
||
After login Azure CLI with your account, now you can use the terraform script to create Azure Resources. | ||
|
||
#### Run with Bash | ||
|
||
```shell | ||
# In the root directory of the sample | ||
# Initialize your Terraform configuration | ||
terraform -chdir=./terraform init | ||
|
||
# Apply your Terraform Configuration | ||
terraform -chdir=./terraform apply -auto-approve | ||
|
||
``` | ||
|
||
#### Run with Powershell | ||
|
||
```shell | ||
# In the root directory of the sample | ||
# Initialize your Terraform configuration | ||
terraform -chdir=terraform init | ||
|
||
# Apply your Terraform Configuration | ||
terraform -chdir=terraform apply -auto-approve | ||
|
||
``` | ||
|
||
It may take a few minutes to run the script. After successful running, you will see prompt information like below: | ||
|
||
```shell | ||
azurecaf_name.azurecaf_name_servicebus: Creating... | ||
azurecaf_name.resource_group: Creating... | ||
azurecaf_name.resource_group: Creation complete ... | ||
azurecaf_name.azurecaf_name_servicebus: Creation complete ... | ||
azurerm_resource_group.main: Creating... | ||
azurerm_resource_group.main: Creation complete ... | ||
azurerm_servicebus_namespace.servicebus_namespace: Creation complete ... | ||
... | ||
azurerm_role_assignment.role_servicebus_data_owner: Creating... | ||
azurerm_servicebus_queue.queue: Creating... | ||
azurerm_servicebus_queue.queue: Creation complete ... | ||
azurerm_role_assignment.role_servicebus_data_owner: Creation complete ... | ||
|
||
Apply complete! Resources: 6 added, 0 changed, 0 destroyed. | ||
|
||
Outputs: | ||
|
||
... | ||
|
||
``` | ||
|
||
You can go to [Azure portal](https://ms.portal.azure.com/) in your web browser to check the resources you created. | ||
|
||
### Export Output to Your Local Environment | ||
Running the command below to export environment values: | ||
|
||
#### Run with Bash | ||
|
||
```shell | ||
source ./terraform/setup_env.sh | ||
``` | ||
|
||
#### Run with Powershell | ||
|
||
```shell | ||
terraform\setup_env.ps1 | ||
``` | ||
|
||
If you want to run the sample in debug mode, you can save the output value. | ||
|
||
```shell | ||
AZURE_SERVICEBUS_NAMESPACE=... | ||
``` | ||
|
||
## Run Locally | ||
|
||
### Run the sample with Maven | ||
|
||
In your terminal, run `mvn clean spring-boot:run`. | ||
|
||
```shell | ||
mvn clean spring-boot:run | ||
``` | ||
|
||
### Run the sample in IDEs | ||
|
||
You can debug your sample by adding the saved output values to the tool's environment variables or the sample's `application.yaml` file. | ||
|
||
* If your tool is `IDEA`, please refer to [Debug your first Java application](https://www.jetbrains.com/help/idea/debugging-your-first-java-application.html) and [add environment variables](https://www.jetbrains.com/help/objc/add-environment-variables-and-program-arguments.html#add-environment-variables). | ||
|
||
* If your tool is `ECLIPSE`, please refer to [Debugging the Eclipse IDE for Java Developers](https://www.eclipse.org/community/eclipse_newsletter/2017/june/article1.php) and [Eclipse Environment Variable Setup](https://examples.javacodegeeks.com/desktop-java/ide/eclipse/eclipse-environment-variable-setup-example/). | ||
|
||
## Verify This Sample | ||
|
||
1. Verify in your app's logs that a similar message was posted: | ||
``` | ||
Sending a message to the queue. | ||
... | ||
Consume message: Hello world | ||
``` | ||
## Clean Up Resources | ||
After running the sample, if you don't want to run the sample, remember to destroy the Azure resources you created to avoid unnecessary billing. | ||
The terraform destroy command terminates resources managed by your Terraform project. | ||
To destroy the resources you created. | ||
#### Run with Bash | ||
```shell | ||
terraform -chdir=./terraform destroy -auto-approve | ||
``` | ||
|
||
#### Run with Powershell | ||
|
||
```shell | ||
terraform -chdir=terraform destroy -auto-approve | ||
``` | ||
|
||
## 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](https://learn.microsoft.com/azure/spring-apps/overview) 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](https://learn.microsoft.com/azure/spring-apps/quickstart?tabs=Azure-CLI). |
31 changes: 31 additions & 0 deletions
31
servicebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
|
||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xmlns="http://maven.apache.org/POM/4.0.0" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<parent> | ||
<groupId>com.azure.spring</groupId> | ||
<artifactId>azure-spring-boot-samples</artifactId> | ||
<version>1.0.0</version> | ||
<relativePath>../../../pom.xml</relativePath> | ||
</parent> | ||
|
||
<artifactId>servicebus-spring-messaging</artifactId> | ||
<version>1.0.0</version> | ||
<packaging>jar</packaging> | ||
|
||
<name>Communicate to Azure Service Bus via Spring messaging</name> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>com.azure.spring</groupId> | ||
<artifactId>spring-messaging-azure-servicebus</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.azure.spring</groupId> | ||
<artifactId>spring-cloud-azure-starter</artifactId> | ||
</dependency> | ||
</dependencies> | ||
</project> |
20 changes: 20 additions & 0 deletions
20
...messaging/src/main/java/com/azure/spring/sample/servicebus/messaging/ConsumerService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
// Copyright (c) Microsoft Corporation. All rights reserved. | ||
// Licensed under the MIT License. | ||
|
||
package com.azure.spring.sample.servicebus.messaging; | ||
|
||
|
||
import com.azure.spring.messaging.servicebus.implementation.core.annotation.ServiceBusListener; | ||
import org.springframework.stereotype.Service; | ||
|
||
@Service | ||
public class ConsumerService { | ||
|
||
private static final String QUEUE_NAME = "que001"; | ||
|
||
@ServiceBusListener(destination = QUEUE_NAME) | ||
public void handleMessageFromServiceBus(String message) { | ||
System.out.printf("Consume message: %s%n", message); | ||
} | ||
|
||
} |
26 changes: 26 additions & 0 deletions
26
...ain/java/com/azure/spring/sample/servicebus/messaging/ServiceBusMessagingApplication.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// Copyright (c) Microsoft Corporation. All rights reserved. | ||
// Licensed under the MIT License. | ||
|
||
package com.azure.spring.sample.servicebus.messaging; | ||
|
||
|
||
import com.azure.spring.messaging.implementation.annotation.EnableAzureMessaging; | ||
import com.azure.spring.messaging.servicebus.core.ServiceBusTemplate; | ||
import org.springframework.boot.SpringApplication; | ||
import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
import org.springframework.context.ConfigurableApplicationContext; | ||
import org.springframework.messaging.support.MessageBuilder; | ||
|
||
@SpringBootApplication | ||
@EnableAzureMessaging | ||
public class ServiceBusMessagingApplication { | ||
private static final String QUEUE_NAME = "que001"; | ||
|
||
public static void main(String[] args) { | ||
ConfigurableApplicationContext applicationContext = SpringApplication.run(ServiceBusMessagingApplication.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(); | ||
} | ||
|
||
} |
6 changes: 6 additions & 0 deletions
6
...essaging-azure-servicebus/servicebus-spring-messaging/src/main/resources/application.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
spring: | ||
cloud: | ||
azure: | ||
servicebus: | ||
namespace: ${AZURE_SERVICEBUS_NAMESPACE} | ||
entity-type: queue |
77 changes: 77 additions & 0 deletions
77
servicebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/terraform/main.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
terraform { | ||
required_providers { | ||
azurerm = { | ||
source = "hashicorp/azurerm" | ||
version = "3.9.0" | ||
} | ||
azurecaf = { | ||
source = "aztfmod/azurecaf" | ||
version = "1.2.16" | ||
} | ||
} | ||
} | ||
|
||
provider "azurerm" { | ||
features {} | ||
} | ||
|
||
resource "azurecaf_name" "resource_group" { | ||
name = var.application_name | ||
resource_type = "azurerm_resource_group" | ||
random_length = 5 | ||
clean_input = true | ||
} | ||
|
||
resource "azurerm_resource_group" "main" { | ||
name = azurecaf_name.resource_group.result | ||
location = var.location | ||
|
||
tags = { | ||
"terraform" = "true" | ||
"application-name" = var.application_name | ||
"spring-cloud-azure-sample" = var.sample_tag_value | ||
} | ||
} | ||
|
||
resource "azurecaf_name" "azurecaf_name_servicebus" { | ||
name = var.application_name | ||
resource_type = "azurerm_servicebus_namespace" | ||
random_length = 5 | ||
clean_input = true | ||
} | ||
|
||
resource "azurerm_servicebus_namespace" "servicebus_namespace" { | ||
name = azurecaf_name.azurecaf_name_servicebus.result | ||
location = var.location | ||
resource_group_name = azurerm_resource_group.main.name | ||
|
||
sku = var.pricing_tier | ||
zone_redundant = false | ||
|
||
tags = { | ||
terraform = "true" | ||
application-name = var.application_name | ||
spring-cloud-azure-sample = var.sample_tag_value | ||
} | ||
} | ||
|
||
resource "azurerm_servicebus_queue" "queue" { | ||
name = "que001" | ||
namespace_id = azurerm_servicebus_namespace.servicebus_namespace.id | ||
|
||
enable_partitioning = false | ||
max_delivery_count = 10 | ||
lock_duration = "PT30S" | ||
max_size_in_megabytes = 1024 | ||
requires_session = false | ||
default_message_ttl = "P14D" | ||
} | ||
|
||
data "azurerm_client_config" "current" { | ||
} | ||
|
||
resource "azurerm_role_assignment" "role_servicebus_data_owner" { | ||
scope = azurerm_servicebus_namespace.servicebus_namespace.id | ||
role_definition_name = "Azure Service Bus Data Owner" | ||
principal_id = data.azurerm_client_config.current.object_id | ||
} |
4 changes: 4 additions & 0 deletions
4
...icebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/terraform/outputs.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
output "AZURE_SERVICEBUS_NAMESPACE" { | ||
value = azurerm_servicebus_namespace.servicebus_namespace.name | ||
description = "The servicebus namespace." | ||
} |
3 changes: 3 additions & 0 deletions
3
...bus/spring-messaging-azure-servicebus/servicebus-spring-messaging/terraform/setup_env.ps1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
$env:AZURE_SERVICEBUS_NAMESPACE=$(terraform -chdir=terraform output -raw AZURE_SERVICEBUS_NAMESPACE) | ||
|
||
echo AZURE_SERVICEBUS_NAMESPACE=$env:AZURE_SERVICEBUS_NAMESPACE |
3 changes: 3 additions & 0 deletions
3
...ebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/terraform/setup_env.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export AZURE_SERVICEBUS_NAMESPACE=$(terraform -chdir=./terraform output -raw AZURE_SERVICEBUS_NAMESPACE) | ||
|
||
echo AZURE_SERVICEBUS_NAMESPACE=$AZURE_SERVICEBUS_NAMESPACE |
23 changes: 23 additions & 0 deletions
23
...ebus/spring-messaging-azure-servicebus/servicebus-spring-messaging/terraform/variables.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
variable "application_name" { | ||
type = string | ||
description = "The name of your application." | ||
default = "servicebus-queue" | ||
} | ||
|
||
variable "location" { | ||
type = string | ||
description = "The Azure region where all resources in this example should be created." | ||
default = "eastus" | ||
} | ||
|
||
variable "sample_tag_value" { | ||
type = string | ||
description = "The value of spring-cloud-azure-sample tag." | ||
default = "true" | ||
} | ||
|
||
variable "pricing_tier" { | ||
type = string | ||
description = "The pricing tier of Service Bus." | ||
default = "Standard" | ||
} |