Prerendere componenti ASP.NET Core Razor

  • Articolo

Questo articolo illustra gli Razor scenari di pre-gestione dei componenti per i componenti sottoposti a rendering del server in Blazor App Web.

Il prerendering è il processo di rendering iniziale del contenuto della pagina nel server senza abilitare i gestori eventi per i controlli di cui è stato eseguito il rendering. Il server restituisce l'interfaccia utente HTML della pagina appena possibile in risposta alla richiesta iniziale, che rende l'app più reattiva agli utenti. Il prerendering può anche migliorare l'ottimizzazione del motore di ricerca (edizione Standard O) eseguendo il rendering del contenuto per la risposta HTTP iniziale usata dai motori di ricerca per calcolare la classificazione delle pagine.

Mantenere lo stato prerenderato

Senza rendere persistente lo stato prerenderato, lo stato usato durante il prerendering viene perso e deve essere ricreato quando l'app viene completamente caricata. Se uno stato viene creato in modo asincrono, l'interfaccia utente può sfarfallio perché l'interfaccia utente prerisorsa viene sostituita quando il componente viene rerendered.

Si consideri il componente contatore seguente PrerenderedCounter1 . Il componente imposta un valore iniziale del contatore casuale durante il prerendering nel OnInitialized metodo del ciclo di vita. Dopo aver stabilito la SignalR connessione al client, il rerender del componente e il valore del conteggio iniziale viene sostituito quando OnInitialized viene eseguito una seconda volta.

PrerenderedCounter1.razor:

@page "/prerendered-counter-1"
@rendermode @(new InteractiveServerRenderMode(prerender: true))
@inject ILogger<PrerenderedCounter1> Logger

<PageTitle>Prerendered Counter 1</PageTitle>

<h1>Prerendered Counter 1</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount;

    protected override void OnInitialized()
    {
        currentCount = Random.Shared.Next(100);
        Logger.LogInformation("currentCount set to {Count}", currentCount);
    }

    private void IncrementCount()
    {
        currentCount++;
    }
}

Eseguire l'app ed esaminare la registrazione dal componente. Di seguito è riportato l'output di esempio.

Nota

Se l'app adotta il routing interattivo (avanzato) e la pagina viene raggiunta tramite uno spostamento interno, il prerendering non si verifica. Pertanto, è necessario eseguire un ricaricamento di pagina completo per il PrerenderedCounter1 componente per visualizzare l'output seguente.

info: BlazorSample.Components.Pages.PrerenderedCounter1[0]
currentCount set to 41
info: BlazorSample.Components.Pages.PrerenderedCounter1[0]
currentCount set to 92

Il primo conteggio registrato si verifica durante il prerendering. Il conteggio viene nuovamente impostato dopo la pre-gestione quando il componente viene riabilitato. C'è anche uno sfarfallio nell'interfaccia utente quando il conteggio viene aggiornato da 41 a 92.

