クイック スタート: 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. パッケージは NuGet パッケージ マネージャー、パッケージ マネージャー コンソール、または dotnet CLI を使用して、Visual Studio プロジェクトにインストールされます。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 を開始する:nuget.org を参照するのは、.NET 開発者が自身のアプリケーションで再利用可能なコンポーネントを検索するための一般的な方法です。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

  • .NET デスクトップ開発ワークロードを利用する Visual Studio 2019。Visual Studio 2019 with the .NET Desktop Development workload.

visualstudio.com から無料の 2019 Community Edition をインストールするか、Professional または Enterprise Edition を使用できます。You can install the 2019 Community edition for free from visualstudio.com or use the Professional or Enterprise editions.

Visual Studio for Mac を使用している場合は、Visual Studio for 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 プロジェクトにインストールできます。ただし、パッケージが同じターゲット フレームワークをプロジェクトとしてサポートしていることが条件です。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. [ファイル] > [新しいプロジェクト] を使用し、検索ボックスに「 .NET」と入力して、 [WPF アプリ (.NET Framework)] を選択し、Visual Studio にプロジェクトを作成します。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.

Newtonsoft.Json NuGet パッケージを追加するAdd 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.

NuGet パッケージ マネージャーNuGet 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. 変更の確認を求められた場合、 [OK] を選択します。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.

    Newtonsoft.Json パッケージを見つけます

  3. コマンド Install-Package Newtonsoft.Json を入力します (「Install-Package」を参照してください)。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.

アプリで Newtonsoft.Json API を使用する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 要素を次の XAML に置き換えます。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.