Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Nota
Questa non è la versione più recente di questo articolo. Per la versione corrente, vedere la versione .NET 11 di questo articolo.
Questo articolo fornisce indicazioni per gli autori di librerie di componenti che considerano il supporto per il rendering statico lato server (SSR statico).
Blazor incoraggia lo sviluppo di un ecosistema di librerie di componenti open source e commerciali, formalmente denominate librerie di classi (RCLs). Gli sviluppatori possono anche creare componenti riutilizzabili per condividere i componenti privatamente tra le app all'interno delle proprie aziende. Idealmente, i componenti vengono sviluppati per garantire la compatibilità con il maggior numero possibile di modelli di hosting e modalità di rendering. Ssr statico introduce restrizioni aggiuntive che possono essere più complesse da supportare rispetto alle modalità di rendering interattive.
Comprendere le funzionalità e le restrizioni di SSR statico
Static SSR è una modalità in cui i componenti vengono eseguiti quando il server gestisce una richiesta HTTP in ingresso. Blazor esegue il rendering come HTML, che viene incluso nella risposta. Dopo l'invio della risposta, lo stato del componente e del renderer sul lato server viene rimosso, quindi tutto ciò che rimane è HTML nel browser.
Il vantaggio di questa modalità è l'hosting più economico, più scalabile, perché non sono necessarie risorse server in corso per mantenere lo stato del componente, non è necessario mantenere alcuna connessione continua tra browser e server e non è necessario alcun payload WebAssembly nel browser.
Tutti i componenti esistenti possono comunque essere usati con SSR statico. Tuttavia, il costo di questa modalità è che i gestori eventi, ad esempio @onclick†, non possono essere eseguiti per i motivi seguenti:
- Non è presente alcun codice .NET nel browser per eseguirli.
- Il server ha immediatamente rimosso qualsiasi stato del componente e del renderer necessario per eseguire gestori eventi o per eseguire nuovamente il rendering delle stesse istanze del componente.
†C'è un'eccezione speciale per il gestore eventi per i moduli @onsubmit, che è sempre funzionale, indipendentemente dalla modalità di rendering.
Ciò equivale al modo in cui si comportano i componenti durante il prerendering, prima dell'avvio del circuito SignalR di Blazor o del runtime .NET WebAssembly.
Per i componenti il cui unico ruolo consiste nel produrre contenuto DOM di sola lettura, questi comportamenti per SSR statici sono completamente sufficienti. Tuttavia, gli autori di librerie devono prendere in considerazione l'approccio da adottare quando si includono componenti interattivi nelle rispettive librerie.
Opzioni per gli autori di componenti
Esistono tre approcci principali:
Non usare comportamenti interattivi (Basic)
Per i componenti il cui unico ruolo consiste nel produrre contenuto DOM di sola lettura, lo sviluppatore non deve eseguire alcuna azione speciale. Questi componenti funzionano naturalmente con qualsiasi modalità di rendering.
Esempi:
- Componente "scheda utente" che carica i dati corrispondenti a una persona e ne esegue il rendering in un'interfaccia utente stilizzata con una foto, un titolo di lavoro e altri dettagli.
- Un componente "video" che funge da wrapper intorno all'elemento HTML
<video>, rendendo più pratico l'uso in un componente Razor.
Richiedi rendering interattivo (Base)
È possibile scegliere di richiedere che il componente venga usato solo con il rendering interattivo. Questo limita l'applicabilità del componente, ma significa che è possibile basarsi liberamente su gestori di eventi arbitrari. Anche in questo caso, è comunque consigliabile evitare di dichiarare un elemento specifico
@rendermodee consentire all'autore dell'app che utilizza la libreria di selezionare uno.Esempi:
- Componente di modifica video in cui gli utenti possono unire e riordinare segmenti di video. Anche se c'era un modo per rappresentare queste operazioni di modifica con semplici pulsanti HTML e invii del modulo, l'esperienza utente sarebbe inaccettabile senza vera interattività.
- Editor di documenti collaborativo che deve mostrare le attività di altri utenti in tempo reale.
Usare comportamenti interattivi, ma progettare per SSR statici e miglioramenti progressivi (avanzate)
È possibile implementare molti comportamenti interattivi usando solo le funzionalità HTML. Con una buona conoscenza di HTML e CSS, spesso è possibile produrre una baseline utile di funzionalità che funziona con SSR statico. È comunque possibile dichiarare gestori eventi che implementano comportamenti più avanzati e facoltativi, che funzionano solo nelle modalità di rendering interattive.
Esempi:
- Un componente di griglia. In SSR statico, il componente può supportare solo la visualizzazione dei dati e lo spostamento tra le pagine (implementate con collegamenti
<a>). Se usato con il rendering interattivo, il componente può aggiungere l'ordinamento e il filtro in tempo reale. - Un componente gruppo di schede. Finché lo spostamento tra le schede viene ottenuto usando
<a>i collegamenti e lo stato viene mantenuto solo nei parametri di query URL, il componente può funzionare senza@onclick. - Componente di caricamento di file avanzato. In SSR statico, il componente può comportarsi come nativo
<input type=file>. Se usato con il rendering interattivo, il componente potrebbe anche visualizzare lo stato di avanzamento del caricamento. - Un ticker azionario. In SSR statico, il componente può visualizzare la quotazione del titolo al momento del rendering del codice HTML. Se usato con il rendering interattivo, il componente può quindi aggiornare il prezzo azionario in tempo reale.
- Un componente di griglia. In SSR statico, il componente può supportare solo la visualizzazione dei dati e lo spostamento tra le pagine (implementate con collegamenti
Per una di queste strategie, è anche possibile implementare funzionalità interattive con JavaScript.
Per scegliere tra questi approcci, gli autori di componenti riutilizzabili Razor devono valutare un compromesso tra costi e benefici. Il componente è più utile e ha una base utente più ampia se supporta tutte le modalità di rendering, incluso SSR statico. Tuttavia, richiede più lavoro progettare e implementare un componente che supporta e sfrutta al meglio ogni modalità di rendering.
Quando usare la @rendermode direttiva
Nella maggior parte dei casi, gli autori di componenti riutilizzabili non devono specificare una modalità di rendering, anche quando è necessaria l'interattività. Ciò è dovuto al fatto che l'autore del componente non sa se l'app abilita il supporto per InteractiveServer, InteractiveWebAssemblyo entrambi con InteractiveAuto. Non specificando un elemento @rendermode, l'autore del componente lascia la scelta allo sviluppatore dell'app.
Anche se l'autore del componente ritiene che sia necessaria l'interattività, potrebbero comunque esserci casi in cui un autore dell'app considera sufficiente usare solo SSR statico. Ad esempio, un componente della mappa con interattività di trascinamento e zoom potrebbe sembrare richiedere controlli interattivi. Tuttavia, alcuni scenari potrebbero richiedere solo il rendering di un'immagine statica della mappa ed evitare funzionalità di trascinamento/zoom.
L'unico motivo per cui un autore di componenti riutilizzabile deve usare la @rendermode direttiva sul relativo componente è se l'implementazione è fondamentalmente associata a una modalità di rendering specifica e provocherebbe certamente un errore se usato in una modalità diversa. Si consideri un componente con lo scopo principale di interagire direttamente con il sistema operativo host usando API specifiche di Windows o Linux. Potrebbe essere impossibile usare tale componente in WebAssembly. In tal caso, è ragionevole dichiarare @rendermode InteractiveServer per il componente.
Rendering streaming
I componenti riutilizzabili Razor possono dichiarare liberamente @attribute [StreamRendering] per rendering in streaming (API degli attributi [StreamRendering]). Ciò comporta aggiornamenti incrementali dell'interfaccia utente durante il rendering lato server statico. Poiché gli stessi modelli di caricamento dei dati producono aggiornamenti incrementali dell'interfaccia utente durante il rendering interattivo, indipendentemente dalla presenza dell'attributo [StreamRendering] , il componente può comportarsi correttamente in tutti i casi. Anche nei casi in cui lo streaming statico di SSR viene soppresso nel server, il componente esegue comunque il rendering dello stato finale corretto.
Uso di collegamenti tra le modalità di rendering
I componenti riutilizzabili Razor possono usare collegamenti e spostamento avanzato. I tag HTML <a> devono produrre comportamenti equivalenti con o senza un componente interattivo Router e indipendentemente dal fatto che la navigazione avanzata sia abilitata o disabilitata a livello di predecessore nel DOM.
Uso dei moduli tra le modalità di rendering
I componenti riutilizzabili Razor possono includere moduli ( <form> o <EditForm>), perché possono essere implementati per funzionare in modo equivalente nelle modalità di rendering statiche e interattive.
Si consideri l'esempio seguente:
<EditForm Enhance FormName="NewProduct" Model="Model" OnValidSubmit="Save">
<DataAnnotationsValidator />
<ValidationSummary />
<p><label>Name: <InputText @bind-Value="Model!.Name" /></label></p>
<button type="submit">Submit</button>
</EditForm>
@code {
[SupplyParameterFromForm]
private Product? Model { get; set; }
protected override void OnInitialized() => Model ??= new();
private async Task Save()
{
...
}
}
Le API Enhance, FormName e SupplyParameterFromFormAttribute vengono usate solo durante l'SSR statico e vengono ignorate durante il rendering interattivo. Il modulo funziona correttamente durante SSR interattivi e statici.
Evitare API specifiche di SSR statico
HttpContext è disponibile solo durante il ssr statico, quindi non fare affidamento sulla HttpContext creazione di componenti che funzionano tra le modalità di rendering. L'API HttpContext non ha senso usarla durante il rendering interattivo perché in tali momenti non c'è alcuna richiesta HTTP attiva in corso. È inutile pensare all'impostazione di un codice di stato HTTP o alla scrittura nella risposta HTTP.
I componenti riutilizzabili sono liberi di ricevere un HttpContext quando disponibile, come indicato di seguito:
[CascadingParameter]
private HttpContext? Context { get; set; }
Il valore è null durante il rendering interattivo e viene impostato solo durante il ssr statico.
In molti casi, esistono alternative migliori rispetto all'uso di HttpContext. Se è necessario conoscere l'URL corrente o eseguire un reindirizzamento, le API su NavigationManager funzionano con tutte le modalità di rendering. Se è necessario conoscere lo stato di autenticazione dell'utente, usare il servizio AuthenticationStateProvider di Blazor (documentazione di AuthenticationStateProvider) invece di usare HttpContext.User.