Cvičení – vytvoření aplikace .NET a referenční sady SDK

  • 7 min

Jako první krok k vytvoření aplikace projektu je potřeba vytvořit projekt .NET. Vzpomeňte si, že projekt .NET by měl používat sadu Microsoft.Azure.Cosmos SDK pro připojení k účtu, který jste už vytvořili. V tuto chvíli existují tři klíčové požadavky:

  • Vytvoření projektu .NET
  • Přidání odkazu na balíček do sady SDK
  • Připojení pomocí tříd klienta

Illustration of icons of an Azure Cosmos DB account and .NET application.

Po dokončení tohoto cvičení budete mít jednoduchou aplikaci .NET, která se úspěšně připojí k vašemu účtu API pro NoSQL, ale zatím neprovádí žádné operace.

Vytvoření projektu konzoly .NET

Rozhraní příkazového řádku .NET vytvoří a spravuje projekty .NET v zadaném adresáři. V této části pomocí rozhraní příkazového řádku vytvoříte novou konzolovou aplikaci a přidáte do sady SDK odkaz na balíček.

  1. V aktuálním adresáři vytvořte novou konzolovou aplikaci.

    dotnet new console

    Tip

    Vzhledem k tomu, že jste nezadali název projektu nebo adresář, příkaz vytvoří nový projekt v aktuálním adresáři a pojmenuje projekt tak, aby odpovídal názvu adresáře (inventáři).

  2. Přidejte odkaz na balíček verze 3 sady Microsoft.Azure.Cosmos SDK z NuGetu.

    dotnet add package Microsoft.Azure.Cosmos --version 3.*

  3. Sestavte projekt .NET, abyste měli jistotu, že jste projekt správně nakonfigurovali.

    dotnet build

    Výstup příkazu by měl být podobný tomuto příkladu:

    MSBuild version 17.5.0+6f08c67f3 for .NET
  Determining projects to restore...
  All projects are up-to-date for restore.
  dotnet-env-azure-cosmos-db -> /workspaces/dotnet-env-azure-cosmos-db/bin/Debug/net7.0/dotnet-env-azure-cosmos-db.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:05.96

Připojení k účtu

Teď by měl být projekt .NET vytvořený a připravený k přidání vlastního kódu. Máte přístup k Microsoft.Azure.Cosmos oboru názvů a ke všem třídám nezbytným pro připojení k rozhraní API pro NoSQL. V této části otevřete soubor Program.cs a implementujete kód pro připojení k účtu pomocí klientských tříd sady SDK.

  1. Otevřete soubor Program.cs v editoru kódu.

  2. Odstraňte veškerý existující kód ze souboru.

  3. Přidejte direktivy using pro následující obory názvů:

    using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;
using Microsoft.Azure.Cosmos.Linq;

  4. Vytvořte konstantní řetězcovou proměnnou s názvem connectionString. Nastavte hodnotu proměnné na připojovací řetězec jste si poznamenali dříve v tomto modulu.

    const string connectionString = "<your-azure-cosmos-db-connection-string>";

    Tip

    Za předpokladu, že název účtu služby Azure Cosmos DB je nybncrsna76fo-cosmos-nosql a klíč je Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==, nakonfigurujete připojovací řetězec jako v tomto příkladu:

    const string connectionString = "AccountEndpoint=https://nybncrsna76fo-cosmos-nosql.documents.azure.com:443/;AccountKey=Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==;";

  5. Vytiskněte připojovací řetězec do konzoly.

    Console.WriteLine($"[Connection string]:\t{connectionString}");

  6. Vytvořte novou instanci CosmosSerializationOptions třídy s názvem serializerOptions. PropertyNamingPolicy Nastavte vlastnost na hodnotu CamelCase z výčtuCamelCase.

    CosmosSerializationOptions serializerOptions = new()
{
    PropertyNamingPolicy = CosmosPropertyNamingPolicy.CamelCase
};

  7. Vytvořte novou instanci CosmosClientBuilder třídy předáním připojovací řetězec konstruktoru. Dále zřetězte fluent metodu WithSerializerOptions(CosmosSerializationOptions) a nastavte parametr této metody na serializerOptions. Zřetězte metodu Build() pro vytvoření instance typu CosmosClient s názvem client. Nakonec zabalte vytvoření proměnné klienta příkazem using.

    using CosmosClient client = new CosmosClientBuilder(connectionString)
    .WithSerializerOptions(serializerOptions)
    .Build();

  8. Vytiskněte zprávu s informací, že váš klient je připravený.

    Console.WriteLine("[Client ready]");

  9. Uložte soubor Program.cs.

Kontrola práce

Aplikace je teď připravená ke spuštění a připojení ke službě Azure Cosmos DB for NoSQL. Tady porovnáte kód aplikace s naší ukázkou. Potom zkontrolujete, že aplikace funguje podle očekávání spuštěním kódu.

  1. Spuštění aplikace .NET v terminálu

    dotnet run

  2. Sledujte výstup spuštění aplikace. Výstup by měl odpovídat příkladu zde.

    [Connection string]:    <your-azure-cosmos-db-connection-string>
[Client ready]

Poznámka:

Pokud sestavení nebo spuštění aplikace .NET způsobí chybu, přejděte na kartu Revize kódu a ověřte, že váš kód odpovídá příkladu.