Tutorial: Menyambungkan aplikasi ASP.NET Core ke integrasi penyimpanan .NET Aspire

Untuk artikel ini, Anda memerlukan akses kontributor data ke akun Azure Storage dengan kontainer blob dan antrean penyimpanan. Pastikan Anda memiliki sumber daya dan konfigurasi berikut yang tersedia:

Untuk artikel ini, Anda harus membuat kontainer blob dan sumber daya antrean penyimpanan di lingkungan pengembangan lokal Anda menggunakan emulator. Untuk melakukannya, gunakan Azurite. Azurite adalah server yang kompatibel dengan API Penyimpanan (emulator) gratis, sumber terbuka, lintas platform Azure storage yang berjalan dalam kontainer Docker.

Untuk menggunakan emulator, Anda perlu menginstal Azurite.

1. Akun Penyimpanan Azure - Membuat akun penyimpanan.
2. Kontainer Blob Storage bernama fileuploads - Membuat kontainer penyimpanan blob.
3. Sebuah Antrian Penyimpanan bernama tiket - Membuat antrian penyimpanan.

Jalankan perintah berikut di Azure CLI atau CloudShell untuk menyiapkan sumber daya Azure Storage yang diperlukan:

az group create --name aspirestorage --location eastus2
az storage account create -n aspirestorage -g aspirestorage -l eastus2
az storage container create -n fileuploads --account-name aspirestorage
az storage queue create -n tickets --account-name aspirestorage

Anda juga perlu menetapkan peran berikut kepada akun pengguna yang Anda gunakan untuk masuk ke Visual Studio:

• Kontributor Data Blob Penyimpanan - Menetapkan peran RBAC Azure
• Kontributor Data Antrean Penyimpanan - Menetapkan peran RBAC Azure

Azure Developer CLI memungkinkan Anda menyediakan dan menyebarkan sumber daya Azure menggunakan sistem templat. Tutorial ini menyediakan templat lengkap yang menyediakan sumber daya yang diperlukan dan menyertakan kode aplikasi sampel yang telah selesai. Jalankan perintah berikut untuk menginisialisasi dan menjalankan templat:

1. Jalankan azd auth login untuk masuk ke Azure:

   azd auth login
   

2. Jalankan azd init untuk mengkloning dan menginisialisasi templat sampel:

   azd init --template dotnet-aspire-connect-storage
   

3. Jalankan azd up untuk menyediakan sumber daya Azure:

   azd up
   

4. Saat diminta, pilih langganan dan wilayah Azure untuk sumber daya yang disediakan. Templat menjalankan dan menyelesaikan tugas berikut untuk Anda:

   • Membuat Akun Penyimpanan Azure dengan layanan blob dan antrean diaktifkan
   • Membuat kontainer penyimpanan blob bernama fileUploads
   • Membuat antrian bernama tickets
   • Menetapkan peran berikut ke akun pengguna yang menjalankan templat.
     • Kontributor Data Blob Penyimpanan
     • Kontributor Data Antrian Penyimpanan

Setelah operasi berhasil diselesaikan, Anda memiliki dua opsi bergerak maju:

• Opsi 1: Jalankan aplikasi sampel .NET di templat src direktori untuk bereksperimen dengan aplikasi yang telah selesai.
• Opsi 2: Buat aplikasi sampel langkah demi langkah menggunakan bagian di depan dan sambungkan ke sumber daya Azure yang disediakan oleh azd.

using AspireStorage.Web;
using AspireStorage.Web.Components;

using Azure.Storage.Blobs;
using Azure.Storage.Queues;

var builder = WebApplication.CreateBuilder(args);

builder.AddAzureBlobClient("BlobConnection");
builder.AddAzureQueueClient("QueueConnection");

// Add service defaults & Aspire components.
builder.AddServiceDefaults();

// Add services to the container.
builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents();

builder.Services.AddOutputCache();

