Упражнение. Создание приложения .NET и ссылки на пакет SDK

  • 7 мин

Первым шагом по созданию приложения проекта будет создание проекта .NET. Помните, что проект .NET должен использовать пакет SDK Microsoft.Azure.Cosmos для подключения к уже созданной учетной записи. Сейчас существуют три основных требования:

  • Создание проекта .NET.
  • Добавление ссылки на пакет SDK.
  • Подключение с помощью клиентских классов.

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

После выполнения этого упражнения у вас будет простое приложение .NET, которое успешно подключается к учетной записи API для NoSQL, но пока не выполняет никаких операций.

Создайте консольный проект .NET

С помощью интерфейса командной строки .NET создаются проекты .NET, а также выполняется управление ими в указанном каталоге. Здесь вы используете интерфейс командной строки для создания консольного приложения и добавления ссылки на пакет в пакет SDK.

  1. Создайте консольное приложение в текущем каталоге.

    dotnet new console

    Совет

    Так как вы не указали имя проекта или каталог, команда создаст проект в текущем каталоге и назовет его в соответствии с именем каталога (inventory).

  2. Добавьте ссылку на пакет к версии 3пакета SDK Microsoft.Azure.Cosmos из NuGet.

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

  3. Создайте проект .NET, чтобы убедиться, что вы правильно настроили проект.

    dotnet build

    Выходные данные команды должны совпадать с этим примером:

    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

Подключение к учетной записи

Теперь проект .NET должен быть создан и готов к добавлению вашего собственного пользовательского кода. У вас есть доступ к Microsoft.Azure.Cosmos пространству имен и всем классам, необходимым для подключения к API для NoSQL. Здесь вы открываете файл Program.cs и реализуете код для подключения к учетной записи с помощью клиентских классов пакета SDK.

  1. Откройте файл Program.cs в редакторе кода.

  2. Удалите весь существующий код из файла.

  3. Добавьте директивы using для следующих пространств имен:

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

  4. Создайте константную строковую переменную с именем connectionString. Задайте для переменной значение строка подключения, записанной ранее в этом модуле.

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

    Совет

    Предположим, что имя учетной записи Azure Cosmos DB и nybncrsna76fo-cosmos-nosql ключ естьAj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==, вы настроите строка подключения, как в следующем примере:

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

  5. Выведите строку подключения в консоль.

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

  6. Создайте экземпляр класса CosmosSerializationOptions под названием serializerOptions. Задайте свойству PropertyNamingPolicy значение CamelCase из перечисления CamelCase.

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

  7. Создайте экземпляр класса CosmosClientBuilder, передав строку подключения конструктору. Затем прикрепите метод Fluent WithSerializerOptions(CosmosSerializationOptions) и задайте для параметра этого метода значение serializerOptions. Цепочка Build() метода для создания экземпляра типа CosmosClient с именем client. Наконец, заключите создание клиентской переменной с помощью инструкции using.

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

  8. Выведите сообщение, указывающее, что клиент готов.

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

  9. Сохраните файл Program.cs.

Проверьте свою работу

Теперь приложение готово к запуску и подключению к Azure Cosmos DB для NoSQL. Здесь вы сравниваете код приложения с нашим примером. Затем вы проверка, что приложение работает должным образом, выполнив код.

  1. Запустите приложение .NET в терминале.

    dotnet run

  2. Просмотрите выходные данные запуска приложения. Выходные данные должны соответствовать примеру ниже.

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

Примечание.

Если при создании или запуске приложения .NET возникает ошибка, перейдите на вкладку "Рецензирование кода ", чтобы убедиться, что код соответствует примеру.