Połączenie bazy danych usługi Azure Cosmos DB do aplikacji w usłudze Azure Spring Apps

Uwaga

Azure Spring Apps to nowa nazwa usługi Azure Spring Cloud. Mimo że usługa ma nową nazwę, stara nazwa będzie widoczna w niektórych miejscach przez pewien czas, ponieważ pracujemy nad aktualizowaniem zasobów, takich jak zrzuty ekranu, filmy wideo i diagramy.

Ten artykuł dotyczy: ✔️ Java ✔️ C#

Ten artykuł dotyczy: ✔️ Podstawowa/Standardowa ✔️ Enterprise

Zamiast ręcznie konfigurować aplikacje Spring Boot, możesz automatycznie łączyć wybrane usługi platformy Azure z aplikacjami przy użyciu usługi Azure Spring Apps. W tym artykule pokazano, jak połączyć aplikację z bazą danych usługi Azure Cosmos DB.

Wymagania wstępne

• Aplikacja wdrożona w usłudze Azure Spring Apps. Aby uzyskać więcej informacji, zobacz Szybki start: wdrażanie pierwszej aplikacji w usłudze Azure Spring Apps.
• Wystąpienie bazy danych usługi Azure Cosmos DB.
• Interfejs wiersza polecenia platformy Azure w wersji 2.45.0 lub nowszej.

Przygotowywanie projektu

Java

1. Dodaj jedną z następujących zależności do pliku pom.xml aplikacji. Wybierz zależność odpowiednią dla typu interfejsu API.

   • Typ interfejsu API: NoSQL

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

   • Typ interfejsu API: MongoDB

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

   • Typ interfejsu API: Cassandra

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

2. Zaktualizuj bieżącą aplikację, uruchamiając az spring app deploypolecenie , lub utwórz nowe wdrożenie dla tej zmiany, uruchamiając polecenie az spring app deployment create.

Polyglot

Wszystkie parametry połączenia i poświadczenia są wstrzykiwane jako zmienne środowiskowe, do których można się odwołać w kodzie aplikacji.

Aby uzyskać domyślne nazwy zmiennych środowiskowych, zobacz następujące artykuły:

• Usługa Azure Cosmos DB dla tabeli
• Azure Cosmos DB for NoSQL
• Usługa Azure Cosmos DB dla bazy danych MongoDB
• Usługa Azure Cosmos DB dla języka Gremlin
• Usługa Azure Cosmos DB dla bazy danych Cassandra

Połączenie aplikacji do usługi Azure Cosmos DB

Połączenie or usługi

Uwaga

Domyślnie Połączenie usługi są tworzone na poziomie aplikacji. Aby zastąpić połączenia, możesz ponownie utworzyć inne połączenia we wdrożeniach.

Korzystanie z interfejsu wiersza polecenia platformy Azure

Użyj interfejsu wiersza polecenia platformy Azure, aby skonfigurować aplikację Spring w celu nawiązania połączenia z bazą danych Cosmos NoSQL Database przy użyciu az spring connection create polecenia , jak pokazano w poniższym przykładzie. Pamiętaj, aby zastąpić zmienne w przykładzie rzeczywistymi wartościami.

Uwaga

Aktualizowanie ustawień bazy danych usługi Azure Cosmos DB może potrwać kilka minut.

Uwaga

Jeśli używasz usługi Cosmos Cassandra, użyj polecenia --key_space zamiast --database. Jeśli używasz tabeli Cosmos, użyj polecenia --table zamiast --database. Aby uzyskać więcej informacji, zobacz Szybki start: tworzenie połączenia usługi w usłudze Azure Spring Apps przy użyciu interfejsu wiersza polecenia platformy Azure.

az spring connection create cosmos-sql \
    --resource-group $AZURE_SPRING_APPS_RESOURCE_GROUP \
    --service $AZURE_SPRING_APPS_SERVICE_INSTANCE_NAME \
    --app $APP_NAME \
    --target-resource-group $COSMOSDB_RESOURCE_GROUP \
    --account $COSMOSDB_ACCOUNT_NAME \
    --database $DATABASE_NAME \
    --secret

Uwaga

Jeśli używasz usługi Service Połączenie or po raz pierwszy, uruchom polecenie az provider register --namespace Microsoft.ServiceLinker , aby zarejestrować dostawcę zasobów service Połączenie or.

Napiwek

Uruchom polecenie az spring connection list-support-types --output table , aby uzyskać listę obsługiwanych usług docelowych i metod uwierzytelniania dla usługi Azure Spring Apps. az spring Jeśli polecenie nie jest rozpoznawane przez system, sprawdź, czy zainstalowano wymagane rozszerzenie, uruchamiając polecenie az extension add --name spring.

Korzystanie z witryny Azure Portal

