Краткое руководство. Установка и использование пакета NuGet в Visual Studio (только для Windows)

  • Статья

Пакет NuGet содержит повторно используемый код, который другие разработчики сделали доступными для использования в проектах. Пакет NuGet можно установить в проекте Microsoft Visual Studio с помощью диспетчер пакетов NuGet, консоли диспетчер пакетов или .NET CLI. В этой статье показано, как создать проект Windows Presentation Foundation (WPF) с популярным Newtonsoft.Json пакетом. Тот же процесс применяется к любому другому проекту .NET или .NET Core.

После установки пакета NuGet вы можете сделать ссылку на него в коде с using <namespace> помощью инструкции, где <пространство> имен — это имя используемого пакета. После того как вы сделали ссылку, вы можете вызвать пакет через свой API.

Статья доступна только для пользователей Windows. См. сведения об установке и использовании пакета в Visual Studio для Mac.

Совет

Чтобы найти пакет NuGet, начните с nuget.org. Просмотр nuget.org заключается в том, как разработчики .NET обычно находят компоненты, которые они могут повторно использовать в своих приложениях. Вы можете выполнить поиск nuget.org напрямую или найти и установить пакеты в Visual Studio, как показано в этой статье. Дополнительные сведения см. в статье "Поиск и оценка пакетов NuGet".

Необходимые компоненты

  • Установите Visual Studio 2022 для Windows с рабочей нагрузкой разработки классических приложений .NET.

    Вы можете установить выпуск Community 2022 бесплатно из visualstudio.microsoft.com или использовать выпуск Professional или Enterprise.

Создание проекта

Пакет NuGet можно установить в любой проект .NET, если этот пакет поддерживает ту же целевую платформу, что и проект. Однако для этого краткого руководства вы создадите проект приложения Windows Presentation Foundation (WPF).

Выполните следующие действия:

  1. В Visual Studio выберите Файл>Создать>Проект.

  2. В окне создания проекта введите WPF в поле поиска и выберите C# и Windows в раскрывающихся списках. В результирующем списке шаблонов проектов выберите приложение WPF и нажмите кнопку "Далее".

  3. В окне "Настройка нового проекта" при необходимости обновите имя проекта и имя решения, а затем нажмите кнопку "Далее".

  4. В окне "Дополнительные сведения" выберите .NET 6.0 (или последняя версия) для Платформы, а затем нажмите кнопку "Создать".

    Visual Studio создает проект и отображается в Обозреватель решений.

Добавление пакета NuGet Newtonsoft.Json

Чтобы установить пакет NuGet в этом кратком руководстве, можно использовать диспетчер пакетов NuGet или консоль диспетчер пакетов. В зависимости от формата проекта установка пакета NuGet записывает зависимость в файле проекта или файле package.config . Дополнительные сведения см. в разделе "Рабочий процесс потребления пакетов".

Диспетчер пакетов NuGet

Чтобы использовать диспетчер пакетов NuGet для установки Newtonsoft.Json пакета в Visual Studio, выполните следующие действия.

  1. Выберите Проект>Управление пакетами NuGet.

  2. На странице диспетчер пакетов NuGet выберите nuget.org в качестве источника пакета.

  3. На вкладке "Обзор" найдите Newtonsoft.Json, выберите Newtonsoft.Json в списке и нажмите кнопку "Установить".

    Screenshot showing the NuGet Package Manager window with the Newtonsoft.Json package selected.

  4. Если вам будет предложено проверить установку, нажмите кнопку "ОК".

Консоль диспетчера пакетов

Кроме того, чтобы использовать консоль диспетчер пакетов в Visual Studio для установки Newtonsoft.Json пакета, выполните следующие действия.

  1. В Visual Studio выберите Tools>NuGet диспетчер пакетов> диспетчер пакетов Console.

  2. После открытия области консоли диспетчер пакетов убедитесь, что в раскрывающемся списке проекта по умолчанию отображается проект, в котором требуется установить пакет. Если у вас есть один проект в решении, он предварительно выбран.

    Screenshot showing the Package Manage Console window with Default project highlighted.

  3. В командной строке консоли введите команду Install-Package Newtonsoft.Json. Дополнительные сведения об этой команде см. в разделе Install-Package.

    В окне консоли отображаются выходные данные для команды. Ошибки обычно означают, что пакет не совместим с целевой платформой проекта.

Использование интерфейса API Newtonsoft.Json в приложении

Newtonsoft.Json При использовании пакета в проекте вызовите его JsonConvert.SerializeObject метод для преобразования объекта в удобочитаемую для человека строку:

  1. В Обозреватель решений откройте MainWindow.xaml и замените существующий <Grid> элемент следующим кодом:

    <Grid Background="White">
    <StackPanel VerticalAlignment="Center">
        <Button Click="Button_Click" Width="100px" HorizontalAlignment="Center" Content="Click Me" Margin="10"/>
        <TextBlock Name="TextBlock" HorizontalAlignment="Center" Text="TextBlock" Margin="10"/>
    </StackPanel>
</Grid>

  2. Откройте файл MainWindow.xaml.cs в узле MainWindow.xaml и вставьте следующий код в MainWindow класс после конструктора:

    public class Account
{
    public string Name { get; set; }
    public string Email { get; set; }
    public DateTime DOB { get; set; }
}

private void Button_Click(object sender, RoutedEventArgs e)
{
    Account account = new Account
    {
        Name = "John Doe",
        Email = "john@microsoft.com",
        DOB = new DateTime(1980, 2, 20, 0, 0, 0, DateTimeKind.Utc),
    };
    string json = JsonConvert.SerializeObject(account, Newtonsoft.Json.Formatting.Indented);
    TextBlock.Text = json;
}

  3. Чтобы избежать ошибки для JsonConvert объекта в коде (появится красная строка волнистой линии), добавьте следующую инструкцию в начале файла кода:

    using Newtonsoft.Json;

  4. Чтобы создать и запустить приложение, нажмите клавишу F5 или выберите команду Отладка запуска отладки>.

    Откроется следующее окно:

    Screenshot showing the initial output of the WPF app.

  5. Нажмите кнопку "Щелкнуть меня", чтобы просмотреть содержимое TextBlock объекта, замененного текстом JSON.

    Screenshot showing the output of the WPF app after selecting the button.

См. также

Дополнительные сведения о NuGet см. в следующих статьях:

Следующие шаги

Поздравляем с установкой и использованием первого пакета NuGet. Перейдите к следующей статье, чтобы узнать больше об установке пакетов NuGet и управлении ими.

Установка пакетов и управление ими с помощью диспетчер пакетов NuGet

Установка пакетов и управление ими с помощью консоли диспетчер пакетов