チュートリアル: 既存の .NET Aspire アプリに .NET を追加する

[アーティクル]
12/19/2024

既存のマイクロサービスと .NET Web アプリがある場合は、それに .NET Aspire を追加し、含まれるすべての機能と利点を取得できます。この記事では、.NET Aspire オーケストレーションを単純で既存の .NET 9 プロジェクトに追加します。次の方法について学習します。

既存のマイクロサービスアプリの構造を理解します。
既存のプロジェクトを.NET.NET Aspireオーケストレーションに登録します。
登録がプロジェクトで行う変更について説明します。
.NET .NET Aspire プロジェクトを開始します。

前提条件

.NET .NET Aspireを使用するには、次のものがローカルにインストールされている必要があります。

.NET 8.0 または .NET 9.0
OCI 準拠のコンテナーランタイム。次に例を示します。
- デスクトップまたははする。詳細については、「コンテナーのランタイム」を参照してください。
次のような統合開発者環境 (IDE) またはコードエディター。
- Visual Studio 2022 バージョン 17.9 以降 (任意)
- Visual Studio Code (省略可能)
  - C# Dev Kit: 拡張 (省略可能)
- JetBrains Rider と .NET.NET Aspire プラグイン（オプション）

詳細については、セットアップとツールの、および SDK を参照してください。

作業の開始

まず、ソリューションのコードを取得します。

コマンドプロンプトを開き、コードを格納する場所にディレクトリを変更します。
.NET 9 のソリューション例を複製するには、次の git clone コマンドを使用します。
```
git clone https://github.com/MicrosoftDocs/mslearn-dotnet-cloudnative-devops.git eShopLite
```

サンプルアプリを調べる

この記事では、3 つのプロジェクトを含む .NET 9 ソリューションを使用します。

データエンティティ: このプロジェクトはクラスライブラリの例です。 Web アプリと Web API で使用される Product クラスを定義します。
Products: この例の Web API は、カタログ内の製品とそのプロパティの一覧を返します。
ストア: この例 Blazor Web App は、Web サイトの訪問者に製品カタログを表示します。

プロジェクトを開いてデバッグを開始し、既定の動作を確認します。

