Внедрение зависимостей Blazor в ASP.NET Core

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents();

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSingleton<WeatherForecastService>();

После создания приложения изучите метод Startup.ConfigureServices в Startup.cs.

using Microsoft.Extensions.DependencyInjection;

...

public void ConfigureServices(IServiceCollection services)
{
    ...
}

В метод ConfigureServices передается IServiceCollection, представляющий собой список объектов дескриптора службы. Службы добавляются в метод ConfigureServices путем предоставления дескрипторов служб в коллекцию служб. В следующем примере показана концепция с интерфейсом IDataAccess и его конкретной реализацией DataAccess.

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IDataAccess, DataAccess>();
}

Клиентские службы, которые завершаются сбоем во время предварительной подготовки

Этот раздел применяется только к компонентам WebAssembly в Blazor Web Apps.

Blazor Web Appобычно предопределенные клиентские компоненты WebAssembly. Если приложение выполняется только с обязательной службой, зарегистрированной в .Client проекте, выполнение приложения приводит к ошибке среды выполнения, аналогичной следующей, когда компонент пытается использовать требуемую службу во время предварительной подготовки:

InvalidOperationException: не удается указать значение для {PROPERTY} в типе "{ASSEMBLY}}". Client.Pages. {ИМЯ КОМПОНЕНТА}". Зарегистрированная служба типа "{SERVICE}" отсутствует.

Используйте любой из следующих подходов для решения этой проблемы:

• Зарегистрируйте службу в основном проекте, чтобы сделать ее доступной во время предварительной подготовки компонентов.
• Если предварительная отрисовка не требуется для компонента, отключите предварительную отрисовку, следуя указаниям в режимах отрисовки ASP.NET CoreBlazor. Если вы используете этот подход, вам не нужно регистрировать службу в основном проекте.

Дополнительные сведения см. в разделе "Не удается разрешить клиентские службы во время предварительной подготовки".

Для внедрения служб в компоненты поддерживает внедрение конструктора Blazor и внедрение свойств.

Внедрение конструктора

После добавления служб в коллекцию служб добавьте одну или несколько служб в компоненты с внедрением конструктора. В следующем примере служба внедряется NavigationManager .

ConstructorInjection.razor:

@page "/constructor-injection"

<button @onclick="HandleClick">
    Take me to the Counter component
</button>

ConstructorInjection.razor.cs:

using Microsoft.AspNetCore.Components;

public partial class ConstructorInjection(NavigationManager navigation)
{
    private void HandleClick()
    {
        navigation.NavigateTo("/counter");
    }
}

Внедрение свойств

Внедрение ключевых служб в компоненты

Blazor поддерживает внедрение ключевых служб с помощью атрибута [Inject] . Ключи позволяют определить регистрацию и потребление служб при использовании внедрения зависимостей. InjectAttribute.Key Используйте свойство, чтобы указать ключ для службы для внедрения:

[Inject(Key = "my-service")]
public IMyService MyService { get; set; }

@page "/time-travel"
@inject ITimeTravel TimeTravel1
@inherits OwningComponentBase

<h1><code>OwningComponentBase</code> Example</h1>

<ul>
    <li>TimeTravel1.DT: @TimeTravel1?.DT</li>
    <li>TimeTravel2.DT: @TimeTravel2?.DT</li>
</ul>

@code {
    private ITimeTravel TimeTravel2 { get; set; } = default!;

    protected override void OnInitialized()
    {
        TimeTravel2 = ScopedServices.GetRequiredService<ITimeTravel>();
    }
}

@page "/time-travel"
@inject ITimeTravel TimeTravel1
@inherits OwningComponentBase

<h1><code>OwningComponentBase</code> Example</h1>

<ul>
    <li>TimeTravel1.DT: @TimeTravel1?.DT</li>
    <li>TimeTravel2.DT: @TimeTravel2?.DT</li>
</ul>

@code {
    private ITimeTravel TimeTravel2 { get; set; } = default!;

    protected override void OnInitialized()
    {
        TimeTravel2 = ScopedServices.GetRequiredService<ITimeTravel>();
    }
}

Обнаружение временных временных удаленных решений на стороне клиента

Пользовательский код можно добавить в клиентское Blazor приложение для обнаружения удаленных временных служб в приложении, которое должно использоваться OwningComponentBase. Этот подход полезен, если вы обеспокоены тем, что код, добавленный в приложение в будущем, использует одну или несколько временных удаленных служб, включая службы, добавленные библиотеками. Демонстрационный код доступен в Blazor репозитории примеров GitHub (как скачать).

Проверьте следующие версии примера в .NET 6 или более поздних версиях BlazorSample_WebAssembly :

