Quando dobbiamo restituire una risposta particolarmente lunga, costituita da una collection di elementi, una delle possibili opzioni è quella di restituirla sotto forma di uno stream. Il beneficio di questo approccio è che un client possa effettuare un download progressivo della risposta, senza dover attendere che il server abbia finito di generarla.

Si tratta, in buona sostanza, di della stessa tecnica utilizzata per simulare push notification dal server verso il client tramite Server Sient Events (SSE).

La buona notizia è che tutto ciò che dobbiamo fare in ASP.NET Core per implementarla, è quella di creare un endpoint Web API che restituisca un IAsyncEnumerable. Per esempio, possiamo modificare il classico WeatherForecast endpoint del template di default di Visual Studio nel modo seguente:

[HttpGet]
public async IAsyncEnumerable<WeatherForecast> Get()
{
    for (int i = 0; i < 20; i++)
    {
        await Task.Delay(1000);

        yield return new WeatherForecast
        {
            Date = DateTime.Now.AddDays(i),
            TemperatureC = Random.Shared.Next(-20, 55),
            Summary = Summaries[Random.Shared.Next(Summaries.Length)]
        };
    }
}

Se a questo punto apriamo questo URL dal browser, dovremo attendere circa 20 secondi prima di ottenere la risposta. Questo perché, per default, il browser non attiva lo streaming e attende il completamento della risposta prima di visualizzare qualcosa.

Tuttavia, ci basta aggiungere il seguente header, per cambiare radicalmente il comportamento:

this.Response.ContentType = "text/event-stream";

Ora, visualizzando questo endpoint, potremo vedere come la risposta si componga gradualmente, senza dover attendere che tutti gli elementi siano stati generati.

Questo sistema può essere molto utile combinato al supporto dell'ecosistema .NET per IAsyncEnumerable: per esempio, possiamo utilizzarlo per restituire i risultati di una query di Entity Framework (https://www.linqitalia.com/script/523/Utilizzare-Asynchronous-Stream-Entity-Framework-Core.aspx) man mano che li leggiamo dal database.