Vermeiden des Überschreibens von Parametern in ASP.NET Core Blazor

Von Robert Haken

In diesem Artikel wird erläutert, wie das Überschreiben von Parametern in Blazor-Apps während der Erneuterenderung vermieden werden kann.

Überschriebene Parameter

Das Blazor-Framework erzwingt im Allgemeinen eine sichere Parameterzuordnung von über- und untergeordneten Elementen:

• Parameter werden nicht unerwartet überschrieben.
• Nebenwirkungen werden auf ein Minimum reduziert. Beispielsweise werden zusätzliche Rendervorgänge vermieden, da Sie zu unendlichen Renderingschleifen führen können.

Eine untergeordnete Komponente empfängt neue Parameterwerte, die möglicherweise vorhandene Werte überschreiben, wenn die übergeordnete Komponente erneut gerendert wird. Das versehentliche Überschreiben von Parameterwerten in einer untergeordneten Komponente tritt häufig auf, wenn die Komponente mit mindestens einem datengebundenen Parameter entwickelt wird und der Entwickler direkt in einen Parameter im untergeordneten Element schreibt:

• Die untergeordnete Komponente wird mit mindestens einem Parameterwert aus der übergeordneten Komponente gerendert.
• Das untergeordnete Element schreibt direkt in den Wert eines Parameters.
• Die übergeordnete Komponente wird erneut gerendert und überschreibt den Wert des Parameters des untergeordneten Elements.

Die Möglichkeit, Parameterwerte zu überschreiben, gilt auch für set-Eigenschaftenzugriffsmethoden der untergeordneten Komponente.

Wichtig

Grundsätzlich wird empfohlen, keine Komponenten zu erstellen, die direkt in die eigenen Parameter schreiben, nachdem die Komponente zum ersten Mal gerendert wurde.

Angenommen, die folgende ShowMoreExpander-Komponente:

• Rendert den Titel.
• Zeigt den untergeordneten Inhalt an, wenn auf sie geklickt wird.
• Ermöglicht das Festlegen des Anfangszustands mit einem Komponentenparameter (InitiallyExpanded).

Nachdem die folgende ShowMoreExpander-Komponente einen überschriebenen Parameter gezeigt hat, wird eine modifizierte ShowMoreExpander-Komponente gezeigt, um den richtigen Ansatz für dieses Szenario zu veranschaulichen. Die folgenden Beispiele können in eine lokale Beispiel-App eingefügt werden, um die beschriebenen Verhaltensweisen nachzuvollziehen.

ShowMoreExpander.razor:

<div @onclick="ShowMore" class="card bg-light mb-3" style="width:30rem">
    <div class="card-header">
        <h2 class="card-title">Show more (<code>Expanded</code> = @InitiallyExpanded)</h2>
    </div>
    @if (InitiallyExpanded)
    {
        <div class="card-body">
            <p class="card-text">@ChildContent</p>
        </div>
    }
</div>

@code {
    [Parameter]
    public bool InitiallyExpanded { get; set; }

    [Parameter]
    public RenderFragment? ChildContent { get; set; }

    private void ShowMore() => InitiallyExpanded = true;
}

Die ShowMoreExpander-Komponente wird der folgenden übergeordneten Expanders-Komponente hinzugefügt, die StateHasChanged aufrufen kann:

• Durch den Aufruf von StateHasChanged im Entwicklercode wird eine Komponente benachrichtigt, dass sich ihr Status geändert hat, und in der Regel wird ein erneutes Rendern der Komponente in die Warteschlange gestellt, um die Benutzeroberfläche zu aktualisieren. StateHasChanged wird weiter unten unter Komponentenlebenszyklus von Razor in ASP.NET Core und Rendering von Razor-Komponenten in ASP.NET Core detailliert behandelt.
• Das @onclick-Anweisungsattribut der Schaltfläche fügt einen Ereignishandler an das onclick-Ereignis der Schaltfläche an. Die Ereignisbehandlung wird weiter unten unter Ereignisbehandlung in Blazor in ASP.NET Core ausführlicher behandelt.

Expanders.razor:

@page "/expanders"

<PageTitle>Expanders</PageTitle>

<h1>Expanders Example</h1>

<ShowMoreExpander InitiallyExpanded="false">
    Expander 1 content
</ShowMoreExpander>

<ShowMoreExpander InitiallyExpanded="false" />

<button @onclick="StateHasChanged">Call StateHasChanged</button>

Anfänglich verhalten sich die ShowMoreExpander-Komponenten unabhängig, wenn ihre InitiallyExpanded-Eigenschaften bestimmt werden. Die untergeordneten Komponenten behalten ihre Zustände erwartungsgemäß bei.

Wenn StateHasChanged in einer übergeordneten Komponente aufgerufen wird, rendert das Blazor-Framework untergeordnete Komponenten neu, wenn sich ihre Parameter geändert haben könnten:

• Bei einer Gruppe von Parametertypen, die von Blazor explizit überprüft werden, rendert Blazor eine untergeordnete Komponente neu, wenn erkannt wird, dass sich Parameter geändert haben.
• Bei nicht überprüften Parametertypen wird die untergeordnete Blazor-Komponente neu gerendert – unabhängig davon, ob sich die Parameter geändert haben oder nicht. Untergeordneter Inhalt fällt in diese Kategorie von Parametertypen, weil untergeordneter Inhalt dem Typ RenderFragment entspricht, einem Delegat, der auf andere stummschaltbare Objekte verweist.

Für die Expanders-Komponente:

• Die erste ShowMoreExpander-Komponente legt untergeordneten Inhalt in einem potenziell stummschaltbaren RenderFragment fest, sodass ein Aufruf von StateHasChanged in der übergeordneten Komponente die Komponente automatisch neu rendert und möglicherweise den Wert von InitiallyExpanded mit dem Anfangswert false überschreibt.
• Die zweite ShowMoreExpander-Komponente legt keinen untergeordneten Inhalt fest. Daher gibt es keinen potenziell stummschaltbaren RenderFragment. Durch einen Aufruf von StateHasChanged in der übergeordneten Komponente wird die untergeordnete Komponente nicht automatisch neu gerendert, sodass der InitiallyExpanded-Wert der Komponente nicht überschrieben wird.

Um den Zustand im vorangehenden Szenario beizubehalten, verwenden Sie ein privates Feld in der ShowMoreExpander-Komponente, um dessen Zustand beizubehalten.

Die folgende überarbeitete ShowMoreExpander-Komponente:

• akzeptiert den Wert des InitiallyExpanded-Komponentenparameters aus der übergeordneten Komponente.
• weist den Wert des Komponentenparameters einem privaten Feld (expanded) im OnInitialized-Ereignis zu.
• Verwendet das private Feld, um den internen Umschaltzustand zu verwalten. Dies veranschaulicht, wie das direkte Schreiben in einen Parameter vermieden wird.

Hinweis

Die Hinweise in diesem Abschnitt gelten auch für ähnliche Logik in den set-Zugriffsmethoden für Komponentenparameter, die zu ähnlichen unerwünschten Nebenwirkungen führen kann.

ShowMoreExpander.razor:

<div @onclick="Expand" class="card bg-light mb-3" style="width:30rem">
    <div class="card-header">
        <h2 class="card-title">Show more (<code>Expanded</code> = @expanded)</h2>
    </div>
    @if (expanded)
    {
        <div class="card-body">
            <p class="card-text">@ChildContent</p>
        </div>
    }
</div>

@code {
    private bool expanded;

    [Parameter]
    public bool InitiallyExpanded { get; set; }

    [Parameter]
    public RenderFragment? ChildContent { get; set; }

    protected override void OnInitialized() => expanded = InitiallyExpanded;

    private void Expand() => expanded = true;
}

Hinweis

Die überarbeitete ShowMoreExpander Eigenschaft spiegelt nach der Initialisierung ( OnInitialized ) keine Änderungen amInitiallyExpandedParameter wider. In bestimmten Szenarien erhält eine bereits initialisierte Komponente möglicherweise neue Parameterwerte. Dies kann z. B. in einer primär-untergeordneten Ansicht der Fall sein, in der dieselbe Komponente zum Rendern verschiedener Detailansichten verwendet wird, oder wenn sich der /item/{id}-Routenparameter ändert, um ein anderes Element anzuzeigen.

Angenommen, die folgende ToggleExpander-Komponente:

• Ermöglicht es Ihnen, den Zustand sowohl von innen als auch von außen zu ändern.
• Behandelt neue Parameterwerte, auch wenn dieselbe Komponenteninstanz wiederverwendet wird.

ToggleExpander.razor:

<div class="card bg-light mb-3" style="width:30rem">
    <div @onclick="Toggle" class="card-header">
        <h2 class="card-title">Toggle (<code>Expanded</code> = @expanded)</h2>
    </div>
    @if (expanded)
    {
        <div class="card-body">
            <p class="card-text">@ChildContent</p>
        </div>
    }
</div>

@code {
    [Parameter]
    public bool Expanded { get; set; }

    [Parameter]
    public EventCallback<bool> ExpandedChanged { get; set; }

    [Parameter]
    public RenderFragment? ChildContent { get; set; }

    private bool expanded;

    protected override void OnParametersSet() => expanded = Expanded;

    private async void Toggle()
    {
        expanded = !expanded;
        await ExpandedChanged.InvokeAsync(expanded);
    }
}

Die ToggleExpander Komponente sollte mit der @bind-Expanded="{field}" Bindungssyntax verwendet werden und ermöglicht die bidirektionale Synchronisierung des Parameters.

ExpandersToggle.razor:

@page "/expanders-toggle"

<PageTitle>Expanders Toggle</PageTitle>

<h1>Expanders Toggle</h1>

<ToggleExpander @bind-Expanded="expanded">
    Expander content
</ToggleExpander>

<button @onclick="Toggle">Toggle</button>

<button @onclick="StateHasChanged">Call StateHasChanged</button>

@code {
    private bool expanded;

    private void Toggle() => expanded = !expanded;
}

Weitere Informationen zur Bindung zwischen über- und untergeordneten Elementen finden Sie in den folgenden Ressourcen:

• Binden mit Komponentenparametern
• Binden über mehr als zwei Komponenten
• Blazor Bidirektionaler Bindungsfehler (dotnet/aspnetcore #24599)

Weitere Informationen zur Änderungserkennung, einschließlich Informationen zu den genauen Typen, die von Blazor überprüft werden, finden Sie unter Razor-Komponentenrendering unter ASP.NET Core.