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

• Dotyczy:

  ✅ NoSQL

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

W tym przewodniku Szybki start wdrożysz podstawową aplikację usługi Azure Cosmos DB dla tabel przy użyciu zestawu Azure SDK dla języka Java. Usługa Azure Cosmos DB dla tabel to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie danych ze strukturą tabeli w chmurze. Dowiesz się, jak tworzyć tabele, wiersze i wykonywać podstawowe zadania w ramach zasobu usługi Azure Cosmos DB przy użyciu zestawu Azure SDK dla języka Java.

Dokumentacja interfejsu API — pakiet | kodu | źródłowego biblioteki (Maven) | Interfejs wiersza polecenia dla deweloperów platformy Azure

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ć usługę Azure Cosmos DB dla konta tabeli 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 nie uwierzytelniono, uwierzytelnij się w interfejsie wiersza polecenia dewelopera platformy Azure przy użyciu polecenia 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 polecenia , 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 aprowizacji. 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 narzędzia Maven jako azure-spring-data-cosmos pakietu.

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

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

   <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>
   

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ą używaną do tworzenia klienta używanego 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
• Pobieranie kontenera
• Tworzenie elementu
• Pobieranie elementu
• Elementy kwerend

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

Uwierzytelnianie użytkownika

Najpierw w tym przykładzie zostanie utworzona nowa klasa dziedziczona w AbstractCosmosConfiguration celu skonfigurowania połączenia z usługą Azure Cosmos DB for NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {
}

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

@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";
}

Pobieranie kontenera

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);

Odczytywanie elementu

Wykonaj operację odczytu punktu przy użyciu pól unikatowego identyfikatora (id) i klucza partycji. Służy repository.findById do wydajnego pobierania określonego 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 kwerend

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. Pętla przez wyniki zapytania.

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

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
• przewodnik Szybki start dotyczący Node.js
• Java — szybki start
• Szybki start dla języka Go