Краткое руководство. Установка и использование пакета в Visual Studio (только в Windows)Quickstart: Install and use a package in Visual Studio (Windows only)

Пакеты NuGet содержат многократно используемый код, предлагаемый другими разработчиками для ваших проектов.NuGet packages contain reusable code that other developers make available to you for use in your projects. Дополнительные сведения см. в разделе Что такое NuGet?.See What is NuGet? for background. Пакеты устанавливаются в проекте Visual Studio с помощью диспетчера пакетов NuGet, консоли диспетчера пакетов или интерфейса командной строки .NET.Packages are installed into a Visual Studio project using the NuGet Package Manager, the Package Manager Console, or the dotnet CLI. В этой статье описано, как использовать популярный пакет Newtonsoft.Json и проект Windows Presentation Foundation (WPF).This article demonstrates the process using the popular Newtonsoft.Json package and a Windows Presentation Foundation (WPF) project. Тот же процесс применяется к любому другому проекту .NET или .NET Core.The same process applies to any other .NET or .NET Core project.

После установки ссылаться на пакет в коде можно с помощью using <namespace>, где <namespace> соответствует используемому пакету.Once installed, refer to the package in code with using <namespace> where <namespace> is specific to the package you're using. После указания ссылки можно обращаться к пакету посредством его интерфейса API.Once the reference is made, you can call the package through its API.

Совет

Начните работу с сайта nuget.org: Разработчики .NET обычно находят компоненты, которые можно использовать в собственных приложениях, просматривая сайт nuget.org.Start with nuget.org: Browsing nuget.org is how .NET developers typically find components they can reuse in their own applications. Вы можете выполнить поиск непосредственно на сайте nuget.org или найти и установить пакеты в Visual Studio, как описано в этой статье.You can search nuget.org directly or find and install packages within Visual Studio as shown in this article. См. подробнее о поиске и оценке пакетов NuGet.For general information, see Find and evaluate NuGet packages.

Предварительные требованияPrerequisites

  • Использование Visual Studio 2019 с рабочей нагрузкой "Разработка классических приложений .NET".Visual Studio 2019 with the .NET Desktop Development workload.

Вы можете установить бесплатный выпуск Community 2019 с сайта visualstudio.com либо использовать выпуск Professional или Enterprise.You can install the 2019 Community edition for free from visualstudio.com or use the Professional or Enterprise editions.

См. сведения об установке и использовании пакета в Visual Studio для Mac.If you're using Visual Studio for Mac, see Install and use a package in Visual Studio for Mac.

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

Пакеты NuGet можно установить в проект .NET, если эти пакеты поддерживают ту же требуемую версию .NET Framework, что и проект.NuGet packages can be installed into any .NET project, provided that the package supports the same target framework as the project.

В этом пошаговом руководстве описано, как использовать простое приложение WPF.For this walkthrough, use a simple WPF app. Создайте проект в Visual Studio, щелкнув Файл > Создать проект и введя .NET в поле поиска. Затем выберите Приложение WPF (.NET Framework) .Create a project in Visual Studio using File > New Project, typing .NET in the search box, and then selecting the WPF App (.NET Framework). Нажмите кнопку Далее.Click Next. При появлении запроса примите значения по умолчанию для платформы.Accept the default values for Framework when prompted.

Visual Studio создаст проект и откроет его в обозревателе решений.Visual Studio creates the project, which opens in Solution Explorer.

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

Для установки пакета можно использовать диспетчер пакетов NuGet или консоль диспетчера пакетов.To install the package, you can use either the NuGet Package Manager or the Package Manager Console. При установке пакета NuGet регистрирует зависимость в файле проекта или файле packages.config (в зависимости от формата проекта).When you install a package, NuGet records the dependency in either your project file or a packages.config file (depending on the project format). Дополнительные сведения см. в разделе Обзор использования пакетов и рабочий процесс.For more information, see Package consumption overview and workflow.

Диспетчер пакетов NuGetNuGet Package Manager

  1. В обозревателе решений щелкните правой кнопкой мыши узел Ссылки и выберите пункт Управление пакетами NuGet.In Solution Explorer, right-click References and choose Manage NuGet Packages.

    Пункт "Управление пакетами NuGet" для узла "Ссылки" проекта

  2. Выберите nuget.org в качестве источника пакетов, перейдите на вкладку Обзор, выполните поиск по запросу Newtonsoft.Json, выберите этот пакет в списке и нажмите кнопку Установить.Choose "nuget.org" as the Package source, select the Browse tab, search for Newtonsoft.Json, select that package in the list, and select Install:

    Поиск пакета Newtonsoft.Json

    См. подробнее о диспетчере пакетов NuGet в руководстве по установке пакетов и управлении ими с помощью Visual Studio.If you want more information on the NuGet Package Manager, see Install and manage packages using Visual Studio.

  3. Примите все запросы касательно лицензии.Accept any license prompts.

  4. (Только в Visual Studio 2017.) Если вам будет предложено выбрать формат управления пакетом, выберите PackageReference в файле проекта.(Visual Studio 2017 only) If prompted to select a package management format, select PackageReference in project file:

    Выбор формата управления пакетами

  5. В запросе на проверку изменений нажмите кнопку ОК.If prompted to review changes, select OK.

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

  1. Последовательно выберите Сервис > Диспетчер пакетов NuGet > Консоль диспетчера пакетов.Select the Tools > NuGet Package Manager > Package Manager Console menu command.

  2. После открытия консоли убедитесь, что в раскрывающемся списке Проект по умолчанию показан проект, в который требуется установить пакет.Once the console opens, check that the Default project drop-down list shows the project into which you want to install the package. Если в решении всего лишь один проект, он автоматически выбран.If you have a single project in the solution, it is already selected.

    Выбор проекта для пакета

  3. Введите команду Install-Package Newtonsoft.Json (см. сведения о ней в этой статье).Enter the command Install-Package Newtonsoft.Json (see Install-Package). В окне консоли отображаются выходные данные команды.The console window shows output for the command. Ошибки обычно означают, что пакет не совместим с целевой платформой проекта.Errors typically indicate that the package isn't compatible with the project's target framework.

    См. подробнее о консоли диспетчера пакетов в руководстве по установке пакетов и управлении ими с помощью консоли диспетчера пакетов.If you want more information on the Package Manager Console, see Install and manage packages using Package Manager Console.

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

Добавив пакет Newtonsoft.Json в проект, вы можете вызывать его метод JsonConvert.SerializeObject для преобразования объекта в удобную для восприятия строку.With the Newtonsoft.Json package in the project, you can call its JsonConvert.SerializeObject method to convert an object to a human-readable string.

  1. Откройте файл MainWindow.xaml и замените существующий элемент Grid следующим кодом:Open MainWindow.xaml and replace the existing Grid element with the following:

    <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 следующий код.Open the MainWindow.xaml.cs file (located in Solution Explorer under the MainWindow.xaml node), and insert the following code inside the MainWindow class:

    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, Formatting.Indented);
        TextBlock.Text = json;
    }
    
  3. Несмотря на то что вы добавили пакет Newtonsoft.Json в проект, JsonConvert подчеркивается красной волнистой линией, так как оператор using требуется в верхней части файла кода.Even though you added the Newtonsoft.Json package to the project, red squiggles appears under JsonConvert because you need a using statement at the top of the code file:

    using Newtonsoft.Json;
    
  4. Выполните сборку и запустите приложение, нажав клавишу F5 или выбрав команду Отладка > Начать отладку.Build and run the app by pressing F5 or selecting Debug > Start Debugging:

    Изначальные выходные данные приложения WPF

  5. Нажмите кнопку. Надпись TextBlock заменится текстом в формате JSON:Select on the button to see the contents of the TextBlock replaced with some JSON text:

    Выходные данные приложения WPF после нажатия кнопки

Другие видео о NuGet см. на Channel 9 и YouTube.Find more NuGet videos on Channel 9 and YouTube.

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

Поздравляем! Вы установили пакет NuGet и поработали с ним.Congratulations on installing and using your first NuGet package!

См. подробнее о возможностях NuGet по приведенным ниже ссылкам.To explore more that NuGet has to offer, select the links below.