Руководство. Использование внедрения зависимостей в .NET

Статья
01/31/2024

В этом руководстве показано, как использовать внедрение зависимостей в .NET. С помощью расширений Майкрософт di управляется путем добавления служб и их настройки в IServiceCollection. Интерфейс IHost предоставляет собой экземпляр IServiceProvider, который выступает в качестве контейнера всех зарегистрированных служб.

В этом руководстве описано следующее:

Создание консольного приложения .NET, использующего внедрение зависимостей
Создание и настройка универсального узла
Написание нескольких интерфейсов и соответствующих реализаций
Использование времени существования службы и области для внедрения зависимостей

Необходимые компоненты

Пакет SDK для .NET Core 3.1 или более поздней версии.
Знакомство с созданием новых приложений .NET и установкой пакетов NuGet.

Создание нового консольного приложения

С помощью команды dotnet new или мастера создания проектов в среде разработки создайте новое консольное приложение .NET с именем ConsoleDI.Example. Добавьте в проект пакет NuGet Microsoft.Extensions.Hosting.

Новый файл проекта консольного приложения должен выглядеть следующим образом:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>true</ImplicitUsings>
    <RootNamespace>ConsoleDI.Example</RootNamespace>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
  </ItemGroup>

</Project>

Важно!

В этом примере пакет NuGet Microsoft.Extensions.Hosting требуется для сборки и запуска приложения. Некоторые метапакеты могут содержать Microsoft.Extensions.Hosting пакет, в этом случае не требуется явная ссылка на пакет.

Добавление интерфейсов

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

IReportServiceLifetime.cs

using Microsoft.Extensions.DependencyInjection;

namespace ConsoleDI.Example;

public interface IReportServiceLifetime
{
    Guid Id { get; }

    ServiceLifetime Lifetime { get; }
}

Интерфейс IReportServiceLifetime определяет:

Свойство Guid Id , представляющее уникальный идентификатор службы.
Свойство ServiceLifetime , представляющее время существования службы.

ЯExampleTransientService.cs

using Microsoft.Extensions.DependencyInjection;

namespace ConsoleDI.Example;

public interface IExampleTransientService : IReportServiceLifetime
{
    ServiceLifetime IReportServiceLifetime.Lifetime => ServiceLifetime.Transient;
}

ЯExampleScopedService.cs

using Microsoft.Extensions.DependencyInjection;

namespace ConsoleDI.Example;

public interface IExampleScopedService : IReportServiceLifetime
{
    ServiceLifetime IReportServiceLifetime.Lifetime => ServiceLifetime.Scoped;
}

ЯExampleSingletonService.cs

using Microsoft.Extensions.DependencyInjection;

namespace ConsoleDI.Example;

public interface IExampleSingletonService : IReportServiceLifetime
{
    ServiceLifetime IReportServiceLifetime.Lifetime => ServiceLifetime.Singleton;
}

Все вложенные интерфейсы IReportServiceLifetime явно реализуются IReportServiceLifetime.Lifetime по умолчанию. Например, IExampleTransientService явно реализует IReportServiceLifetime.LifetimeServiceLifetime.Transient значение.

Добавление реализаций по умолчанию

Пример реализации всех инициализирует их Id свойство с результатом Guid.NewGuid(). Добавьте следующие классы реализации по умолчанию для различных служб в корневой каталог проекта:

ExampleTransientService.cs

namespace ConsoleDI.Example;

internal sealed class ExampleTransientService : IExampleTransientService
{
    Guid IReportServiceLifetime.Id { get; } = Guid.NewGuid();
}

ExampleScopedService.cs

namespace ConsoleDI.Example;

internal sealed class ExampleScopedService : IExampleScopedService
{
    Guid IReportServiceLifetime.Id { get; } = Guid.NewGuid();
}

ExampleSingletonService.cs

namespace ConsoleDI.Example;

internal sealed class ExampleSingletonService : IExampleSingletonService
{
    Guid IReportServiceLifetime.Id { get; } = Guid.NewGuid();
}

Каждая реализация определяется как internal sealed и реализует соответствующий интерфейс. Например, ExampleSingletonService реализует IExampleSingletonService.

Добавление службы, требующей di

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

ServiceLifetimeReporter.cs

namespace ConsoleDI.Example;

internal sealed class ServiceLifetimeReporter(
    IExampleTransientService transientService,
    IExampleScopedService scopedService,
    IExampleSingletonService singletonService)
{
    public void ReportServiceLifetimeDetails(string lifetimeDetails)
    {
        Console.WriteLine(lifetimeDetails);

        LogService(transientService, "Always different");
        LogService(scopedService, "Changes only with lifetime");
        LogService(singletonService, "Always the same");
    }

    private static void LogService<T>(T service, string message)
        where T : IReportServiceLifetime =>
        Console.WriteLine(
            $"    {typeof(T).Name}: {service.Id} ({message})");
}

Определяет ServiceLifetimeReporter конструктор, который требует каждого из указанных выше интерфейсов служб упоминание, то есть IExampleTransientService, IExampleScopedServiceи IExampleSingletonService. Объект предоставляет один метод, позволяющий потребителю сообщать о службе с заданным lifetimeDetails параметром. При вызове ReportServiceLifetimeDetails метод регистрирует уникальный идентификатор каждой службы с сообщением о времени существования службы. Сообщения журнала помогают визуализировать время существования службы.

