Szybki start: używanie usługi Azure Cosmos DB dla noSQL z zestawem Azure SDK dla języka Java

• .NET
• Node.js
• Java
• Python
• Przejdź
• Rdza

W tym szybkim przewodniku wdrożysz podstawową aplikację Azure Cosmos DB dla NoSQL przy użyciu zestawu SDK platformy Azure dla języka Java. Usługa Azure Cosmos DB for NoSQL to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie danych bez struktury w chmurze. Wykonywanie zapytań dotyczących danych w kontenerach i wykonywanie typowych operacji na poszczególnych elementach przy użyciu zestawu Azure SDK dla języka Java.

Dokumentacja odniesień do API | Kod źródłowy biblioteki | Pakiet (Maven) | Azure CLI dla deweloperów

Wymagania wstępne

• Azure Developer CLI
• Docker Desktop
• Java 21

Jeśli nie masz jeszcze konta platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Inicjowanie projektu

Użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć konto usługi Azure Cosmos DB for NoSQL i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

1. Otwórz terminal w pustym katalogu.

2. Jeśli jeszcze się nie zalogowałeś, uwierzytelnij się, używając Azure Developer CLI za pomocą azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

   azd auth login
   

3. Użyj azd init, aby zainicjować projekt.

   azd init --template cosmos-db-nosql-java-quickstart
   

4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

   azd up
   

6. Podczas procesu aprowizacji wybierz subskrypcję, żądaną lokalizację i docelową grupę zasobów. Poczekaj na zakończenie procesu udostępniania. Proces może potrwać około pięciu minut.

7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
   - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
   
   SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
   

8. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem Maven jako pakiet azure-spring-data-cosmos.

1. Przejdź do /src/web folderu i otwórz plik pom.xml .

2. Jeśli jeszcze nie istnieje, dodaj wpis dla pakietu azure-spring-data-cosmos.

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

3. Ponadto dodaj kolejną zależność dla azure-identity pakietu, jeśli jeszcze nie istnieje.

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
   </dependency>
   

Importowanie bibliotek

Zaimportuj wszystkie wymagane przestrzenie nazw do kodu aplikacji.

import com.azure.cosmos.CosmosClientBuilder;
import com.azure.cosmos.models.PartitionKey;
import com.azure.identity.DefaultAzureCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.spring.data.cosmos.config.AbstractCosmosConfiguration;
import com.azure.spring.data.cosmos.config.CosmosConfig;
import com.azure.spring.data.cosmos.core.mapping.Container;
import com.azure.spring.data.cosmos.core.mapping.PartitionKey;
import com.azure.spring.data.cosmos.repository.CosmosRepository;
import com.azure.spring.data.cosmos.repository.Query;
import com.azure.spring.data.cosmos.repository.config.EnableCosmosRepositories;

Model obiektów

Nazwa/nazwisko	opis
EnableCosmosRepositories	Ten typ to dekorator metody używany do konfigurowania repozytorium w celu uzyskania dostępu do usługi Azure Cosmos DB for NoSQL.
CosmosRepository	Ta klasa jest podstawową klasą klienta i służy do zarządzania danymi w kontenerze.
CosmosClientBuilder	Ta klasa jest fabryką służącą do tworzenia klienta, który jest używany przez repozytorium.
Query	Ten typ jest dekoratorem metody używanym do określania zapytania wykonywanego przez repozytorium.

Przykłady kodu

• Uwierzytelnianie użytkownika
• Pobieranie bazy danych
• Weź kontener
• Tworzenie elementu
• Pobierz element
• Elementy zapytania

Przykładowy kod w szablonie używa bazy danych o nazwie cosmicworks i kontenera o nazwie products. Kontener products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa właściwości /category jako klucza logicznego partycji.

Uwierzytelnianie użytkownika