• DetectIncorrectUsagesOfTransientDisposables.cs
• Services/TransientDisposableService.cs
• Включено: Program.cs
  • Пространство имен приложения Services предоставляется в верхней части файла (using BlazorSample.Services;).
  • DetectIncorrectUsageOfTransients вызывается сразу после builder назначения из WebAssemblyHostBuilder.CreateDefault.
  • Зарегистрировано TransientDisposableService (builder.Services.AddTransient<TransientDisposableService>();).
  • EnableTransientDisposableDetection вызывается на встроенном узле в конвейере обработки приложения (host.EnableTransientDisposableDetection();).
• Приложение регистрирует TransientDisposableService службу без исключения. Однако при попытке разрешения службы возникает TransientService.razor InvalidOperationException ошибка при попытке платформы создать экземпляр TransientDisposableService.

Обнаружение временных временных удалений на стороне сервера

Пользовательский код можно добавить в серверное приложение для обнаружения временных служб на стороне Blazor сервера в приложении, которое должно использоваться OwningComponentBase. Этот подход полезен, если вы обеспокоены тем, что код, добавленный в приложение в будущем, использует одну или несколько временных удаленных служб, включая службы, добавленные библиотеками. Демонстрационный код доступен в Blazor репозитории примеров GitHub (как скачать).

Проверьте следующие версии примера в .NET 8 или более поздних версиях BlazorSample_BlazorWebApp :

Проверьте следующие версии примера в .NET 6 или .NET 7 BlazorSample_Server :

• DetectIncorrectUsagesOfTransientDisposables.cs
• Services/TransitiveTransientDisposableDependency.cs:
• Включено: Program.cs
  • Пространство имен приложения Services предоставляется в верхней части файла (using BlazorSample.Services;).
  • DetectIncorrectUsageOfTransients вызывается в построителе узлов (builder.DetectIncorrectUsageOfTransients();).
  • Служба TransientDependency зарегистрирована (builder.Services.AddTransient<TransientDependency>();).
  • Зарегистрировано TransitiveTransientDisposableDependency для ITransitiveTransientDisposableDependency (builder.Services.AddTransient<ITransitiveTransientDisposableDependency, TransitiveTransientDisposableDependency>();).
• Приложение регистрирует TransientDependency службу без исключения. Однако при попытке разрешения службы возникает TransientService.razor InvalidOperationException ошибка при попытке платформы создать экземпляр TransientDependency.

Временные регистрации служб для IHttpClientFactory/HttpClient обработчиков

Рекомендуется регистрировать временные службы для обработчиков IHttpClientFactory/HttpClient. Если приложение содержит IHttpClientFactory/HttpClient обработчики и использует IRemoteAuthenticationBuilder<TRemoteAuthenticationState,TAccount> поддержку проверки подлинности, то также обнаруживаются следующие временные удаления для проверки подлинности на стороне клиента, которые ожидаются и могут игнорироваться:

• BaseAddressAuthorizationMessageHandler
• AuthorizationMessageHandler

Также обнаружены другие экземпляры IHttpClientFactory/HttpClient . Эти экземпляры также можно игнорировать.

Примеры Blazor приложений в Blazor репозитории GitHub (как скачать) демонстрируют код для обнаружения временных одноразовых носителей. Однако код деактивирован, так как примеры приложений включают IHttpClientFactory/HttpClient обработчики.

Чтобы активировать демонстрационный код и засвидетельствовать его операцию:

• Раскомментируйте временные одноразовые линии в Program.cs.

• Удалите условную проверку NavLink.razor , которая предотвращает TransientService отображение компонента на боковой панели навигации приложения:

  - else if (name != "TransientService")
  + else
  

• Запустите пример приложения и перейдите к компоненту TransientService /transient-service.

Обработчики действий канала предоставляют подход для доступа к службам с областью Blazor действия из другихBlazor областей внедрения зависимостей (DI), таких как области, созданные с помощью IHttpClientFactory.

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

public class CircuitServicesAccessor
{
    static readonly AsyncLocal<IServiceProvider> blazorServices = new();

    public IServiceProvider? Services
    {
        get => blazorServices.Value;
        set => blazorServices.Value = value;
    }
}

public class ServicesAccessorCircuitHandler(
    IServiceProvider services, CircuitServicesAccessor servicesAccessor) 
    : CircuitHandler
{
    public override Func<CircuitInboundActivityContext, Task> CreateInboundActivityHandler(
        Func<CircuitInboundActivityContext, Task> next) => 
            async context =>
            {
                servicesAccessor.Services = services;
                await next(context);
                servicesAccessor.Services = null;
            };
}

public static class CircuitServicesServiceCollectionExtensions
{
    public static IServiceCollection AddCircuitServicesAccessor(
        this IServiceCollection services)
    {
        services.AddScoped<CircuitServicesAccessor>();
        services.AddScoped<CircuitHandler, ServicesAccessorCircuitHandler>();

        return services;
    }
}

Доступ к службам с областью канала путем внедрения CircuitServicesAccessor необходимых служб.

