クイック スタート: Visual Studio で NuGet パッケージをインストールして使用する (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 パッケージの検索と評価」を参照してください。

前提条件

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

    2022 Community エディションは、visualstudio.microsoft.com から無料でインストールすることも、Professional または Enterprise エディションを使用することもできます。

プロジェクトの作成

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

次の手順のようにします。

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

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

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

  4. [追加情報] ウィンドウで、Framework の .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] を選択します。

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

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

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

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

    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. [クリックする] ボタンを選択すると、JSON テキストに置き換えられたオブジェクトのTextBlock内容が表示されます。

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

関連項目

NuGet の詳細については、次の記事を参照してください。

次のステップ

初めての NuGet パッケージのインストールと使用はこれで完了です。 NuGet パッケージのインストールと管理の詳細については、次の記事に進んでください。

NuGet パッケージ マネージャーを使用してパッケージをインストールおよび管理する

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