Najpierw ten przykład tworzy nową klasę dziedziczącą po AbstractCosmosConfiguration, aby skonfigurować połączenie z usługą Azure Cosmos DB dla NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {
}

W klasie konfiguracji ten przykład tworzy nowe wystąpienie klasy CosmosClientBuilder i konfiguruje uwierzytelnianie przy użyciu wystąpienia DefaultAzureCredential.

@Bean
public CosmosClientBuilder getCosmosClientBuilder() {
    DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
        .build();
        
    return new CosmosClientBuilder()
        .endpoint("<azure-cosmos-db-nosql-account-endpoint>")
        .credential(credential);
}

Pobieranie bazy danych

W klasie konfiguracji przykład implementuje metodę zwracającą nazwę istniejącej bazy danych o nazwie cosmicworks.

@Override
protected String getDatabaseName() {
    return "cosmicworks";
}

Weź kontener

Użyj dekoratora Container metody, aby skonfigurować klasę do reprezentowania elementów w kontenerze. Utwórz klasę, aby uwzględnić wszystkie elementy członkowskie, które chcesz serializować w formacie JSON. W tym przykładzie typ ma unikatowy identyfikator i pola dla kategorii, nazwy, ilości, ceny i rozliczenia.

@Container(containerName = "products", autoCreateContainer = false)
public class Item {
    private String id;
    private String name;
    private Integer quantity;
    private Boolean sale;

    @PartitionKey
    private String category;

    // Extra members omitted for brevity
}

Tworzenie elementu

Utwórz element w kontenerze przy użyciu polecenia repository.save.

Item item = new Item(
    "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "gear-surf-surfboards",
    "Yamba Surfboard",
    12,
    false
);
Item created_item = repository.save(item);

Odczytaj element

Wykonaj operację odczytu punktowego przy użyciu pól unikatowego identyfikatora (id) i klucza partycji. Użyj repository.findById do wydajnego pobrania konkretnego elementu.

PartitionKey partitionKey = new PartitionKey("gear-surf-surfboards");
Optional<Item> existing_item = repository.findById("aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb", partitionKey);
if (existing_item.isPresent()) {
    // Do something
}

Elementy zapytania

Wykonywanie zapytania względem wielu elementów w kontenerze przez zdefiniowanie zapytania w interfejsie repozytorium. W tym przykładzie użyto dekoratora Query metody do zdefiniowania metody wykonującej to sparametryzowane zapytanie:

SELECT * FROM products p WHERE p.category = @category

@Repository
public interface ItemRepository extends CosmosRepository<Item, String> {

    @Query("SELECT * FROM products p WHERE p.category = @category")
    List<Item> getItemsByCategory(@Param("category") String category);

}

Pobierz wszystkie wyniki zapytania przy użyciu polecenia repository.getItemsByCategory. Iteruj przez wyniki zapytania.

List<Item> items = repository.getItemsByCategory("gear-surf-surfboards");
for (Item item : items) {
    // Do something
}

Eksplorowanie danych

Użyj rozszerzenia programu Visual Studio Code dla usługi Azure Cosmos DB, aby eksplorować dane NoSQL. Możesz wykonywać podstawowe operacje bazy danych, w tym między innymi:

• Wykonywanie zapytań przy użyciu scrapbooku lub edytora zapytań
• Modyfikowanie, aktualizowanie, tworzenie i usuwanie elementów
• Importowanie danych zbiorczych z innych źródeł
• Zarządzanie bazami danych i kontenerami

Aby uzyskać więcej informacji, zobacz How-to use Visual Studio Code extension to explore Azure Cosmos DB for NoSQL data (Jak używać rozszerzenia programu Visual Studio Code do eksplorowania danych usługi Azure Cosmos DB for NoSQL).

Czyszczenie zasobów

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down

Powiązana zawartość

• Przewodnik Szybki start dla platformy .NET
• Szybki start Node.js
• Java — szybki start
• Go Quickstart
• Rust — szybki start