Alternatywnie możesz użyć witryny Azure Portal do skonfigurowania tego połączenia, wykonując następujące kroki. Witryna Azure Portal udostępnia te same możliwości co interfejs wiersza polecenia platformy Azure i zapewnia interaktywne środowisko.

1. Wybierz wystąpienie usługi Azure Spring Apps w witrynie Azure Portal i wybierz pozycję Aplikacje z menu nawigacji. Wybierz aplikację, którą chcesz połączyć, i wybierz pozycję Usługa Połączenie or w menu nawigacji.

2. Wybierz pozycję Utwórz.

3. Na karcie Podstawowe w polu Typ usługi wybierz pozycję Cosmos DB, a następnie wybierz subskrypcję. W polu Typ interfejsu API wybierz pozycję Core (SQL), wybierz konto usługi Cosmos DB i bazę danych. W polu Typ klienta wybierz pozycję Java, a następnie wybierz pozycję Dalej: Uwierzytelnianie. Jeśli baza danych nie została jeszcze utworzona, zobacz Szybki start: tworzenie konta, bazy danych, kontenera i elementów usługi Azure Cosmos DB z witryny Azure Portal.

4. Na karcie Uwierzytelnianie wybierz pozycję ciąg Połączenie ion. Usługa Połączenie or automatycznie pobiera klucz dostępu z konta usługi Cosmos DB. Wybierz pozycję Dalej: Sieć.

5. Na karcie Sieć wybierz pozycję Konfiguruj reguły zapory, aby włączyć dostęp do usługi docelowej, a następnie wybierz pozycję Dalej: Przejrzyj i utwórz.

6. Na karcie Przeglądanie + tworzenie poczekaj na przekazanie walidacji, a następnie wybierz pozycję Utwórz. Tworzenie może potrwać kilka minut.

7. Po wygenerowaniu połączenia między aplikacjami Spring i bazą danych usługi Cosmos DB możesz zobaczyć je na stronie Service Połączenie or i wybrać przycisk rozwijania, aby wyświetlić skonfigurowane zmienne połączenia.

Terraform

Poniższy skrypt narzędzia Terraform przedstawia sposób konfigurowania aplikacji wdrożonej w usłudze Azure Spring Apps przy użyciu konta usługi Azure Cosmos DB.

provider "azurerm" {
  features {}
}

variable "application_name" {
  type        = string
  description = "The name of your application"
  default     = "demo-cosmosdb"
}

resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West Europe"
}

resource "azurerm_cosmosdb_account" "cosmosdb" {
  name                = "cosmosacct-${var.application_name}-001"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
  offer_type          = "Standard"
  kind                = "GlobalDocumentDB"

  consistency_policy {
    consistency_level = "Session"
  }

  geo_location {
    failover_priority = 0
    location          = azurerm_resource_group.example.location
  }
}

resource "azurerm_cosmosdb_sql_database" "cosmosdb" {
  name                = "cosmos-${var.application_name}-001"
  resource_group_name = azurerm_cosmosdb_account.cosmosdb.resource_group_name
  account_name        = azurerm_cosmosdb_account.cosmosdb.name
}

resource "azurerm_spring_cloud_service" "example" {
  name                = "${var.application_name}"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
}

resource "azurerm_spring_cloud_app" "example" {
  name                = "${var.application_name}-app"
  resource_group_name = azurerm_resource_group.example.name
  service_name        = azurerm_spring_cloud_service.example.name
  is_public           = true
  https_only          = true
}

resource "azurerm_spring_cloud_java_deployment" "example" {
  name                = "default"
  spring_cloud_app_id = azurerm_spring_cloud_app.example.id
  quota {
    cpu    = "2"
    memory = "4Gi"
  }
  instance_count      = 1
  jvm_options         = "-XX:+PrintGC"
  runtime_version     = "Java_11"

  environment_variables = {
    "spring.cloud.azure.cosmos.endpoint" : azurerm_cosmosdb_account.cosmosdb.endpoint
    "spring.cloud.azure.cosmos.key" : azurerm_cosmosdb_account.cosmosdb.primary_key
    "spring.cloud.azure.cosmos.database" : azurerm_cosmosdb_sql_database.cosmosdb.name
  }
}

resource "azurerm_spring_cloud_active_deployment" "example" {
  spring_cloud_app_id = azurerm_spring_cloud_app.example.id
  deployment_name     = azurerm_spring_cloud_java_deployment.example.name
}

Następne kroki

W tym artykule przedstawiono sposób łączenia aplikacji w usłudze Azure Spring Apps z bazą danych usługi Azure Cosmos DB. Aby dowiedzieć się więcej na temat łączenia usług z aplikacją, zobacz Połączenie z pamięcią podręczną Azure Cache for Redis Cache.