Регистрация служб для внедрения зависимостей

Обновите файл Program.cs, используя следующий код:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using ConsoleDI.Example;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.Services.AddTransient<IExampleTransientService, ExampleTransientService>();
builder.Services.AddScoped<IExampleScopedService, ExampleScopedService>();
builder.Services.AddSingleton<IExampleSingletonService, ExampleSingletonService>();
builder.Services.AddTransient<ServiceLifetimeReporter>();

using IHost host = builder.Build();

ExemplifyServiceLifetime(host.Services, "Lifetime 1");
ExemplifyServiceLifetime(host.Services, "Lifetime 2");

await host.RunAsync();

static void ExemplifyServiceLifetime(IServiceProvider hostProvider, string lifetime)
{
    using IServiceScope serviceScope = hostProvider.CreateScope();
    IServiceProvider provider = serviceScope.ServiceProvider;
    ServiceLifetimeReporter logger = provider.GetRequiredService<ServiceLifetimeReporter>();
    logger.ReportServiceLifetimeDetails(
        $"{lifetime}: Call 1 to provider.GetRequiredService<ServiceLifetimeReporter>()");

    Console.WriteLine("...");

    logger = provider.GetRequiredService<ServiceLifetimeReporter>();
    logger.ReportServiceLifetimeDetails(
        $"{lifetime}: Call 2 to provider.GetRequiredService<ServiceLifetimeReporter>()");

    Console.WriteLine();
}

Каждый метод расширения services.Add{LIFETIME}<{SERVICE}> добавляет (а потенциально и настраивает) службы. Мы рекомендуем приложениям следовать этому соглашению. Не размещайте методы расширения в Microsoft.Extensions.DependencyInjection пространстве имен, если вы не создаете официальный пакет Майкрософт. Методы расширения, определенные в Microsoft.Extensions.DependencyInjection пространстве имен:

Отображаются в IntelliSense без дополнительных using блоков.
Уменьшите количество обязательных using инструкций в классах, Startup где Program обычно вызываются эти методы расширения.

Приложение:

IHostBuilder Создает экземпляр с параметрами построителя узлов.
настраивает службы и добавляет их с соответствующим временем существования службы;
вызывает метод Build() и назначает экземпляр IHost;
вызывает ExemplifyScoping, передавая IHost.Services.

Заключение

В этом примере приложения вы создали несколько интерфейсов и соответствующих реализаций. Каждая из этих служб уникально идентифицируется и связана с ним ServiceLifetime. В примере приложения демонстрируется регистрация реализаций служб в интерфейсе и регистрация чистых классов без поддержки интерфейсов. Затем в примере приложения показано, как зависимости, определенные как параметры конструктора, разрешаются во время выполнения.

При запуске приложения отображаются выходные данные, аналогичные следующим:

// Sample output:
// Lifetime 1: Call 1 to provider.GetRequiredService<ServiceLifetimeReporter>()
//     IExampleTransientService: d08a27fa-87d2-4a06-98d7-2773af886125 (Always different)
//     IExampleScopedService: 402c83c9-b4ed-4be1-b78c-86be1b1d908d (Changes only with lifetime)
//     IExampleSingletonService: a61f1ff4-0b14-4508-bd41-21d852484a7b (Always the same)
// ...
// Lifetime 1: Call 2 to provider.GetRequiredService<ServiceLifetimeReporter>()
//     IExampleTransientService: b43d68fb-2c7b-4a9b-8f02-fc507c164326 (Always different)
//     IExampleScopedService: 402c83c9-b4ed-4be1-b78c-86be1b1d908d (Changes only with lifetime)
//     IExampleSingletonService: a61f1ff4-0b14-4508-bd41-21d852484a7b (Always the same)
// 
// Lifetime 2: Call 1 to provider.GetRequiredService<ServiceLifetimeReporter>()
//     IExampleTransientService: f3856b59-ab3f-4bbd-876f-7bab0013d392 (Always different)
//     IExampleScopedService: bba80089-1157-4041-936d-e96d81dd9d1c (Changes only with lifetime)
//     IExampleSingletonService: a61f1ff4-0b14-4508-bd41-21d852484a7b (Always the same)
// ...
// Lifetime 2: Call 2 to provider.GetRequiredService<ServiceLifetimeReporter>()
//     IExampleTransientService: a8015c6a-08cd-4799-9ec3-2f2af9cbbfd2 (Always different)
//     IExampleScopedService: bba80089-1157-4041-936d-e96d81dd9d1c (Changes only with lifetime)
//     IExampleSingletonService: a61f1ff4-0b14-4508-bd41-21d852484a7b (Always the same)

Из выходных данных приложения можно понять следующее.

Transient службы всегда отличаются, создается новый экземпляр с каждым получением службы.
Scopedслужбы изменяются только с новым область, но являются одинаковыми экземплярами в область.
Singleton службы всегда одинаковы, новый экземпляр создается только один раз.