Пример, в котором показано, как получить доступ к настройке DelegatingHandler с помощьюIHttpClientFactory, см. в дополнительных сценариях безопасности на стороне сервера ASP.NET CoreBlazor.AuthenticationStateProvider

Иногда Razor компонент вызывает асинхронные методы, выполняющие код в другой области DI. Без правильного подхода эти области DI не имеют доступа к Blazorслужбам, таким как IJSRuntime и Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage.

Например, экземпляры, HttpClient созданные с помощью IHttpClientFactory собственной области службы DI. В результате экземпляры, настроенные в нейHttpClient, HttpMessageHandler не могут напрямую внедрять Blazor службы.

Создайте класс BlazorServiceAccessor , определяющий AsyncLocal, который сохраняет BlazorIServiceProvider текущий асинхронный контекст. Экземпляр BlazorServiceAccessor можно получить из другой области службы DI для доступа к Blazor службам.

BlazorServiceAccessor.cs:

internal sealed class BlazorServiceAccessor
{
    private static readonly AsyncLocal<BlazorServiceHolder> s_currentServiceHolder = new();

    public IServiceProvider? Services
    {
        get => s_currentServiceHolder.Value?.Services;
        set
        {
            if (s_currentServiceHolder.Value is { } holder)
            {
                // Clear the current IServiceProvider trapped in the AsyncLocal.
                holder.Services = null;
            }

            if (value is not null)
            {
                // Use object indirection to hold the IServiceProvider in an AsyncLocal
                // so it can be cleared in all ExecutionContexts when it's cleared.
                s_currentServiceHolder.Value = new() { Services = value };
            }
        }
    }

    private sealed class BlazorServiceHolder
    {
        public IServiceProvider? Services { get; set; }
    }
}

Чтобы задать значение BlazorServiceAccessor.Services автоматически при async вызове метода компонента, создайте настраиваемый базовый компонент, который повторно реализует три основные асинхронные точки входа в Razor код компонента:

• IComponent.SetParametersAsync
• IHandleEvent.HandleEventAsync
• IHandleAfterRender.OnAfterRenderAsync

Следующий класс демонстрирует реализацию базового компонента.

CustomComponentBase.cs:

using Microsoft.AspNetCore.Components;

public class CustomComponentBase : ComponentBase, IHandleEvent, IHandleAfterRender
{
    private bool hasCalledOnAfterRender;

    [Inject]
    private IServiceProvider Services { get; set; } = default!;

    [Inject]
    private BlazorServiceAccessor BlazorServiceAccessor { get; set; } = default!;

    public override Task SetParametersAsync(ParameterView parameters)
        => InvokeWithBlazorServiceContext(() => base.SetParametersAsync(parameters));

    Task IHandleEvent.HandleEventAsync(EventCallbackWorkItem callback, object? arg)
        => InvokeWithBlazorServiceContext(() =>
        {
            var task = callback.InvokeAsync(arg);
            var shouldAwaitTask = task.Status != TaskStatus.RanToCompletion &&
                task.Status != TaskStatus.Canceled;

            StateHasChanged();

            return shouldAwaitTask ?
                CallStateHasChangedOnAsyncCompletion(task) :
                Task.CompletedTask;
        });

    Task IHandleAfterRender.OnAfterRenderAsync()
        => InvokeWithBlazorServiceContext(() =>
        {
            var firstRender = !hasCalledOnAfterRender;
            hasCalledOnAfterRender |= true;

            OnAfterRender(firstRender);

            return OnAfterRenderAsync(firstRender);
        });

    private async Task CallStateHasChangedOnAsyncCompletion(Task task)
    {
        try
        {
            await task;
        }
        catch
        {
            if (task.IsCanceled)
            {
                return;
            }

            throw;
        }

        StateHasChanged();
    }

    private async Task InvokeWithBlazorServiceContext(Func<Task> func)
    {
        try
        {
            BlazorServiceAccessor.Services = Services;
            await func();
        }
        finally
        {
            BlazorServiceAccessor.Services = null;
        }
    }
}

Все компоненты, расширяющиеся CustomComponentBase автоматически, имеют BlazorServiceAccessor.Services IServiceProvider значение в текущей Blazor области DI.

Наконец, в Program файле добавьте службу с областью BlazorServiceAccessor действия:

builder.Services.AddScoped<BlazorServiceAccessor>();

Наконец, добавьте Startup.ConfigureServices Startup.csслужбу в BlazorServiceAccessor качестве области:

services.AddScoped<BlazorServiceAccessor>();

• Внедрение службы с помощью файла импорта верхнего уровня (_Imports.razor) в Blazor Web Apps
• Использование внедрения зависимостей в ASP.NET Core
• Руководство по применению временных и общих экземпляров IDisposable
• Внедрение зависимостей в представления в ASP.NET Core
• Основные конструкторы (руководство по C#)

• Использование внедрения зависимостей в ASP.NET Core
• Руководство по применению временных и общих экземпляров IDisposable
• Внедрение зависимостей в представления в ASP.NET Core