Visual Studio を起動し、次に [ファイル>開く>プロジェクト/ソリューション] を選択します。
複製したソリューションの最上位フォルダーに移動し、[eShopLite.sln] を選択し、[を開く] 選択します。
ソリューションエクスプローラーで、eShopLite ソリューションを右クリックし、[スタートアッププロジェクトの構成]選択します。
複数のスタートアッププロジェクトを選択します。
[アクション] 列で、Products プロジェクトと Store プロジェクトの両方の「開始」として [開始] を選択します。
[OK] を選択.
ソリューションのデバッグを開始するには、F5 押すか、[スタート]選択します。
ブラウザーで次の 2 つのページが開きます。
- ページは、Products Web APIの呼び出しから受け取った製品を、JSON形式で表示します。
- ページには、Web サイトのホームページが表示されます。左側のメニューで、[製品選択して、Web API から取得したカタログを表示します。
デバッグを停止するには、ブラウザーを閉じます。

Visual Studio Code を開始し、複製したフォルダーを開きます。リポジトリを複製したターミナルから、次のコマンドを実行します。
```
code .
```
実行とデバッグ メニュー項目を選択するか、Ctrl+と+Shiftを押しながら D を押します。
「起動を作成」json をします。

次の JSON をコピーしてこのファイルに貼り付け、保存します。

Unix
Windows の

{
    "version": "0.2.0",
    "compounds": [
        {
            "name": "Run all",
            "configurations": [
                "Run products",
                "Run store",
            ]
        }
    ],
    "configurations": [
        {
            "name": "Run products",
            "type": "dotnet",
            "request": "launch",
            "projectPath": "${workspaceFolder}/Products/Products.csproj"
        },
        {
            "name": "Run store",
            "type": "dotnet",
            "request": "launch",
            "projectPath": "${workspaceFolder}/Store/Store.csproj"
        }
    ]
}

{
    "version": "0.2.0",
    "compounds": [
        {
            "name": "Run all",
            "configurations": [
                "Run products",
                "Run store",
            ]
        }
    ],
    "configurations": [
        {
            "name": "Run products",
            "type": "dotnet",
            "request": "launch",
            "projectPath": "${workspaceFolder}\\Products\\Products.csproj"
        },
        {
            "name": "Run store",
            "type": "dotnet",
            "request": "launch",
            "projectPath": "${workspaceFolder}\\Store\\Store.csproj"
        }
    ]
}

ソリューションのデバッグを開始するには、F5 押すか、[スタート]選択します。
ブラウザーで次の 2 つのページが開きます。
- ページは、Products Web APIの呼び出しから受け取った製品を、JSON形式で表示します。
- ページには、Web サイトのホームページが表示されます。左側のメニューで、[製品選択して、Web API から取得したカタログを表示します。
デバッグを停止するには、ブラウザーを閉じ、[ 停止] ボタンを 2 回選択します (実行中のデバッグインスタンスごとに 1 回)。

ターミナルウィンドウを開き、新しく複製されたリポジトリにディレクトリを変更します。
Products アプリを起動するには、次のコマンドを実行します。
```
dotnet run --project ./Products/Products.csproj
```
ブラウザーページが開き、製品の JSON が表示されます。
別のターミナルウィンドウで、もう一度ディレクトリを複製されたリポジトリに変更します。
次のコマンドを実行して、ストア アプリを起動します。
```
dotnet run --project ./Store/Store.csproj
```
ブラウザーで、Web サイトのホームページを表示するページが開きます。左側のメニューで、[製品選択して、Web API から取得したカタログを表示します。
デバッグを停止するには、ブラウザーを閉じ、両方のターミナル Ctrl+C を押します。

ストア Web アプリに .NET.NET Aspire を追加する

次に、Web ユーザーインターフェイスを実装する Store プロジェクトをオーケストレーション .NET.NET Aspire 登録します。

のソリューションエクスプローラーで、ストアプロジェクトを右クリックし、[の追加] 選択し、[Orchestrator サポート選択します。
[ Orchestrator サポートの追加] ダイアログで、[OK ] を選択します。

これで、次の 2 つの新しいプロジェクトがソリューションに追加されます。

eShopLite.AppHost: アプリのさまざまなプロジェクトとサービスに接続して構成するように設計されたオーケストレータープロジェクト。オーケストレーターは、スタートアッププロジェクトとして設定され、eShopLite.Store プロジェクトによって異なります。
eShopLite.ServiceDefaults: ソリューション内のプロジェクト全体で再利用される構成を管理するための共有プロジェクトで、回復性、サービス検出、テレメトリ関連します。

eShopLite.AppHost プロジェクトで、Program.cs ファイルを開きます。 .NET オーケストレーションに .NET Aspire プロジェクトを登録する次のコード行に注目してください。

builder.AddProject<Projects.Store>("store");

詳細については、AddProjectを参照してください。

Products プロジェクトを .NET.NET Aspireに追加するには:

Visual Studioの ソリューションエクスプローラー内で、Products プロジェクトを右クリックし、[追加]を選択し、[.NETOrchestrator サポート.NET Aspire]を選択します。
Orchestrator プロジェクト .NET.NET Aspire が既に存在することを示すダイアログボックスで、OKを選択します。

builder.AddProject<Projects.Products>("products");

また、eShopLite.AppHost プロジェクトは、ストア と Products プロジェクトの両方に依存していることにも注目してください。

アプリホストプロジェクトを作成する

既存のプロジェクトを調整するには、新しい アプリホスト プロジェクトを作成する必要があります。使用可能なテンプレートから新しい .NET Aspire を作成するには、次の .NET CLI コマンドを使用します。

dotnet new aspire-apphost -o eShopLite.AppHost

アプリホスト プロジェクトを既存のソリューションに追加します。

Unix
Windows の

dotnet sln ./eShopLite.sln add ./eShopLite.AppHost/eShopLite.AppHost.csproj

dotnet sln .\eShopLite.sln add .\eShopLite.AppHost\eShopLite.AppHost.csproj

次の CLI コマンドを使用して、プロジェクト参照として Store プロジェクトを .NET プロジェクトに追加します。

Unix
Windows の

dotnet add ./eShopLite.AppHost/eShopLite.AppHost.csproj reference ./Store/Store.csproj

dotnet add .\eShopLite.AppHost\eShopLite.AppHost.csproj reference .\Store\Store.csproj

サービスの既定のプロジェクトを作成する

アプリホストプロジェクトが作成されたら、新しい サービスの既定値 プロジェクトを作成する必要があります。使用可能なテンプレートからプロジェクト新しいサービスの既定値を作成するには、次の CLI コマンドを使用します。

dotnet new aspire-servicedefaults -o eShopLite.ServiceDefaults

ソリューションにプロジェクトを追加するには、次の .NET CLI コマンドを使用します。

Unix
Windows の

dotnet sln ./eShopLite.sln add ./eShopLite.ServiceDefaults/eShopLite.ServiceDefaults.csproj

dotnet sln .\eShopLite.sln add .\eShopLite.ServiceDefaults\eShopLite.ServiceDefaults.csproj

アプリホスト プロジェクトを更新して、プロジェクト参照を Products プロジェクトに追加します。

Unix
Windows の

dotnet add ./eShopLite.AppHost/eShopLite.AppHost.csproj reference ./Products/Products.csproj

dotnet add .\eShopLite.AppHost\eShopLite.AppHost.csproj reference .\Products\Products.csproj

Store プロジェクトと Products プロジェクトの両方で、サービスの既定値プロジェクトを参照して、サービス検出簡単に含める必要があります。 サービスの既定 プロジェクトへの参照を Store プロジェクトに追加するには、次の .NET CLI コマンドを使用します。

Unix
Windows の

dotnet add ./Store/Store.csproj reference ./eShopLite.ServiceDefaults/eShopLite.ServiceDefaults.csproj

dotnet add .\Store\Store.csproj reference .\eShopLite.ServiceDefaults\eShopLite.ServiceDefaults.csproj

少し異なるパスを持つ同じコマンドを使用して、Products プロジェクトの サービスの既定 プロジェクトへの参照を追加する必要があります。

Unix
Windows の

dotnet add ./Products/Products.csproj reference ./eShopLite.ServiceDefaults/eShopLite.ServiceDefaults.csproj

dotnet add .\Products\Products.csproj reference .\eShopLite.ServiceDefaults\eShopLite.ServiceDefaults.csproj

Store と Products プロジェクトの両方で、Program.cs ファイルを更新し、var builder = WebApplication.CreateBuilder(args); 行の直後に次の行を追加します。

builder.AddServiceDefaults();

アプリホストプロジェクトを更新する

Program.cs プロジェクトのファイルを開き、その内容を次の C# コードに置き換えます。

var builder = DistributedApplication.CreateBuilder(args);

builder.AddProject<Projects.Store>("store");

builder.AddProject<Projects.Products>("products");

builder.Build().Run();

上記のコード:

新しい DistributedApplicationBuilder インスタンスを作成します。
オーケストレーターに Store プロジェクトを追加します。
Products プロジェクトをオーケストレーターに追加します。
オーケストレーターをビルドして実行します。

サービスの検出

この時点で、両方のプロジェクトは .NET.NET Aspire オーケストレーションの一部ですが、ストア は、.NET Aspireを通じて、Products バックエンドアドレスを検出できる必要があります。サービスの検出を有効にするには、Program.cs でファイルを開き、ストア が Products プロジェクトへの参照を追加するコードを更新します。

var builder = DistributedApplication.CreateBuilder(args);

var products = builder.AddProject<Projects.Products>("products");

builder.AddProject<Projects.Store>("store")
       .WithExternalHttpEndpoints()
       .WithReference(products);

builder.Build().Run();

上記のコードは、Store プロジェクトが Products プロジェクトに依存していることを表しています。詳細については、「.NET.NET Aspire アプリホスト: リソースを参照する」を参照してください。このリファレンスは、Products プロジェクトのアドレスを検出するために使用されます。さらに、ストア プロジェクトは、外部 HTTP エンドポイントを使用するように構成されています。後でこのアプリをデプロイする場合は、外部に公開されるように、WithExternalHttpEndpoints の呼び出しが必要になります。

次に、appsettings.json プロジェクトのを次の JSONで更新します。

{
  "DetailedErrors": true,
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ProductEndpoint": "http://products",
  "ProductEndpointHttps": "https://products"
}

両方のエンドポイントのアドレスで、アプリホストのオーケストレーターに追加された "products" 名が使用されるようになりました。これらの名前は、Products プロジェクトのアドレスを検出するために使用されます。

登録されているアプリを調べる

ソリューションを開始し、.NET.NET Aspire が提供する新しい動作を調べてみましょう。

手記

eShopLite.AppHost プロジェクトが新しいスタートアッププロジェクトであることに注意してください。

Visual Studioで、デバッグを開始するには、F5 キー 押してプロジェクトVisual Studio ビルドします。
[デスクトップ開始]ダイアログボックスが表示されたら、[はい]選択します。 Visual Studio Docker エンジンを起動し、必要なコンテナーを作成します。デプロイが完了すると、.NET.NET Aspire ダッシュボードが表示されます。
ダッシュボードで、製品の プロジェクトのエンドポイントを選択します。新しいブラウザータブが表示され、製品カタログが JSON 形式で表示されます。
ダッシュボードで、ストア プロジェクトのエンドポイントを選択します。新しいブラウザータブが表示され、Web アプリのホームページが表示されます。
左側のメニューで、製品を選択します。製品カタログが表示されます。
デバッグを停止するには、ブラウザーを閉じます。

起動を削除します。前に作成したファイルjson、目的を果たさなくなりました。代わりに、アプリホスト プロジェクトを開始し、他のプロジェクトを調整します。

ソリューションエクスプローラーで eShopLite.AppHost プロジェクトを右クリックし、[デバッグ][新しいインスタンスの開始]選択して、アプリホストプロジェクトを起動します。

手記

Docker Desktop (または Podman) が実行されていない場合は、エラーが発生します。 OCI 準拠のコンテナーエンジンを起動し、もう一度やり直してください。

次のコマンドを実行して、アプリホスト プロジェクトを起動します。
```
dotnet run --project ./eShopLite.AppHost/eShopLite.AppHost.csproj
```
手記

Docker Desktop (または Podman) が実行されていない場合は、エラーが発生します。 OCI 準拠のコンテナーエンジンを起動し、もう一度やり直してください。

ダッシュボードで、製品の プロジェクトのエンドポイントを選択します。新しいブラウザータブが表示され、製品カタログが JSON 形式で表示されます。
ダッシュボードで、ストア プロジェクトのエンドポイントを選択します。新しいブラウザータブが表示され、Web アプリのホームページが表示されます。
左側のメニューで、製品を選択します。製品カタログが表示されます。
デバッグを停止するには、ブラウザーを閉じます。

おめでとうございます。あなたは既存の Web アプリに .NET.NET Aspire オーケストレーションを追加しました。 .NET Aspire 統合を追加し、.NET Aspire ツールを使用して、クラウドネイティブの Web アプリ開発を効率化できるようになりました。

次の方法で共有

チュートリアル: 既存の .NET Aspire アプリに .NET を追加する

前提条件

作業の開始

サンプルアプリを調べる

ストア Web アプリに .NET.NET Aspire を追加する

アプリホストプロジェクトを作成する

サービスの既定のプロジェクトを作成する

アプリホストプロジェクトを更新する

サービスの検出

登録されているアプリを調べる

その他のリソース

次の方法で共有

チュートリアル: 既存の .NET Aspire アプリに .NET を追加する

前提 条件

作業の開始

サンプル アプリを調べる

ストア Web アプリに .NET.NET Aspire を追加する

アプリ ホスト プロジェクトを作成する

サービスの既定のプロジェクトを作成する

アプリ ホスト プロジェクトを更新する

サービスの検出

登録されているアプリを調べる

その他のリソース

前提条件

サンプルアプリを調べる

アプリホストプロジェクトを作成する

アプリホストプロジェクトを更新する