Guida: Aggiungere .NET Aspire a un'app .NET esistente

Articolo
12/15/2024

Se hai microservizi esistenti e .NET app Web, puoi aggiungere .NET Aspire a questo e ottenere tutte le funzionalità e i vantaggi inclusi. In questo articolo si aggiunge .NET Aspire orchestrazione a un semplice progetto .NET 9 preesistente. Imparerete come:

Comprendere la struttura dell'app di microservizi esistente.
Registrare progetti esistenti nell'orchestrazione .NET.NET Aspire.
Comprendere le modifiche apportate dall'iscrizione nei progetti.
Avviare il progetto .NET.NET Aspire.

Prerequisiti

Per usare .NET.NET Aspire, è necessario che il codice seguente sia installato in locale:

.NET 8.0 o .NET 9.0
Un runtime container conforme a OCI, come ad esempio:
- Docker Desktop o Podman. Per ulteriori informazioni, vedere Runtime del container.
Un ambiente di sviluppo integrato (IDE) o un editor di codice, ad esempio:
- Visual Studio 2022 versione 17.9 o successiva (facoltativo)
- Visual Studio Code (facoltativo)
  - C# Dev Kit: Estensione (facoltativo)
- JetBrains Rider con .NET.NET Aspire plug-in (facoltativo)

Per altre informazioni, vedere .NET.NET Aspire configurazione e strumentie .NET.NET Aspire SDK.

Inizia

Iniziamo ottenendo il codice per la soluzione:

Aprire un prompt dei comandi e modificare le directory in cui archiviare il codice.

Per clonare la soluzione di esempio .NET 9, usare il comando seguente git clone:

git clone https://github.com/MicrosoftDocs/mslearn-dotnet-cloudnative-devops.git eShopLite

Esplorare l'app di esempio

Questo articolo usa una soluzione .NET 9 con tre progetti:

Entità dati: questo progetto è una libreria di classi di esempio. Definisce la classe Product usata nell'app Web e nell'API Web.
Products: questa API Web di esempio restituisce un elenco di prodotti nel catalogo e le relative proprietà.
Store: questo esempio di Blazor Web App visualizza il catalogo dei prodotti per i visitatori del sito web.

Aprire e avviare il debug del progetto per esaminarne il comportamento predefinito:

Avvia Visual Studio e quindi seleziona File>Apri>Progetto/Soluzione.
Passare alla cartella di primo livello della soluzione clonata, selezionare eShopLite.slne quindi selezionare Apri.
Nell'Esplora soluzioni , fare clic con il pulsante destro del mouse sulla soluzione eShopLite e quindi selezionare Configura progetti di avvio.
Selezionare Multipli progetti di avvio.
Nella colonna azione selezionare Avvia sia per i progetti Products che Store.
Selezionare OK.
Per avviare il debug della soluzione, premere F5 oppure selezionare Avvia.
Due pagine aperte nel browser:
- Una pagina visualizza i prodotti in formato JSON da una chiamata all'API Web dei Prodotti.
- Una pagina visualizza la home page del sito Web. Nel menu a sinistra selezionare Products per visualizzare il catalogo ottenuto dall'API Web.
Per arrestare il debug, chiudere il browser.

Avviare Visual Studio Code e aprire la cartella clonata. Dal terminale in cui è stato clonato il repository, eseguire il comando seguente:
```
code .
```
Selezionare la voce di menu Esegui e Debug, oppure premere Ctrl+Shift+D.
Selezionare il collegamento al file per creare un avvio.json

Copiare e incollare il seguente JSON in questo file e Salvare:

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"
        }
    ]
}

Per avviare il debug della soluzione, premere F5 oppure selezionare Avvia.
Due pagine aperte nel browser:
- Una pagina visualizza i prodotti in formato JSON da una chiamata all'API Web dei Prodotti.
- Una pagina visualizza la home page del sito Web. Nel menu a sinistra selezionare Products per visualizzare il catalogo ottenuto dall'API Web.
Per arrestare il debug, chiudere il browser e quindi selezionare il pulsante Arresta due volte (una per ogni istanza di debug in esecuzione).