builder.Services.AddHttpClient<WeatherApiClient>(client =>
    {
        // This URL uses "https+http://" to indicate HTTPS is preferred over HTTP.
        // Learn more about service discovery scheme resolution at https://aka.ms/dotnet/sdschemes.
        client.BaseAddress = new("https+http://apiservice");
    });

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error", createScopeForErrors: true);
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}
else
{
    // In development, create the blob container and queue if they don't exist.
    var blobService = app.Services.GetRequiredService<BlobServiceClient>();
    var docsContainer = blobService.GetBlobContainerClient("fileuploads");

    await docsContainer.CreateIfNotExistsAsync();

    var queueService = app.Services.GetRequiredService<QueueServiceClient>();
    var queueClient = queueService.GetQueueClient("tickets");

    await queueClient.CreateIfNotExistsAsync();
}

app.UseHttpsRedirection();

app.UseStaticFiles();
app.UseAntiforgery();

app.UseOutputCache();

app.MapRazorComponents<App>()
    .AddInteractiveServerRenderMode();

app.MapDefaultEndpoints();

app.Run();

using AspireStorage.Web;
using AspireStorage.Web.Components;

using Azure.Storage.Blobs;
using Azure.Storage.Queues;

var builder = WebApplication.CreateBuilder(args);

builder.AddAzureBlobClient("BlobConnection");
builder.AddAzureQueueClient("QueueConnection");

// Add service defaults & Aspire components.
builder.AddServiceDefaults();

// Add services to the container.
builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents();

builder.Services.AddOutputCache();

builder.Services.AddHttpClient<WeatherApiClient>(client =>
    {
        // This URL uses "https+http://" to indicate HTTPS is preferred over HTTP.
        // Learn more about service discovery scheme resolution at https://aka.ms/dotnet/sdschemes.
        client.BaseAddress = new("https+http://apiservice");
    });

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error", createScopeForErrors: true);
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseStaticFiles();
app.UseAntiforgery();

app.UseOutputCache();

app.MapRazorComponents<App>()
    .AddInteractiveServerRenderMode();

app.MapDefaultEndpoints();

app.Run();

Ketika proyek AspireStorage.Web dimulai, proyek tersebut akan membuat kontainer di Azurite Blob Storage dan antrean di Azurite Queue Storage. Ini kondisional saat aplikasi berjalan di lingkungan pengembangan. Saat aplikasi berjalan di lingkungan produksi, kontainer dan antrean diasumsikan telah dibuat.

using Microsoft.Extensions.Hosting;

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("Storage");

if (builder.Environment.IsDevelopment())
{
    storage.RunAsEmulator();
}

var blobs = storage.AddBlobs("BlobConnection");
var queues = storage.AddQueues("QueueConnection");

var apiService = builder.AddProject<Projects.AspireStorage_ApiService>("apiservice");

builder.AddProject<Projects.AspireStorage_Web>("webfrontend")
    .WithExternalHttpEndpoints()
    .WithReference(apiService)
    .WithReference(blobs)
    .WithReference(queues); 

builder.AddProject<Projects.AspireStorage_WorkerService>("aspirestorage-workerservice")
    .WithReference(queues);

builder.Build().Run();

Kode sebelumnya menambahkan penyimpanan, blob, dan antrean Azure, dan saat dalam mode pengembangan, kode tersebut menggunakan emulator. Setiap proyek mendefinisikan referensi untuk sumber daya ini yang bergantung padanya.

using Microsoft.Extensions.Hosting;

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("Storage");

var blobs = storage.AddBlobs("BlobConnection");
var queues = storage.AddQueues("QueueConnection");

var apiService = builder.AddProject<Projects.AspireStorage_ApiService>("apiservice");

builder.AddProject<Projects.AspireStorage_Web>("webfrontend")
    .WithExternalHttpEndpoints()
    .WithReference(apiService)
    .WithReference(blobs)
    .WithReference(queues); 

builder.AddProject<Projects.AspireStorage_WorkerService>("aspirestorage-workerservice")
    .WithReference(queues);

builder.Build().Run();

Kode sebelumnya menambahkan penyimpanan, blob, dan antrean Azure, dan menentukan referensi untuk sumber daya ini dalam setiap proyek yang bergantung padanya.

using Azure.Storage.Queues;
using Azure.Storage.Queues.Models;