Per mantenere il valore iniziale del contatore durante il prerendering, Blazor supporta lo stato persistente in una pagina prerenderata usando il PersistentComponentState servizio (e per i componenti incorporati in pagine o visualizzazioni di Razor pagine o app MVC, l'helper Persist Component State Tag helper).

Per mantenere lo stato prerenderato, decidere quale stato rendere persistente usando il PersistentComponentState servizio. PersistentComponentState.RegisterOnPersisting registra un callback per rendere persistente lo stato del componente prima che l'app venga sospesa. Lo stato viene recuperato quando l'app riprende.

L'esempio seguente illustra il modello generale:

  • Il {TYPE} segnaposto rappresenta il tipo di dati da mantenere.
  • Il {TOKEN} segnaposto è una stringa di identificatore di stato. Prendere in considerazione l'uso nameof({VARIABLE})di , dove il {VARIABLE} segnaposto è il nome della variabile che contiene lo stato. L'uso nameof() di per l'identificatore di stato evita l'uso di una stringa tra virgolette.
@implements IDisposable
@inject PersistentComponentState ApplicationState

...

@code {
    private {TYPE} data;
    private PersistingComponentStateSubscription persistingSubscription;

    protected override async Task OnInitializedAsync()
    {
        persistingSubscription = 
            ApplicationState.RegisterOnPersisting(PersistData);

        if (!ApplicationState.TryTakeFromJson<{TYPE}>(
            "{TOKEN}", out var restored))
        {
            data = await ...;
        }
        else
        {
            data = restored!;
        }
    }

    private Task PersistData()
    {
        ApplicationState.PersistAsJson("{TOKEN}", data);

        return Task.CompletedTask;
    }

    void IDisposable.Dispose()
    {
        persistingSubscription.Dispose();
    }
}

Nell'esempio seguente del componente contatore viene mantenuto lo stato del contatore durante la prerendering e viene recuperato lo stato per inizializzare il componente.

PrerenderedCounter2.razor:

@page "/prerendered-counter-2"
@implements IDisposable
@inject ILogger<PrerenderedCounter2> Logger
@inject PersistentComponentState ApplicationState

<PageTitle>Prerendered Counter 2</PageTitle>

<h1>Prerendered Counter 2</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount;
    private PersistingComponentStateSubscription persistingSubscription;

    protected override void OnInitialized()
    {
        persistingSubscription =
            ApplicationState.RegisterOnPersisting(PersistCount);

        if (!ApplicationState.TryTakeFromJson<int>(
            nameof(currentCount), out var restoredCount))
        {
            currentCount = Random.Shared.Next(100);
            Logger.LogInformation("currentCount set to {Count}", currentCount);
        }
        else
        {
            currentCount = restoredCount!;
            Logger.LogInformation("currentCount restored to {Count}", currentCount);
        }
    }

    private Task PersistCount()
    {
        ApplicationState.PersistAsJson(nameof(currentCount), currentCount);

        return Task.CompletedTask;
    }

    void IDisposable.Dispose() => persistingSubscription.Dispose();

    private void IncrementCount()
    {
        currentCount++;
    }
}

Quando il componente viene eseguito, currentCount viene impostato una sola volta durante la pre-esecuzione. Il valore viene ripristinato quando il componente viene sottoposto a rerendering. Di seguito è riportato l'output di esempio.

Nota

Se l'app adotta il routing interattivo e la pagina viene raggiunta tramite uno spostamento interno, il prerendering non si verifica. Pertanto, è necessario eseguire un ricaricamento di pagina completo per il PrerenderedCounter2 componente per visualizzare l'output seguente.

info: BlazorSample.Components.Pages.PrerenderedCounter2[0]
currentCount set to 96
info: BlazorSample.Components.Pages.PrerenderedCounter2[0]
currentCount restored to 96

Inizializzando i componenti con lo stesso stato usato durante la pre-esecuzione, tutti i passaggi di inizializzazione costosi vengono eseguiti una sola volta. L'interfaccia utente sottoposta a rendering corrisponde anche all'interfaccia utente prerisorsa, quindi non si verifica alcun sfarfallio nel browser.

Componenti incorporati in pagine e visualizzazioni (Razor Pages/MVC)

Per i componenti incorporati in una pagina o in una visualizzazione di un'app Razor Pages o MVC, devi aggiungere l'helperTag Persist Component State Tag con il <persist-component-state /> tag HTML all'interno del tag di chiusura </body> del layout dell'app. Questa operazione è necessaria solo per Razor le app Pages e MVC. Per altre informazioni, vedere Persist Component State Tag Helper in ASP.NET Core.For more information, see Persist Component State Tag Helper in ASP.NET Core.

Pages/Shared/_Layout.cshtml:

<body>
    ...

    <persist-component-state />
</body>

Routing interattivo e prerendering

Lo spostamento interno per il routing interattivo non comporta la richiesta di nuovo contenuto della pagina dal server. Di conseguenza, il prerendering non si verifica per le richieste di pagina interne.

Il PersistentComponentState servizio funziona solo per il caricamento iniziale della pagina e non per gli eventi di spostamento di pagina avanzati. Se l'app esegue uno spostamento completo (non avanzato) a una pagina che usa lo stato del componente persistente, lo stato persistente viene reso disponibile per l'uso dell'app quando diventa interattivo. Tuttavia, se è già stato stabilito un circuito interattivo e viene eseguita una navigazione avanzata in una pagina che esegue il rendering dello stato del componente persistente, tale stato non viene reso disponibile nel circuito esistente. Il PersistentComponentState servizio non è a conoscenza della navigazione avanzata e non esiste alcun meccanismo per distribuire gli aggiornamenti dello stato ai componenti già in esecuzione.

Indicazioni di pre-ordinamento

Le indicazioni preliminari sono organizzate nella documentazione in base all'argomento Blazor . I collegamenti seguenti illustrano tutte le linee guida di pre-ordinamento in tutta la documentazione impostata dall'oggetto: