Избегайте перезаписи параметров в ASP.NET Core Blazor

Роберт Хакен

В этой статье объясняется, как избежать перезаписи параметров в приложениях Blazor во время rerendering.

Перезаписанные параметры

Платформа Blazor обычно позволяет безопасно назначить параметр с родительского компонента на дочерний:

• Параметры не перезаписываются неожиданно.
• Побочные эффекты сводятся к минимуму. Например, дополнительные отрисовки избегаются, так как они могут создавать бесконечные циклы отрисовки.

Дочерний компонент получает новые значения параметров, которые могут перезаписать существующие значения при повторной отрисовке родительского компонента. Случайно перезаписанные значения параметров в дочернем компоненте часто возникают при разработке компонента с одним или несколькими параметрами, привязанными к данным, а также если разработчик выполняет запись данных непосредственно в параметр в дочернем элементе:

• Дочерний компонент отрисовывается с одним или несколькими значениями параметров из родительского компонента.
• Дочерний компонент выполняет запись непосредственно в значение параметра.
• Родительский компонент отрисовывается повторно и перезаписывает значение параметра дочернего элемента.

Возможность перезаписи значений параметров также распространяется и на методы доступа свойства set дочернего компонента.

Внимание

Мы не рекомендуем создавать компоненты, которые напрямую выполняют запись в собственные параметры после первой отрисовки.

Рассмотрим следующий компонент ShowMoreExpander, который:

• Отрисовывает заголовок.
• Отображает дочернее содержимое при выборе.
• Позволяет задать начальное состояние с параметром компонента (InitiallyExpanded).

После демонстрации переопределенного параметра с помощью следующего компонента ShowMoreExpander демонстрируется правильный подход для этого сценария с помощью измененного компонента ShowMoreExpander. Следующие примеры можно разместить в локальном примере приложения для ознакомления с описанным выше поведением.

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;
    }
}

Компонент ShowMoreExpander добавляется в следующий родительский компонент Expanders, который может вызывать StateHasChanged:

• Вызов StateHasChanged в коде разработчика уведомляет компонент о том, что его состояние изменилось, и, как правило, запускает повторную отрисовку компонента для обновления пользовательского интерфейса. StateHasChanged рассматривается более подробно в статьях Жизненный цикл компонентов ASP.NET Core Razor и Отрисовка компонентов ASP.NET Core Razor.
• Атрибут директивы @onclick кнопки подключает обработчик событий к событию onclick кнопки. Обработка событий рассматривается более подробно в статье Обработка событий ASP.NET Core Blazor.

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>

ShowMoreExpander Изначально компоненты ведут себя независимо при установке их InitiallyExpanded свойств. Дочерние компоненты сохраняют свои состояния, как и ожидалось.

При вызове StateHasChanged в родительском компоненте платформа Blazor повторно отрисовывает дочерние компоненты, если их параметры могли измениться:

• Для группы типов параметров, которые Blazor проверяет явно, Blazor повторно отрисовывает дочерний компонент, если обнаруживает изменение в любом из параметров.
• Для непроверяемых типов параметров Blazor повторно отрисовывает дочерний компонент независимо от того, изменились ли параметры. Дочернее содержимое попадает под эту категорию типов параметров, так как оно имеет тип RenderFragment, который является делегатом, ссылающимся на другие изменяемые объекты.

Для компонента Expanders:

• Первый ShowMoreExpander компонент задает дочернее содержимое в потенциально изменяемом RenderFragmentрежиме, поэтому вызов StateHasChanged родительского компонента автоматически перезаписывает компонент и потенциально перезаписывает значение InitiallyExpanded его первоначального falseзначения.
• Второй компонент ShowMoreExpander не задает дочернее содержимое. Поэтому потенциально изменяемый делегат RenderFragment не существует. Вызов StateHasChanged в родительском компоненте не активирует автоматическую повторную отрисовку дочернего компонента, поэтому значение компонента InitiallyExpanded не перезаписывается.

Чтобы сохранить состояние в предыдущем сценарии, используйте частное поле в компоненте ShowMoreExpander для поддержания его состояния.

Следующий измененный компонент ShowMoreExpander:

• Принимает значение параметра компонента InitiallyExpanded из родительского элемента.
• Присваивает значение параметра компонента закрытому полю (expanded) в событии OnInitialized.
• Использует закрытое поле для поддержания внутреннего состояния переключения, в котором описывается, как избегать непосредственной записи в параметре.

Примечание.

Рекомендации в этом разделе распространяются на аналогичную логику методов доступа set параметров компонентов, что может приводить к аналогичным нежелательным побочным эффектам.

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;
    }
}

Примечание.

Измененный ShowMoreExpander параметр не отражает изменения InitiallyExpanded параметра после инициализации (OnInitialized). В некоторых сценариях уже инициализированный компонент может получать новые значения параметров. Это может произойти, например, в главном представлении, где один и тот же компонент используется для отображения разных представлений подробностей или при /item/{id} изменении параметра маршрута для отображения другого элемента.

Рассмотрим следующий ToggleExpander компонент:

• Позволяет изменить состояние как внутри, так и снаружи.
• Обрабатывает новые значения параметров, даже если один и тот же экземпляр компонента повторно используется.

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);
    }
}

Компонент ToggleExpander должен использоваться с синтаксисом @bind-Expanded="{field}" привязки, позволяя двусторонней синхронизации параметра.

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;
    }
}

Дополнительные сведения о привязке родительского дочернего объекта см. в следующих ресурсах:

• Привязка с параметрами компонента
• Привязка между более чем двумя компонентами
• Blazor Ошибка привязки двухстороннего пути (dotnet/aspnetcore #24599)

Дополнительные сведения об обнаружении изменений, включая сведения о точных типах, которые Blazor проверка, см. в ASP.NET отрисовке основных Razor компонентов.