namespace AspireStorage.WorkerService;

public sealed class WorkerService(
    QueueServiceClient client,
    ILogger<WorkerService> logger) : BackgroundService
{
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        var queueClient = client.GetQueueClient("tickets");
        await queueClient.CreateIfNotExistsAsync(cancellationToken: stoppingToken);

        while (!stoppingToken.IsCancellationRequested)
        {
            QueueMessage[] messages =
                await queueClient.ReceiveMessagesAsync(
                    maxMessages: 25, cancellationToken: stoppingToken);

            foreach (var message in messages)
            {
                logger.LogInformation(
                    "Message from queue: {Message}", message.MessageText);

                await queueClient.DeleteMessageAsync(
                    message.MessageId,
                    message.PopReceipt,
                    cancellationToken: stoppingToken);
            }

            // TODO: Determine an appropriate time to wait 
            // before checking for more messages.
            await Task.Delay(TimeSpan.FromSeconds(15), stoppingToken);
        }
    }
}

Sebelum layanan pekerja dapat memproses pesan, layanan tersebut harus dapat tersambung ke antrean penyimpanan Azure. Dengan Azurite, Anda perlu memastikan bahwa antrean pesan tersedia sebelum layanan pekerja mulai menjalankan pemrosesan antrean pesan.

using Azure.Storage.Queues;
using Azure.Storage.Queues.Models;

namespace AspireStorage.WorkerService;

public sealed class WorkerService(
    QueueServiceClient client,
    ILogger<WorkerService> logger) : BackgroundService
{
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        var queueClient = client.GetQueueClient("tickets");
        while (!stoppingToken.IsCancellationRequested)
        {
            QueueMessage[] messages =
                await queueClient.ReceiveMessagesAsync(
                    maxMessages: 25, cancellationToken: stoppingToken);

            foreach (var message in messages)
            {
                logger.LogInformation(
                    "Message from queue: {Message}", message.MessageText);

                await queueClient.DeleteMessageAsync(
                    message.MessageId,
                    message.PopReceipt,
                    cancellationToken: stoppingToken);
            }

            // TODO: Determine an appropriate time to wait 
            // before checking for more messages.
            await Task.Delay(TimeSpan.FromSeconds(15), stoppingToken);
        }
    }
}

Layanan pekerja memproses pesan dengan menghubungkan ke antrean penyimpanan Azure, dan mengambil pesan dari antrean tersebut.

Mengonfigurasi string koneksi

Proyek AspireStorage dan AspireStorage.Worker harus dikonfigurasi untuk tersambung ke Akun Penyimpanan yang benar yang Anda buat sebelumnya. Anda dapat menentukan titik akhir untuk layanan blob dan antrean di akun penyimpanan menggunakan file appsettings.json di setiap proyek.

1. Dalam proyek AspireStorage, tambahkan konfigurasi berikut ke file appsettings.Development.json:

     "ConnectionStrings": {
       "BlobConnection": "https://<your-storage-account-name>.blob.core.windows.net/",
       "QueueConnection": "https://<your-storage-account-name>.queue.core.windows.net/"
     }
   

2. Dalam proyek AspireStorage.Worker, tambahkan konfigurasi berikut ke file :

     "ConnectionStrings": {
       "QueueConnection": "https://<your-storage-account-name>.queue.core.windows.net/"
     }
   

Karena Anda memilih untuk menggunakan Azurite, Anda tidak perlu membersihkan sumber daya ini ketika Anda selesai mengujinya, saat Anda membuatnya secara lokal dalam konteks emulator. Emulator memungkinkan Anda menguji aplikasi secara lokal tanpa dikenakan biaya apa pun, karena tidak ada sumber daya Azure yang disediakan atau dibuat.

Membersihkan sumber daya

Jalankan perintah CLI Azure berikut untuk menghapus grup sumber daya saat Anda tidak lagi memerlukan sumber daya Azure yang Anda buat. Menghapus grup sumber daya juga menghapus sumber daya yang terkandung di dalamnya.

az group delete --name <your-resource-group-name>

Untuk informasi selengkapnya, lihat Membersihkan sumber daya di Azure.