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

NuGet パッケージには、他の開発者がお客様のプロジェクトで使用できるようにした、再利用可能なコードが含まれます。 背景については、NuGet の紹介に関するページを参照してください。 パッケージは NuGet パッケージ マネージャー、パッケージ マネージャー コンソール、または dotnet CLI を使用して、Visual Studio プロジェクトにインストールされます。 この記事では、よく使用されている Newtonsoft.Json パッケージと Windows Presentation Foundation (WPF) プロジェクトを使用したプロセスを示します。 同じプロセスは、他の任意の .NET または .NET Core プロジェクトにも適用されます。

インストール後、using <namespace> でコード内のパッケージを参照します。<namespace> は、使用しているパッケージに固有です。 参照が行われたら、その API からパッケージを呼び出すことができます。

ヒント

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

必須コンポーネント

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

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

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

プロジェクトを作成する

NuGet パッケージは任意の .NET プロジェクトにインストールできます。ただし、パッケージが同じターゲット フレームワークをプロジェクトとしてサポートしていることが条件です。

このチュートリアルでは、単純な WPF アプリを使用します。 [ファイル] > [新しいプロジェクト] を使用し、検索ボックスに「 .NET」と入力して、 [WPF アプリ (.NET Framework)] を選択し、Visual Studio にプロジェクトを作成します。 [次へ] をクリックします。 プロンプトが表示されたら、 [フレームワーク] の既定値をそのまま受け入れます。

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

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

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

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

  1. ソリューション エクスプローラーで [参照] を右クリックし、 [NuGet パッケージの管理] をクリックします。

    プロジェクト参照の NuGet パッケージ管理コマンド

  2. [パッケージ ソース] として "nuget.org" を選択し、 [参照] タブを選択し、「Newtonsoft.Json」を検索し、一覧からそのパッケージを選択し、 [インストール] を選択します。

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

    NuGet パッケージ マネージャーについて詳しくは、Visual Studio を使用したパッケージのインストールおよび管理に関するページをご覧ください。

  3. ラインセンス プロンプトに同意します。

  4. (Visual Studio 2017 のみ) パッケージ管理の形式を選択するように求められたら、 [プロジェクト ファイルの PackageReference] を選択します。

    パッケージ管理形式の選択

  5. 変更の確認を求められた場合、 [OK] を選択します。

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

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

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

    パッケージ用のプロジェクトを選択します

  3. コマンド Install-Package Newtonsoft.Json を入力します (「Install-Package」を参照してください)。 コンソール ウィンドウに、このコマンドの出力が表示されます。 通常、エラーは、パッケージがプロジェクトのターゲット フレームワークと互換性がないことを示します。

    パッケージ マネージャー コンソールについて詳しくは、パッケージ マネージャー コンソールを使用したパッケージのインストールおよび管理に関するページをご覧ください。

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

プロジェクトに Newtonsoft.Json パッケージがある場合、その JsonConvert.SerializeObject メソッドを呼び出し、オブジェクトを人間が読める文字列に変換できます。

  1. MainWindow.xamlを開いて、既存の Grid 要素を次の XAML に置き換えます。

    <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, Formatting.Indented);
        TextBlock.Text = json;
    }
    
  3. プロジェクトに Newtonsoft.Json パッケージを追加した後でも、JsonConvert の下に赤い波線が表示されます。これは、コード ファイルの上部に using ステートメントが必要であるためです。

    using Newtonsoft.Json;
    
  4. アプリをビルドして実行します。F5 キーを押すか、 [デバッグ] > [デバッグの開始] を選択してください。

    WPF アプリの最初の出力

  5. ボタンを選択し、TextBlock の内容が JSON テキストに置換されたことを確認します。

    ボタンを選択した後の WPF アプリの出力

他の NuGet ビデオは、Channel 9 および YouTube でご覧いただけます。

次の手順

無事に、最初の NuGet パッケージをインストールして使用できるようになりました。

NuGet による提供についてさらに詳しく調べるには、下のリンクを選択してください。