クイックスタート: Visual Studio にパッケージをインストールして使用する (Windows のみ)

  • [アーティクル]

NuGet パッケージには、お客様のプロジェクトで使用することを他の開発者が許可した、再利用可能なコードが含まれます。 NuGet パッケージ マネージャー、パッケージ マネージャー コンソール、または .NET CLI を使用して、Microsoft Visual Studio プロジェクトに NuGet パッケージをインストールできます。 この記事では、人気 Newtonsoft.Json のあるパッケージを使用して Windows Presentation Foundation (WPF) プロジェクトを作成する方法について説明します。 同じプロセスは、他の任意の .NET または .NET Core プロジェクトにも適用されます。

NuGet パッケージをインストールした後は、using <namespace> ステートメントを使用してコード内でそのパッケージを参照できます。<名前空間>は、使用しているパッケージの名前です。 参照を作成すると、その API からパッケージを呼び出すことができます。

この記事は Windows ユーザー専用です。 Visual Studio for Mac を使用している場合は、Visual Studio for Mac でのパッケージのインストールと使用に関するページをご覧ください。

ヒント

NuGet パッケージを見つけるには、nuget.org から始めます。nuget.org を参照するのは、.NET 開発者が自身のアプリケーションで再利用可能なコンポーネントを検索するための一般的な方法です。 nuget.org を直接検索するか、この記事に示すように、パッケージを検索して Visual Studio 内にインストールすることができます。 詳細については、「NuGet パッケージの検索と評価」を参照してください。

前提条件

  • Visual Studio 2022 for Windows と .NET デスクトップ開発ワークロードをインストールします。

    visualstudio.microsoft.com から無料の 2022 Community Edition をインストールするか、Professional または Enterprise Edition を使用できます。

プロジェクトの作成

NuGet パッケージは任意の .NET プロジェクトにインストールできます。ただし、そのパッケージが同じターゲット フレームワークをプロジェクトとしてサポートしている場合に限ります。 ただし、このクイックスタートでは、Windows Presentation Foundation (WPF) アプリケーション プロジェクトを作成します。

次のステップを実行します。

  1. Visual Studio で、 [ファイル]>[新規]>[プロジェクト] の順に選択します。

  2. [新しいプロジェクトを作成する] ウィンドウで、検索ボックスに「WPF」と入力し、ドロップダウン リストで [C#] と [Windows] を選択します。 結果として表示されるプロジェクト テンプレートの一覧で、[WPF アプリケーション] を選択してから、[次へ] を選択します。

  3. [新しいプロジェクトを構成する] ウィンドウで、必要に応じてプロジェクト名とソリューション名を更新し、[次へ] を選択します。

  4. [追加情報] ウィンドウで、[フレームワーク] に [.NET 6.0] を選択してから、[作成] を選択します。

    Visual Studio によってプロジェクトが作成され、ソリューション エクスプローラーに表示されます。

Newtonsoft.Json NuGet パッケージを追加する

このクイックスタートで NuGet パッケージをインストールするには、NuGet パッケージ マネージャーまたはパッケージ マネージャー コンソールのいずれかを使用できます。 プロジェクトの形式によっては、NuGet パッケージをインストールすると、プロジェクト ファイルまたは packages.config ファイルのどちらかに依存関係が記録されます。 詳細については、「パッケージ利用のワークフロー」を参照してください。

NuGet パッケージ マネージャー

NuGet パッケージ マネージャーを使用して Visual Studio に Newtonsoft.Json パッケージをインストールするには、次の手順に従います。

  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. インストールの確認を求められたら、[OK] を選択します。

パッケージ マネージャー コンソール

また、NuGet パッケージ マネージャーを使用して Visual Studio に Newtonsoft.Json パッケージをインストールするには、次の手順に従います。

  1. Visual Studio で [ツール]>[NuGet パッケージ マネージャー]>[パッケージ マネージャー コンソール] の順に選択します。

  2. [パッケージ マネージャー コンソール] ウィンドウが開いたら、[既定のプロジェクト] ドロップダウン リストに、パッケージをインストールするプロジェクトが表示されていることを確認します。 ソリューション内に単一のプロジェクトがあれば、それは既に選択されています。

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

  3. コンソール プロンプトに Install-Package Newtonsoft.Json コマンドを入力します。 このコマンドの詳細については、「Install-Package」を参照してください。

    コンソール ウィンドウに、このコマンドの出力が表示されます。 通常、エラーは、パッケージがプロジェクトのターゲット フレームワークと互換性がないことを示します。

アプリで Newtonsoft.Json API を使用する

プロジェクトに 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 ノードの下にある MainWindow.xaml.cs ファイルを開き、コンストラクターの後の 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 パッケージ マネージャーを使用してパッケージをインストールして管理する

パッケージ マネージャー コンソールを使用してパッケージをインストールして管理する