Rychlý start: Knihovna Azure Cosmos DB for NoSQL pro Javu

Článek
01/10/2024

PLATÍ PRO: NoSQL

Začínáme s klientskou knihovnou Azure Cosmos DB for NoSQL pro Javu pro dotazování dat v kontejnerech a provádění běžných operací s jednotlivými položkami Pomocí následujícího postupu nasaďte do svého prostředí minimální řešení pomocí Azure Developer CLI.

Referenční dokumentace k | rozhraní API – Balíček zdrojového kódu | knihovny (Maven) | Azure Developer CLI

Požadavky

Účet Azure s aktivním předplatným. Vytvoření účtu zdarma
Účet GitHub

Účet Azure s aktivním předplatným. Vytvoření účtu zdarma
Azure Developer CLI
Docker Desktop

Nastavení

Nasaďte vývojový kontejner tohoto projektu do svého prostředí. Pak pomocí Azure Developer CLI (azd) vytvořte účet Azure Cosmos DB for NoSQL a nasaďte kontejnerizovanou ukázkovou aplikaci. Ukázková aplikace používá klientskou knihovnu ke správě, vytváření, čtení a dotazování ukázkových dat.

Důležité

Účty GitHubu zahrnují nárok na úložiště a hodiny jádra bez poplatků. Další informace najdete v zahrnutých hodinách úložiště a jader pro účty GitHubu.

Otevřete terminál v kořenovém adresáři projektu.
Ověřte se v Rozhraní příkazového řádku Azure Developer CLI pomocí azd auth loginrozhraní příkazového řádku . Postupujte podle kroků určených nástrojem k ověření v rozhraní příkazového řádku pomocí vašich upřednostňovaných přihlašovacích údajů Azure.
```
azd auth login
```
Slouží azd init k inicializaci projektu.
```
azd init
```
Během inicializace nakonfigurujte jedinečný název prostředí.

Tip

Název prostředí se také použije jako název cílové skupiny prostředků. Pro účely tohoto rychlého startu zvažte použití .msdocs-cosmos-db-
Nasaďte účet služby Azure Cosmos DB pomocí azd up. Šablony Bicep také nasazují ukázkovou webovou aplikaci.
```
azd up
```
Během procesu zřizování vyberte své předplatné a požadované umístění. Počkejte na dokončení procesu zřizování. Proces může trvat přibližně pět minut.

Po dokončení zřizování prostředků Azure se do výstupu zahrne adresa URL spuštěné webové aplikace.

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.

Pomocí adresy URL v konzole přejděte do webové aplikace v prohlížeči. Sledujte výstup spuštěné aplikace.

Instalace klientské knihovny

Klientská knihovna je k dispozici prostřednictvím Mavenu azure-spring-data-cosmos jako balíček.

Přejděte do /src/web složky a otevřete soubor pom.xml .

Pokud ještě neexistuje, přidejte položku balíčku azure-spring-data-cosmos .

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

Pokud ještě neexistuje, přidejte pro balíček další závislost azure-identity .

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

Objektový model

Název	Popis
`EnableCosmosRepositories`	Tento typ je dekorátor metody, který slouží ke konfiguraci úložiště pro přístup ke službě Azure Cosmos DB for NoSQL.
`CosmosRepository`	Tato třída je primární klientskou třídou a slouží ke správě dat v rámci kontejneru.
`CosmosClientBuilder`	Tato třída je továrna používaná k vytvoření klienta používaného úložištěm.
`Query`	Tento typ je dekorátor metody sloužící k určení dotazu, který se spustí v úložišti.

Vzorový kód v šabloně používá databázi pojmenovanou cosmicworks a kontejner s názvem products. Kontejner products obsahuje podrobnosti, jako je název, kategorie, množství, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá /category vlastnost jako klíč logického oddílu.

Ověření klienta

Žádosti o aplikace na většinu služeb Azure musí být autorizované. Tento DefaultAzureCredential typ použijte jako upřednostňovaný způsob implementace bez hesla mezi vašimi aplikacemi a Službou Azure Cosmos DB for NoSQL. DefaultAzureCredential podporuje více metod ověřování a určuje, která metoda se má použít za běhu.

Důležité

Žádosti o služby Azure můžete také autorizovat pomocí hesel, připojovací řetězec nebo jiných přihlašovacích údajů přímo. Tento přístup by však měl být používán s opatrností. Vývojáři musí být usilovní, aby tyto tajné kódy nikdy nezpřístupnili v nezabezpečeném umístění. Každý, kdo získá přístup k heslu nebo tajnému klíči, se může ověřit v databázové službě. DefaultAzureCredential nabízí vylepšené výhody správy a zabezpečení oproti klíči účtu, které umožňují ověřování bez hesla bez rizika ukládání klíčů.

Nejprve tato ukázka vytvoří novou třídu, která dědí z AbstractCosmosConfiguration konfigurace připojení ke službě Azure Cosmos DB for NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {

V rámci třídy konfigurace tato ukázka vytvoří novou instanci CosmosClientBuilder třídy a nakonfiguruje ověřování pomocí DefaultAzureCredential instance.

@Bean
public CosmosClientBuilder getCosmosClientBuilder() {
    DefaultAzureCredential azureTokenCredential = new DefaultAzureCredentialBuilder()
        .build();
        
    return new CosmosClientBuilder()
        .endpoint(uri)
        .credential(azureTokenCredential);
}

Získání databáze

V konfigurační třídě ukázka implementuje metodu pro vrácení názvu existující databáze s názvem cosmicworks.

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

Získání kontejneru

Pomocí dekorátoru Container metody nakonfigurujte třídu tak, aby reprezentovala položky v kontejneru. Vytvořte třídu tak, aby zahrnovala všechny členy, které chcete serializovat do formátu JSON. V tomto příkladu má typ jedinečný identifikátor a pole pro kategorii, název, množství, cenu a volný prostor.

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

    @PartitionKey
    private String category;

Vytvoření položky

Vytvoření položky v kontejneru pomocí repository.save.

Item item = new Item(
    "70b63682-b93a-4c77-aad2-65501347265f",
    "gear-surf-surfboards",
    "Yamba Surfboard",
    12,
    false
);
Item created_item = repository.save(item);

Čtení položky

Proveďte operaci čtení bodu pomocí polí jedinečného identifikátoru (id) i klíče oddílu. Slouží repository.findById k efektivnímu načtení konkrétní položky.

PartitionKey partitionKey = new PartitionKey("gear-surf-surfboards");
Optional<Item> existing_item = repository.findById("70b63682-b93a-4c77-aad2-65501347265f", partitionKey);
if (existing_item.isPresent()) {
    // Do something  
}

Dotazování položek

Proveďte dotaz na více položek v kontejneru definováním dotazu v rozhraní úložiště. Tato ukázka používá Query dekorátor metody k definování metody, která spouští tento parametrizovaný dotaz:

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

Načtěte všechny výsledky dotazu pomocí repository.getItemsByCategory. Projděte výsledky dotazu.

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

Další krok

Kurz: Vytvoření webové aplikace v Javě