Aprire una finestra del terminale e modificare le directory nel repository appena clonato.
Per avviare l'app Products , eseguire il comando seguente:
```
dotnet run --project ./Products/Products.csproj
```
Si apre una pagina del browser che mostra il JSON per i prodotti.
In una finestra del terminale separata modificare nuovamente le directory in repository clonato.
Avvia l'app dello Store eseguendo il comando seguente:
```
dotnet run --project ./Store/Store.csproj
```
Il browser apre una pagina che visualizza la home page del sito Web. Nel menu a sinistra selezionare Products per visualizzare il catalogo ottenuto dall'API Web.
Per arrestare il debug, chiudere il browser e premere CTRL+C in entrambi i terminali.

Aggiungere .NET.NET Aspire all'app Web dello Store

Ora, procediamo con l'iscrizione del progetto Store, che implementa l'interfaccia utente web, nell'orchestrazione .NET.NET Aspire:

In Visual Studio, nel Esplora soluzioni, fare clic con il pulsante destro del mouse sul progetto Store, selezionare Aggiungie quindi selezionare .NET.NET Aspire Supporto Orchestrator.
Nella finestra di dialogo Aggiungi .NET.NET Aspire Supporto orchestratore, selezionare OK.

È ora necessario avere due nuovi progetti, entrambi aggiunti alla soluzione:

eShopLite.AppHost: un progetto orchestratore progettato per connettere e configurare i diversi progetti e servizi della tua app. L'orchestratore è impostato come progetto di avvioe dipende dal progetto eShopLite.Store.
eShopLite.ServiceDefaults: un progetto condiviso .NET.NET Aspire per gestire le configurazioni riutilizzate nei progetti della soluzione correlati alla resilienza , all'individuazione dei servizi e alla telemetria .

Nel progetto eShopLite.AppHost, aprire il file . Si noti questa riga di codice, che registra il progetto Store nell'orchestrazione :

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

Per altre informazioni, vedere AddProject.

Per aggiungere il progetto Products a :

In Visual Studio, in Esplora Soluzioni , fare clic con il pulsante destro del mouse sul progetto Prodotti, selezionare Aggiungie quindi selezionare .NET.NET Aspire Supporto Orchestrator.
Finestra di dialogo che indica che il progetto Orchestrator .NET.NET Aspire esiste già, selezionare OK.

Nel progetto eShopLite.AppHost, aprire il file . Nota questa riga di codice, che registra il progetto Products nell'orchestrazione .NET.NET Aspire:

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

Si noti anche che il progetto di eShopLite.AppHost dipende ora sia dal store che dai progetti Products .

Creare un progetto di app host

Per orchestrare i progetti esistenti, è necessario creare un nuovo progetto host dell'app. Per creare un nuovo host dell'applicazione progetto dai modelli disponibili di .NET Aspire, usare il comando CLI .NET seguente:

dotnet new aspire-apphost -o eShopLite.AppHost

Aggiungere il progetto host dell'app alla soluzione esistente:

Unix
Windows

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

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

Aggiungere il progetto di Store come riferimento al progetto host dell'app usando il comando dell'interfaccia della riga di comando seguente:

Unix
Windows

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

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

Creare un progetto di impostazioni predefinite del servizio

Dopo aver creato il progetto host dell'app, è necessario creare un nuovo progetto di servizio predefinito . Per creare un nuovo servizio impostazioni predefinite progetto dai modelli di .NET Aspire disponibili, usare il comando .NET dell'interfaccia della riga di comando seguente:

dotnet new aspire-servicedefaults -o eShopLite.ServiceDefaults

Per aggiungere il progetto alla soluzione, usare il seguente comando .NET dell'interfaccia a riga di comando:

Unix
Windows

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

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

Aggiornare il progetto host dell'app per aggiungere un riferimento al progetto 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

Sia il progetto Store che Products devono fare riferimento al progetto dei valori predefiniti del servizio in modo che possano includere facilmente la scoperta dei servizi . Per aggiungere un riferimento al progetto predefinito del servizio nel progetto Store , usare il seguente comando CLI .NET:

Unix
Windows

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

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

Lo stesso comando con percorsi leggermente diversi dovrebbe essere usato per aggiungere un riferimento ai predefiniti del servizio nel progetto nel progetto 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

Nei progetti Store e Products, aggiornare i loro file di Program.cs, aggiungendo la riga seguente immediatamente dopo la riga var builder = WebApplication.CreateBuilder(args);.

builder.AddServiceDefaults();

Aggiornare il progetto host dell'app

Apri il file del progetto host dell'app e sostituisci i suoi contenuti con il seguente codice C#:

var builder = DistributedApplication.CreateBuilder(args);

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

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

builder.Build().Run();

Il codice precedente:

Crea una nuova istanza di DistributedApplicationBuilder.
Aggiunge il progetto Store all'orchestratore.
Aggiunge il progetto Products all'orchestratore.
Compila e esegue l'orchestratore.

Individuazione dei servizi

A questo punto, entrambi i progetti fanno parte dell'orchestrazione , ma l' dello Store deve essere in grado di individuare l'indirizzo back-end products tramite l'individuazione dei servizi di . Per abilitare l'individuazione dei servizi, aprire il file Program.cs in eShopLite.AppHost e aggiornare il codice che il Store aggiunge come riferimento al progetto Products.

var builder = DistributedApplication.CreateBuilder(args);

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

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

builder.Build().Run();

Il codice precedente esprime che il progetto di Store dipende dal progetto Products. Per ulteriori informazioni, consultare l'host dell'app .NET.NET Aspire: Risorse di riferimento. Questo riferimento viene usato per individuare l'indirizzo del progetto Products. Inoltre, il progetto Store è configurato per utilizzare endpoint HTTP esterni. Se in un secondo momento si sceglie di distribuire questa app, è necessario effettuare la chiamata a WithExternalHttpEndpoints per assicurarsi che sia pubblico verso l'esterno.

Aggiorna quindi il appsettings.json nel progetto store con il seguente JSON:

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

Gli indirizzi per entrambi gli endpoint ora usano il nome "products" aggiunto all'orchestratore nell'host dell'app . Questi nomi vengono usati per individuare l'indirizzo del progetto Products.

Esplora l'app iscritta

Iniziamo la soluzione ed esaminiamo il nuovo comportamento che .NET.NET Aspire offre.

Nota

Si noti che il progetto eShopLite.AppHost è il nuovo progetto di avvio.

In Visual Studio, per avviare il debug, premere F5Visual Studio compila i progetti.
Se viene visualizzata la finestra di dialogo Start Docker Desktop, selezionare Sì. Visual Studio avvia il motore di Docker e crea i contenitori necessari. Al termine della distribuzione, viene visualizzato il dashboard .NET.NET Aspire.
Nella dashboard, selezionare l'endpoint per il progetto dei prodotti . Viene visualizzata una nuova scheda del browser e viene visualizzato il catalogo prodotti in formato JSON.
Nel pannello di controllo, selezionare l'endpoint per il progetto del negozio . Quando si apre una nuova scheda del browser, viene visualizzata la home page dell'app web.
Nel menù a sinistra selezionare Prodotti. Viene visualizzato il catalogo prodotti.
Per arrestare il debug, chiudere il browser.

Eliminare il lancio e il filejson che hai creato in precedenza, non serve più a nessuno scopo. Avviare invece il progetto host dell'app , che orchestra gli altri progetti:

Avviare il progetto di host dell'app facendo clic con il pulsante destro del mouse sul progetto di eShopLite.AppHost nel Esplora soluzioni e selezionando DebugAvvia nuova istanza:

Nota

Se Docker Desktop (o Podman) non è in esecuzione, si verifica un errore. Avviare il motore contenitore conforme a OCI e riprovare.

Avvia il progetto host dell'app eseguendo il comando seguente:
```
dotnet run --project ./eShopLite.AppHost/eShopLite.AppHost.csproj
```
Nota

Se Docker Desktop (o Podman) non è in esecuzione, si verifica un errore. Avviare il motore contenitore conforme a OCI e riprovare.

Nella dashboard, selezionare l'endpoint per il progetto dei prodotti . Viene visualizzata una nuova scheda del browser e viene visualizzato il catalogo prodotti in formato JSON.
Nel pannello di controllo, selezionare l'endpoint per il progetto del negozio . Quando si apre una nuova scheda del browser, viene visualizzata la home page dell'app web.
Nel menù a sinistra selezionare Prodotti. Viene visualizzato il catalogo prodotti.
Per arrestare il debug, chiudere il browser.

Congratulazioni, hai aggiunto l'orchestrazione .NET.NET Aspire alla tua app Web preesistente. È ora possibile aggiungere integrazioni .NET Aspire e usare gli strumenti .NET Aspire per semplificare lo sviluppo di app Web native del cloud.

Condividi tramite