Ćwiczenie — tworzenie aplikacji platformy .NET i zestawu SDK referencyjnego

  • 7 min

Pierwszym krokiem tworzenia aplikacji projektu jest utworzenie projektu .NET. Pamiętaj, że projekt platformy .NET powinien używać zestawu SDK Microsoft.Azure.Cosmos do nawiązania połączenia z już utworzonym kontem. Obecnie istnieją trzy kluczowe wymagania:

  • Tworzenie projektu platformy .NET
  • Dodawanie odwołania do pakietu do zestawu SDK
  • Połączenie przy użyciu klas klienta

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

Po ukończeniu tego ćwiczenia będziesz mieć prostą aplikację platformy .NET, która pomyślnie łączy się z kontem interfejsu API dla noSQL, ale nie wykonuje jeszcze żadnych operacji.

Tworzenie projektu konsoli platformy .NET

Interfejs wiersza polecenia platformy .NET tworzy projekty .NET i zarządza nimi w określonym katalogu. W tym miejscu użyjesz interfejsu wiersza polecenia, aby utworzyć nową aplikację konsolową i dodać odwołanie do pakietu do zestawu SDK.

  1. Utwórz nową aplikację konsolową w bieżącym katalogu.

    dotnet new console

    Napiwek

    Ponieważ nie określono nazwy projektu lub katalogu, polecenie utworzy nowy projekt w bieżącym katalogu i nada projektowi nazwę zgodną z nazwą katalogu (spis).

  2. Dodaj odwołanie do pakietu w wersji 3 zestawu Microsoft.Azure.Cosmos SDK z pakietu NuGet.

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

  3. Skompiluj projekt .NET, aby upewnić się, że projekt został poprawnie skonfigurowany.

    dotnet build

    Dane wyjściowe polecenia powinny być podobne do tego przykładu:

    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

Połączenie do konta

Teraz projekt platformy .NET powinien zostać skompilowany i gotowy do dodania własnego kodu niestandardowego. Masz dostęp do Microsoft.Azure.Cosmos przestrzeni nazw i wszystkich klas niezbędnych do nawiązania połączenia z interfejsem API dla NoSQL. W tym miejscu otwórz plik Program.cs i zaimplementujesz kod w celu nawiązania połączenia z kontem przy użyciu klas klienta zestawu SDK.

  1. Otwórz plik Program.cs w edytorze kodu.

  2. Usuń cały istniejący kod z pliku.

  3. Dodaj dyrektywy using dla następujących przestrzeni nazw:

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

  4. Utwórz zmienną ciągu stałej o nazwie connectionString. Ustaw wartość zmiennej na parametry połączenia zarejestrowaną wcześniej w tym module.

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

    Napiwek

    Zakładając, że nazwa konta usługi Azure Cosmos DB to nybncrsna76fo-cosmos-nosql i klucz to Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==, należy skonfigurować parametry połączenia w następujący przykład:

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

  5. Wydrukuj parametry połączenia do konsoli.

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

  6. Utwórz nowe wystąpienie CosmosSerializationOptions klasy o nazwie serializerOptions. PropertyNamingPolicy Ustaw właściwość na wartość CamelCase z CamelCase wyliczenia.

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

  7. Utwórz nowe wystąpienie CosmosClientBuilder klasy, przekazując parametry połączenia do konstruktora. Następnie należy połączyć w łańcuch płynnej WithSerializerOptions(CosmosSerializationOptions) metody i ustawić parametr tej metody na serializerOptionswartość . Utwórz łańcuch metody w Build() celu utworzenia wystąpienia typu CosmosClient o nazwie client. Na koniec zawijaj tworzenie zmiennej klienta za pomocą instrukcji using.

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

  8. Wydrukuj komunikat z informacją, że klient jest gotowy.

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

  9. Zapisz plik Program.cs.

Sprawdź swoją pracę

Aplikacja jest teraz gotowa do uruchomienia i nawiązania połączenia z usługą Azure Cosmos DB for NoSQL. W tym miejscu porównasz kod aplikacji z naszym przykładem. Następnie sprawdź, czy aplikacja działa zgodnie z oczekiwaniami, uruchamiając kod.

  1. Uruchamianie aplikacji .NET w terminalu

    dotnet run

  2. Obserwuj dane wyjściowe uruchamiania aplikacji. Dane wyjściowe powinny być zgodne z przykładem w tym miejscu.

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

Uwaga

Jeśli kompilowanie lub uruchamianie aplikacji .NET powoduje wystąpienie błędu, przejdź do karty Przeglądanie kodu , aby sprawdzić, czy kod jest zgodny z przykładem.