ASP.NET Core에서 종속성 주입Dependency injection in ASP.NET Core

작성자: Steve Smith, Scott AddieLuke LathamBy Steve Smith, Scott Addie, and Luke Latham

ASP.NET Core는 클래스와 해당 종속성 간의 IoC(Inversion of Control)를 실현하는 기술인 DI(종속성 주입) 소프트웨어 디자인 패턴을 지원합니다.ASP.NET Core supports the dependency injection (DI) software design pattern, which is a technique for achieving Inversion of Control (IoC) between classes and their dependencies.

MVC 컨트롤러 내의 종속성 주입에 대한 자세한 내용은 ASP.NET Core의 컨트롤러에 종속성 주입을 참조하세요.For more information specific to dependency injection within MVC controllers, see ASP.NET Core의 컨트롤러에 종속성 주입.

예제 코드 살펴보기 및 다운로드(다운로드 방법)View or download sample code (how to download)

종속성 주입 개요Overview of dependency injection

‘종속성’은 다른 개체에 필요한 모든 개체입니다.A dependency is any object that another object requires. 앱의 다른 클래스가 종속된 MyDependency 클래스에서 WriteMessage 메서드를 사용하는 다음 코드를 살펴보세요.Examine the following MyDependency class with a WriteMessage method that other classes in an app depend upon:

public class MyDependency
{
    public MyDependency()
    {
    }

    public Task WriteMessage(string message)
    {
        Console.WriteLine(
            $"MyDependency.WriteMessage called. Message: {message}");

        return Task.FromResult(0);
    }
}

MyDependency 클래스의 인스턴스를 만들어 클래스에 WriteMessage 메서드를 사용할 수 있게 할 수 있습니다.An instance of the MyDependency class can be created to make the WriteMessage method available to a class. MyDependency 클래스는 IndexModel 클래스의 종속성입니다.The MyDependency class is a dependency of the IndexModel class:

public class IndexModel : PageModel
{
    MyDependency _dependency = new MyDependency();

    public async Task OnGetAsync()
    {
        await _dependency.WriteMessage(
            "IndexModel.OnGetAsync created this message.");
    }
}

MyDependency 클래스의 인스턴스를 만들어 클래스에 WriteMessage 메서드를 사용할 수 있게 할 수 있습니다.An instance of the MyDependency class can be created to make the WriteMessage method available to a class. MyDependency 클래스는 HomeController 클래스의 종속성입니다.The MyDependency class is a dependency of the HomeController class:

public class HomeController : Controller
{
    MyDependency _dependency = new MyDependency();

    public async Task<IActionResult> Index()
    {
        await _dependency.WriteMessage(
            "HomeController.Index created this message.");

        return View();
    }
}

이 클래스는 MyDependency 인스턴스를 만들고 이 인스턴스에 직접 종속됩니다.The class creates and directly depends on the MyDependency instance. 이전 예제와 같은 코드 종속성은 문제가 있으며 다음과 같은 이유로 사용하지 않아야 합니다.Code dependencies (such as the previous example) are problematic and should be avoided for the following reasons:

  • MyDependency를 다른 구현으로 바꾸려면 클래스를 수정해야 합니다.To replace MyDependency with a different implementation, the class must be modified.
  • MyDependency에 종속성이 있으면 클래스에서 종속성을 구성해야 합니다.If MyDependency has dependencies, they must be configured by the class. 여러 클래스가 MyDependency에 종속되어 있는 대형 프로젝트에서는 구성 코드가 앱 전체에 분산됩니다.In a large project with multiple classes depending on MyDependency, the configuration code becomes scattered across the app.
  • 이 구현은 단위 테스트하기가 어렵습니다.This implementation is difficult to unit test. 앱에서 모의 또는 스텁 MyDependency 클래스를 사용해야 하지만, 이 방법에서는 가능하지 않습니다.The app should use a mock or stub MyDependency class, which isn't possible with this approach.

종속성 주입은 다음을 통해 이러한 문제를 해결합니다.Dependency injection addresses these problems through:

  • 종속성 구현을 추상화하는 인터페이스 사용The use of an interface to abstract the dependency implementation.
  • 서비스 컨테이너에 종속성 등록.Registration of the dependency in a service container. ASP.NET Core는 서비스 컨테이너 IServiceProvider를 기본 제공합니다.ASP.NET Core provides a built-in service container, IServiceProvider. 서비스는 앱의 Startup.ConfigureServices 메서드에 등록됩니다.Services are registered in the app's Startup.ConfigureServices method.
  • 서비스를 사용되는 클래스의 생성자에 주입.Injection of the service into the constructor of the class where it's used. 프레임워크는 종속성의 인스턴스를 만들고 더 이상 필요하지 않으면 삭제하는 작업을 담당합니다.The framework takes on the responsibility of creating an instance of the dependency and disposing of it when it's no longer needed.

샘플 앱에서 IMyDependency 인터페이스는 서비스가 앱에 제공하는 메서드를 정의합니다.In the sample app, the IMyDependency interface defines a method that the service provides to the app:

public interface IMyDependency
{
    Task WriteMessage(string message);
}
public interface IMyDependency
{
    Task WriteMessage(string message);
}

이 인터페이스는 구체적인 형식 MyDependency에서 구현합니다.This interface is implemented by a concrete type, MyDependency:

public class MyDependency : IMyDependency
{
    private readonly ILogger<MyDependency> _logger;

    public MyDependency(ILogger<MyDependency> logger)
    {
        _logger = logger;
    }

    public Task WriteMessage(string message)
    {
        _logger.LogInformation(
            "MyDependency.WriteMessage called. Message: {MESSAGE}", 
            message);

        return Task.FromResult(0);
    }
}
public class MyDependency : IMyDependency
{
    private readonly ILogger<MyDependency> _logger;

    public MyDependency(ILogger<MyDependency> logger)
    {
        _logger = logger;
    }

    public Task WriteMessage(string message)
    {
        _logger.LogInformation(
            "MyDependency.WriteMessage called. Message: {MESSAGE}", 
            message);

        return Task.FromResult(0);
    }
}

MyDependency는 자신의 생성자에서 ILogger<TCategoryName>을 요청합니다.MyDependency requests an ILogger<TCategoryName> in its constructor. 종속성 주입을 연결된 방식으로 사용하는 일은 특별한 경우가 아닙니다.It's not unusual to use dependency injection in a chained fashion. 요청된 각 종속성은 차례로 자체 종속성을 요청합니다.Each requested dependency in turn requests its own dependencies. 컨테이너는 그래프의 종속성을 해결하고 완전히 해결된 서비스를 반환합니다.The container resolves the dependencies in the graph and returns the fully resolved service. 해결해야 하는 종속성이 모인 집합은 일반적으로 종속성 트리, 종속성 그래프 또는 개체 그래프라고 합니다.The collective set of dependencies that must be resolved is typically referred to as a dependency tree, dependency graph, or object graph.

IMyDependencyILogger<TCategoryName>는 서비스 컨테이너에 등록되어야 합니다.IMyDependency and ILogger<TCategoryName> must be registered in the service container. IMyDependencyStartup.ConfigureServices에 등록됩니다.IMyDependency is registered in Startup.ConfigureServices. ILogger<TCategoryName>은 로깅 추상화 인프라에서 등록하므로, 프레임워크에서 기본적으로 등록한 프레임워크 제공 서비스입니다.ILogger<TCategoryName> is registered by the logging abstractions infrastructure, so it's a framework-provided service registered by default by the framework.

샘플 앱에서 IMyDependency 서비스는 구체적인 형식 MyDependency에 등록됩니다.In the sample app, the IMyDependency service is registered with the concrete type MyDependency. 등록하면 서비스 수명이 단일 요청의 수명으로 지정됩니다.The registration scopes the service lifetime to the lifetime of a single request. 서비스 수명에 대해서는 이 항목의 뒷부분에서 설명합니다.Service lifetimes are described later in this topic.

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    services.AddScoped<IMyDependency, MyDependency>();
    services.AddTransient<IOperationTransient, Operation>();
    services.AddScoped<IOperationScoped, Operation>();
    services.AddSingleton<IOperationSingleton, Operation>();
    services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

    // OperationService depends on each of the other Operation types.
    services.AddTransient<OperationService, OperationService>();
}
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    services.AddScoped<IMyDependency, MyDependency>();
    services.AddTransient<IOperationTransient, Operation>();
    services.AddScoped<IOperationScoped, Operation>();
    services.AddSingleton<IOperationSingleton, Operation>();
    services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

    // OperationService depends on each of the other Operation types.
    services.AddTransient<OperationService, OperationService>();
}

참고

services.Add{SERVICE_NAME} 확장 메서드는 서비스를 추가(및 잠재적으로 구성)합니다.Each services.Add{SERVICE_NAME} extension method adds (and potentially configures) services. 예를 들어 services.AddMvc()는 Razor 페이지와 MVC에서 요청하는 서비스를 추가합니다.For example, services.AddMvc() adds the services Razor Pages and MVC require. 앱에서 이 규칙을 따르는 것이 좋습니다.We recommended that apps follow this convention. 확장 메서드를 Microsoft.Extensions.DependencyInjection 네임스페이스에 배치하여 서비스 등록 그룹을 캡슐화합니다.Place extension methods in the Microsoft.Extensions.DependencyInjection namespace to encapsulate groups of service registrations.

서비스의 생성자에 string과 같은 기본 형식이 필요한 경우 구성옵션 패턴을 사용하여 기본 형식을 삽입할 수 있습니다.If the service's constructor requires a primitive, such as a string, the primitive can be injected by using configuration or the options pattern:

public class MyDependency : IMyDependency
{
    public MyDependency(IConfiguration config)
    {
        var myStringValue = config["MyStringKey"];

        // Use myStringValue
    }

    ...
}

서비스의 인스턴스는 서비스가 사용되는 클래스의 생성자를 통해 요청되고 전용 필드에 할당됩니다.An instance of the service is requested via the constructor of a class where the service is used and assigned to a private field. 이 필드는 클래스 전체에서 필요에 따라 서비스에 액세스하는 데 사용됩니다.The field is used to access the service as necessary throughout the class.

샘플 앱에서는 IMyDependency 인스턴스가 요청되며 이 인스턴스는 서비스의 WriteMessage 메서드를 호출하는 데 사용됩니다.In the sample app, the IMyDependency instance is requested and used to call the service's WriteMessage method:

public class IndexModel : PageModel
{
    private readonly IMyDependency _myDependency;

    public IndexModel(
        IMyDependency myDependency, 
        OperationService operationService,
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance singletonInstanceOperation)
    {
        _myDependency = myDependency;
        OperationService = operationService;
        TransientOperation = transientOperation;
        ScopedOperation = scopedOperation;
        SingletonOperation = singletonOperation;
        SingletonInstanceOperation = singletonInstanceOperation;
    }

    public OperationService OperationService { get; }
    public IOperationTransient TransientOperation { get; }
    public IOperationScoped ScopedOperation { get; }
    public IOperationSingleton SingletonOperation { get; }
    public IOperationSingletonInstance SingletonInstanceOperation { get; }

    public async Task OnGetAsync()
    {
        await _myDependency.WriteMessage(
            "IndexModel.OnGetAsync created this message.");
    }
}
public class MyDependencyController : Controller
{
    private readonly IMyDependency _myDependency;

    public MyDependencyController(IMyDependency myDependency)
    {
        _myDependency = myDependency;
    }

    // GET: /mydependency/
    public async Task<IActionResult> Index()
    {
        await _myDependency.WriteMessage(
            "MyDependencyController.Index created this message.");

        return View();
    }
}

프레임워크에서 제공한 서비스Framework-provided services

Startup.ConfigureServices 메서드는 Entity Framework Core 및 ASP.NET Core MVC와 같은 플랫폼 기능을 비롯해 앱이 사용하는 서비스를 정의합니다.The Startup.ConfigureServices method is responsible for defining the services the app uses, including platform features, such as Entity Framework Core and ASP.NET Core MVC. 처음에 ConfigureServices에 제공된 IServiceCollection에는 정의된 다음과 같은 서비스가 있습니다(호스트 구성 방법에 따라).Initially, the IServiceCollection provided to ConfigureServices has the following services defined (depending on how the host was configured):

서비스 종류Service Type 수명Lifetime
Microsoft.AspNetCore.Hosting.Builder.IApplicationBuilderFactoryMicrosoft.AspNetCore.Hosting.Builder.IApplicationBuilderFactory TransientTransient
Microsoft.AspNetCore.Hosting.IApplicationLifetimeMicrosoft.AspNetCore.Hosting.IApplicationLifetime SingletonSingleton
Microsoft.AspNetCore.Hosting.IHostingEnvironmentMicrosoft.AspNetCore.Hosting.IHostingEnvironment SingletonSingleton
Microsoft.AspNetCore.Hosting.IStartupMicrosoft.AspNetCore.Hosting.IStartup SingletonSingleton
Microsoft.AspNetCore.Hosting.IStartupFilterMicrosoft.AspNetCore.Hosting.IStartupFilter TransientTransient
Microsoft.AspNetCore.Hosting.Server.IServerMicrosoft.AspNetCore.Hosting.Server.IServer SingletonSingleton
Microsoft.AspNetCore.Http.IHttpContextFactoryMicrosoft.AspNetCore.Http.IHttpContextFactory TransientTransient
Microsoft.Extensions.Logging.ILogger<T>Microsoft.Extensions.Logging.ILogger<T> SingletonSingleton
Microsoft.Extensions.Logging.ILoggerFactoryMicrosoft.Extensions.Logging.ILoggerFactory SingletonSingleton
Microsoft.Extensions.ObjectPool.ObjectPoolProviderMicrosoft.Extensions.ObjectPool.ObjectPoolProvider SingletonSingleton
Microsoft.Extensions.Options.IConfigureOptions<T>Microsoft.Extensions.Options.IConfigureOptions<T> TransientTransient
Microsoft.Extensions.Options.IOptions<T>Microsoft.Extensions.Options.IOptions<T> SingletonSingleton
System.Diagnostics.DiagnosticSourceSystem.Diagnostics.DiagnosticSource SingletonSingleton
System.Diagnostics.DiagnosticListenerSystem.Diagnostics.DiagnosticListener SingletonSingleton

서비스 컬렉션 확장 메서드를 사용하여 서비스(및 필요한 경우 해당 종속 서비스)를 등록할 수 있는 경우 단일 Add{SERVICE_NAME} 확장 메서드를 사용하여 해당 서비스에 필요한 모든 서비스를 등록하는 것이 규칙입니다.When a service collection extension method is available to register a service (and its dependent services, if required), the convention is to use a single Add{SERVICE_NAME} extension method to register all of the services required by that service. 다음 코드는 확장 메서드 AddDbContext, AddIdentityAddMvc를 사용하여 컨테이너에 서비스를 추가하는 방법을 보여 주는 예제입니다.The following code is an example of how to add additional services to the container using the extension methods AddDbContext, AddIdentity, and AddMvc:

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

    services.AddIdentity<ApplicationUser, IdentityRole>()
        .AddEntityFrameworkStores<ApplicationDbContext>()
        .AddDefaultTokenProviders();

    services.AddMvc();
}

자세한 내용은 API 설명서에서 ServiceCollection 클래스를 참조하세요.For more information, see the ServiceCollection Class in the API documentation.

서비스 수명Service lifetimes

등록된 각 서비스의 수명을 적절히 선택합니다.Choose an appropriate lifetime for each registered service. ASP.NET Core 서비스는 다음 수명을 사용하여 구성할 수 있습니다.ASP.NET Core services can be configured with the following lifetimes:

TransientTransient

Transient 수명 서비스는 요청할 때마다 만들어집니다.Transient lifetime services are created each time they're requested. 이 수명은 간단한 상태 비저장 서비스에 가장 적합합니다.This lifetime works best for lightweight, stateless services.

ScopedScoped

Scoped 수명 서비스는 요청당 한 번만 만들어집니다.Scoped lifetime services are created once per request.

경고

미들웨어에서 범위가 지정된 서비스를 사용하는 경우 Invoke 또는 InvokeAsync 메서드에 서비스를 삽입합니다.When using a scoped service in a middleware, inject the service into the Invoke or InvokeAsync method. 생성자 삽입은 서비스가 싱글톤처럼 작동하게 하므로 이러한 방법으로 삽입하지 마세요.Don't inject via constructor injection because it forces the service to behave like a singleton. 자세한 내용은 ASP.NET Core 미들웨어 기본 사항을 참조하세요.For more information, see ASP.NET Core 미들웨어 기본 사항.

SingletonSingleton

Singleton 수명 서비스는 처음 요청할 때(또는 ConfigureServices를 실행하고 서비스 등록에서 인스턴스를 지정하는 경우) 생성됩니다.Singleton lifetime services are created the first time they're requested (or when ConfigureServices is run and an instance is specified with the service registration). 모든 후속 요청에서는 같은 인스턴스를 사용합니다.Every subsequent request uses the same instance. 앱에 singleton 동작이 필요한 경우 서비스 컨테이너에서 서비스 수명을 관리하도록 허용하는 것이 좋습니다.If the app requires singleton behavior, allowing the service container to manage the service's lifetime is recommended. singleton 디자인 패턴을 구현하는 경우 클래스의 개체 수명을 관리하는 사용자 코드를 제공하지 마세요.Don't implement the singleton design pattern and provide user code to manage the object's lifetime in the class.

경고

범위가 지정된 서비스를 singleton에서 해결하면 위험합니다.It's dangerous to resolve a scoped service from a singleton. 이 경우 후속 요청을 처리할 때 서비스가 잘못된 상태일 수 있습니다.It may cause the service to have incorrect state when processing subsequent requests.

생성자 주입 동작Constructor injection behavior

다음 두 가지 메커니즘으로 서비스를 해결할 수 있습니다.Services can be resolved by two mechanisms:

  • IServiceProvider
  • ActivatorUtilities – 종속성 주입 컨테이너에서 서비스 등록 없이 개체를 생성할 수 있습니다.ActivatorUtilities – Permits object creation without service registration in the dependency injection container. ActivatorUtilities는 태그 도우미, MVC 컨트롤러 및 모델 바인더와 같은 사용자용 추상화에 사용됩니다.ActivatorUtilities is used with user-facing abstractions, such as Tag Helpers, MVC controllers, and model binders.

생성자에는 종속성 주입으로 제공되지 않는 인수를 사용할 수 있지만, 인수에 기본값을 할당해야 합니다.Constructors can accept arguments that aren't provided by dependency injection, but the arguments must assign default values.

IServiceProvider 또는 ActivatorUtilities로 서비스를 해결하는 경우 생성자 주입에 public 생성자가 필요합니다.When services are resolved by IServiceProvider or ActivatorUtilities, constructor injection requires a public constructor.

ActivatorUtilities로 서비스를 해결하는 경우 생성자 주입을 위해서는 적합한 생성자가 하나만 있어야 합니다.When services are resolved by ActivatorUtilities, constructor injection requires that only one applicable constructor exists. 생성자 오버로드가 지원되지만, 해당 인수가 모두 종속성 주입으로 처리될 수 있는 하나의 오버로드만 존재할 수 있습니다.Constructor overloads are supported, but only one overload can exist whose arguments can all be fulfilled by dependency injection.

Entity Framework 컨텍스트Entity Framework contexts

Entity Framework 컨텍스트는 범위가 지정된 수명을 사용하여 서비스 컨테이너에 추가해야 합니다.Entity Framework contexts should be added to the service container using the scoped lifetime. 이 작업은 데이터베이스 컨텍스트를 등록할 때 AddDbContext 메서드를 호출하여 자동으로 처리됩니다.This is handled automatically with a call to the AddDbContext method when registering the database context. 데이터베이스 컨텍스트를 사용하는 서비스도 범위가 지정된 수명을 사용해야 합니다.Services that use the database context should also use the scoped lifetime.

수명 및 등록 옵션Lifetime and registration options

이러한 수명 및 등록 옵션 간의 차이점을 살펴보려면 작업을 고유한 ID인 OperationId가 있는 operation으로 나타내는 다음 인터페이스를 고려해 보세요.To demonstrate the difference between the lifetime and registration options, consider the following interfaces that represent tasks as an operation with a unique identifier, OperationId. 다음 인터페이스에 대해 작업 서비스의 수명을 구성하는 방법에 따라 컨테이너는 클래스에서 요청할 때 서비스의 같은 인스턴스나 다른 인스턴스를 제공합니다.Depending on how the lifetime of an operations service is configured for the following interfaces, the container provides either the same or a different instance of the service when requested by a class:

public interface IOperation
{
    Guid OperationId { get; }
}

public interface IOperationTransient : IOperation
{
}

public interface IOperationScoped : IOperation
{
}

public interface IOperationSingleton : IOperation
{
}

public interface IOperationSingletonInstance : IOperation
{
}
public interface IOperation
{
    Guid OperationId { get; }
}

public interface IOperationTransient : IOperation
{
}

public interface IOperationScoped : IOperation
{
}

public interface IOperationSingleton : IOperation
{
}

public interface IOperationSingletonInstance : IOperation
{
}

인터페이스는 Operation 클래스에 구현됩니다.The interfaces are implemented in the Operation class. Operation 생성자는 제공되지 않는 경우 GUID를 생성합니다.The Operation constructor generates a GUID if one isn't supplied:

public class Operation : IOperationTransient, 
    IOperationScoped, 
    IOperationSingleton, 
    IOperationSingletonInstance
{
    public Operation() : this(Guid.NewGuid())
    {
    }

    public Operation(Guid id)
    {
        OperationId = id;
    }

    public Guid OperationId { get; private set; }
}
public class Operation : IOperationTransient, 
    IOperationScoped, 
    IOperationSingleton, 
    IOperationSingletonInstance
{
    public Operation() : this(Guid.NewGuid())
    {
    }

    public Operation(Guid id)
    {
        OperationId = id;
    }

    public Guid OperationId { get; private set; }
}

OperationService는 등록되어 각각 다른 Operation 형식에 종속됩니다.An OperationService is registered that depends on each of the other Operation types. 종속성 주입을 통해 OperationService를 요청하는 경우에는 종속 서비스의 수명에 따라 각 서비스의 새 인스턴스나 기존 인스턴스를 받습니다.When OperationService is requested via dependency injection, it receives either a new instance of each service or an existing instance based on the lifetime of the dependent service.

  • 요청할 때 임시 서비스가 생성되는 경우 IOperationTransient 서비스의 OperationIdOperationServiceOperationId와 다릅니다.If transient services are created when requested, the OperationId of the IOperationTransient service is different than the OperationId of the OperationService. OperationServiceIOperationTransient 클래스의 새 인스턴스를 받습니다.OperationService receives a new instance of the IOperationTransient class. 새 인스턴스는 다른 OperationId를 생성합니다.The new instance yields a different OperationId.
  • 요청에 따라 범위가 지정된 서비스가 생성되는 경우 IOperationScoped 서비스는 요청 내의 OperationServiceOperationId가 같습니다.If scoped services are created per request, the OperationId of the IOperationScoped service is the same as that of OperationService within a request. 전체 요청에서 두 서비스는 다른 OperationId 값을 공유합니다.Across requests, both services share a different OperationId value.
  • singleton 및 singleton 인스턴스 서비스가 한 번 생성되어 모든 요청과 모든 서비스에서 사용되는 경우 OperationId는 모든 서비스 요청에서 상수입니다.If singleton and singleton-instance services are created once and used across all requests and all services, the OperationId is constant across all service requests.
public class OperationService
{
    public OperationService(
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance instanceOperation)
    {
        TransientOperation = transientOperation;
        ScopedOperation = scopedOperation;
        SingletonOperation = singletonOperation;
        SingletonInstanceOperation = instanceOperation;
    }

    public IOperationTransient TransientOperation { get; }
    public IOperationScoped ScopedOperation { get; }
    public IOperationSingleton SingletonOperation { get; }
    public IOperationSingletonInstance SingletonInstanceOperation { get; }
}
public class OperationService
{
    public OperationService(IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance instanceOperation)
    {
        TransientOperation = transientOperation;
        ScopedOperation = scopedOperation;
        SingletonOperation = singletonOperation;
        SingletonInstanceOperation = instanceOperation;
    }

    public IOperationTransient TransientOperation { get; }
    public IOperationScoped ScopedOperation { get; }
    public IOperationSingleton SingletonOperation { get; }
    public IOperationSingletonInstance SingletonInstanceOperation { get; }
}

Startup.ConfigureServices에서 각 형식이 명명된 수명에 따라 컨테이너에 추가됩니다.In Startup.ConfigureServices, each type is added to the container according to its named lifetime:

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    services.AddScoped<IMyDependency, MyDependency>();
    services.AddTransient<IOperationTransient, Operation>();
    services.AddScoped<IOperationScoped, Operation>();
    services.AddSingleton<IOperationSingleton, Operation>();
    services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

    // OperationService depends on each of the other Operation types.
    services.AddTransient<OperationService, OperationService>();
}
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    services.AddScoped<IMyDependency, MyDependency>();
    services.AddTransient<IOperationTransient, Operation>();
    services.AddScoped<IOperationScoped, Operation>();
    services.AddSingleton<IOperationSingleton, Operation>();
    services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

    // OperationService depends on each of the other Operation types.
    services.AddTransient<OperationService, OperationService>();
}

IOperationSingletonInstance 서비스는 알려진 ID가 Guid.Empty인 특정 인스턴스를 사용 중입니다.The IOperationSingletonInstance service is using a specific instance with a known ID of Guid.Empty. 이 형식이 사용 중인지 확실히 알 수 있습니다(해당 GUID가 모두 0).It's clear when this type is in use (its GUID is all zeroes).

샘플 앱에서는 개별 요청 내의 개체 수명과 요청 간의 개체 수명을 보여 줍니다.The sample app demonstrates object lifetimes within and between individual requests. 샘플 앱의 IndexModel은 각 종류의 IOperation 형식과 OperationService를 요청합니다.The sample app's IndexModel requests each kind of IOperation type and the OperationService. 그런 다음, 페이지에서는 속성 할당을 통해 페이지 모델 클래스 및 서비스의 OperationId 값을 모두 표시합니다.The page then displays all of the page model class's and service's OperationId values through property assignments:

public class IndexModel : PageModel
{
    private readonly IMyDependency _myDependency;

    public IndexModel(
        IMyDependency myDependency, 
        OperationService operationService,
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance singletonInstanceOperation)
    {
        _myDependency = myDependency;
        OperationService = operationService;
        TransientOperation = transientOperation;
        ScopedOperation = scopedOperation;
        SingletonOperation = singletonOperation;
        SingletonInstanceOperation = singletonInstanceOperation;
    }

    public OperationService OperationService { get; }
    public IOperationTransient TransientOperation { get; }
    public IOperationScoped ScopedOperation { get; }
    public IOperationSingleton SingletonOperation { get; }
    public IOperationSingletonInstance SingletonInstanceOperation { get; }

    public async Task OnGetAsync()
    {
        await _myDependency.WriteMessage(
            "IndexModel.OnGetAsync created this message.");
    }
}

샘플 앱에서는 개별 요청 내의 개체 수명과 요청 간의 개체 수명을 보여 줍니다.The sample app demonstrates object lifetimes within and between individual requests. 샘플 앱에는 각 종류의 IOperation 형식과 OperationService를 요청하는 OperationsController가 포함되어 있습니다.The sample app includes an OperationsController that requests each kind of IOperation type and the OperationService. Index 작업은 서비스의 OperationId 값을 표시하기 위해 서비스를 ViewBag으로 설정합니다.The Index action sets the services into the ViewBag for display of the service's OperationId values:

public class OperationsController : Controller
{
    private readonly OperationService _operationService;
    private readonly IOperationTransient _transientOperation;
    private readonly IOperationScoped _scopedOperation;
    private readonly IOperationSingleton _singletonOperation;
    private readonly IOperationSingletonInstance _singletonInstanceOperation;

    public OperationsController(
        OperationService operationService,
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance singletonInstanceOperation)
    {
        _operationService = operationService;
        _transientOperation = transientOperation;
        _scopedOperation = scopedOperation;
        _singletonOperation = singletonOperation;
        _singletonInstanceOperation = singletonInstanceOperation;
    }

    public IActionResult Index()
    {
        // Viewbag contains controller-requested services.
        ViewBag.Transient = _transientOperation;
        ViewBag.Scoped = _scopedOperation;
        ViewBag.Singleton = _singletonOperation;
        ViewBag.SingletonInstance = _singletonInstanceOperation;
        
        // Operation service has its own requested services.
        ViewBag.Service = _operationService;

        return View();
    }
}

다음 출력은 두 요청의 결과를 보여 줍니다.Two following output shows the results of two requests:

첫 번째 요청::First request:

컨트롤러 작업:Controller operations:

Transient: d233e165-f417-469b-a866-1cf1935d2518Transient: d233e165-f417-469b-a866-1cf1935d2518
Scoped: 5d997e2d-55f5-4a64-8388-51c4e3a1ad19Scoped: 5d997e2d-55f5-4a64-8388-51c4e3a1ad19
Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9
인스턴스: 00000000-0000-0000-0000-000000000000Instance: 00000000-0000-0000-0000-000000000000

OperationService 작업:OperationService operations:

Transient: c6b049eb-1318-4e31-90f1-eb2dd849ff64Transient: c6b049eb-1318-4e31-90f1-eb2dd849ff64
Scoped: 5d997e2d-55f5-4a64-8388-51c4e3a1ad19Scoped: 5d997e2d-55f5-4a64-8388-51c4e3a1ad19
Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9
인스턴스: 00000000-0000-0000-0000-000000000000Instance: 00000000-0000-0000-0000-000000000000

두 번째 요청:Second request:

컨트롤러 작업:Controller operations:

Transient: b63bd538-0a37-4ff1-90ba-081c5138dda0Transient: b63bd538-0a37-4ff1-90ba-081c5138dda0
Scoped: 31e820c5-4834-4d22-83fc-a60118acb9f4Scoped: 31e820c5-4834-4d22-83fc-a60118acb9f4
Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9
인스턴스: 00000000-0000-0000-0000-000000000000Instance: 00000000-0000-0000-0000-000000000000

OperationService 작업:OperationService operations:

Transient: c4cbacb8-36a2-436d-81c8-8c1b78808aafTransient: c4cbacb8-36a2-436d-81c8-8c1b78808aaf
Scoped: 31e820c5-4834-4d22-83fc-a60118acb9f4Scoped: 31e820c5-4834-4d22-83fc-a60118acb9f4
Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9Singleton: 01271bc1-9e31-48e7-8f7c-7261b040ded9
인스턴스: 00000000-0000-0000-0000-000000000000Instance: 00000000-0000-0000-0000-000000000000

어떤 OperationId 값이 요청 내 및 요청 간 달라지는지 확인합니다.Observe which of the OperationId values vary within a request and between requests:

  • Transient 개체는 항상 다릅니다.Transient objects are always different. 첫 번째와 두 번째 요청 모두의 임시 OperationId 값은 두 OperationService 작업과 요청 간에 다릅니다.Note that the transient OperationId value for both the first and second requests are different for both OperationService operations and across requests. 각 서비스와 요청에 새 인스턴스가 제공됩니다.A new instance is provided to each service and request.
  • Scoped 개체는 요청 내에서는 동일하지만 요청 간에는 다릅니다.Scoped objects are the same within a request but different across requests.
  • Singleton 개체는 ConfigureServicesOperation 인스턴스 제공 여부와 관계없이 모든 개체 및 모든 요청에 대해 동일합니다.Singleton objects are the same for every object and every request regardless of whether an Operation instance is provided in ConfigureServices.

Main에서 서비스 호출Call services from main

IServiceScopeFactory.CreateScope와 함께 IServiceScope를 만들어 앱 범위 내에서 범위가 지정된 서비스를 확인합니다.Create an IServiceScope with IServiceScopeFactory.CreateScope to resolve a scoped service within the app's scope. 이 방법은 시작 시 범위가 지정된 서비스에 액세스하여 초기화 작업을 실행하는 데 유용합니다.This approach is useful to access a scoped service at startup to run initialization tasks. 다음 예제에서는 Program.Main에서 MyScopedService에 대한 컨텍스트를 가져오는 방법을 보여 줍니다.The following example shows how to obtain a context for the MyScopedService in Program.Main:

public static void Main(string[] args)
{
    var host = CreateWebHostBuilder(args).Build();

    using (var serviceScope = host.Services.CreateScope())
    {
        var services = serviceScope.ServiceProvider;

        try
        {
            var serviceContext = services.GetRequiredService<MyScopedService>();
            // Use the context here
        }
        catch (Exception ex)
        {
            var logger = services.GetRequiredService<ILogger<Program>>();
            logger.LogError(ex, "An error occurred.");
        }
    }

    host.Run();
}

범위 유효성 검사Scope validation

앱이 개발 환경에서 실행 중인 경우 기본 서비스 공급자가 다음을 확인하는 검사를 수행합니다.When the app is running in the Development environment, the default service provider performs checks to verify that:

  • 범위가 지정된 서비스는 루트 서비스 공급자를 통해 간접적 또는 직접으로 확인되지 않습니다.Scoped services aren't directly or indirectly resolved from the root service provider.
  • 범위가 지정된 서비스는 직접 또는 간접적으로 싱글톤에 삽입되지 않습니다.Scoped services aren't directly or indirectly injected into singletons.

루트 서비스 공급자는 BuildServiceProvider를 호출할 때 만들어집니다.The root service provider is created when BuildServiceProvider is called. 루트 서비스 공급자의 수명은 공급자가 앱과 함께 시작되고 앱이 종료될 때 삭제되는 앱/서버의 수명에 해당합니다.The root service provider's lifetime corresponds to the app/server's lifetime when the provider starts with the app and is disposed when the app shuts down.

범위가 지정된 서비스는 서비스를 만든 컨테이너에 의해 삭제됩니다.Scoped services are disposed by the container that created them. 범위가 지정된 서비스가 루트 컨테이너에서 만들어지는 경우 서비스의 수명은 효과적으로 싱글톤으로 승격됩니다. 해당 서비스는 앱/서버가 종료될 때 루트 컨테이너에 의해서만 삭제되기 때문입니다.If a scoped service is created in the root container, the service's lifetime is effectively promoted to singleton because it's only disposed by the root container when app/server is shut down. 서비스 범위의 유효성 검사는 BuildServiceProvider가 호출될 경우 이러한 상황을 catch합니다.Validating service scopes catches these situations when BuildServiceProvider is called.

자세한 내용은 ASP.NET Core 웹 호스트을 참조하세요.For more information, see ASP.NET Core 웹 호스트.

요청 서비스Request Services

HttpContext의 ASP.NET Core 요청 내에서 사용할 수 있는 서비스는 HttpContext.RequestServices 컬렉션을 통해 노출됩니다.The services available within an ASP.NET Core request from HttpContext are exposed through the HttpContext.RequestServices collection.

요청 서비스는 앱의 일부로 구성 및 요청된 서비스를 나타냅니다.Request Services represent the services configured and requested as part of the app. 개체가 종속성을 지정한 경우에는 ApplicationServices가 아닌 RequestServices에 있는 형식으로 충족됩니다.When the objects specify dependencies, these are satisfied by the types found in RequestServices, not ApplicationServices.

일반적으로 앱은 이러한 속성을 직접 사용해서는 안 됩니다.Generally, the app shouldn't use these properties directly. 대신 클래스 생성자를 통해 클래스에 필요한 형식을 요청하고 프레임워크가 종속성을 주입하도록 합니다.Instead, request the types that classes require via class constructors and allow the framework inject the dependencies. 테스트하기 쉬운 클래스를 생성합니다.This yields classes that are easier to test.

참고

RequestServices 컬렉션에 액세스하는 것보다 생성자 매개 변수로 종속성을 요청하는 것을 선호합니다.Prefer requesting dependencies as constructor parameters to accessing the RequestServices collection.

종속성 주입을 위한 서비스 디자인Design services for dependency injection

모범 사례는 다음과 같습니다.Best practices are to:

  • 종속성 주입을 사용하여 종속성을 가져오도록 서비스를 디자인합니다.Design services to use dependency injection to obtain their dependencies.
  • 상태 저장 정적 메서드 호출(static cling이라는 방법)을 사용하지 마세요.Avoid stateful, static method calls (a practice known as static cling).
  • 서비스 내의 종속 클래스를 직접 인스턴스화하지 마세요.Avoid direct instantiation of dependent classes within services. 직접 인스턴스화는 코드를 특정 구현에 결합합니다.Direct instantiation couples the code to a particular implementation.

개체 지향 디자인의 SOLID 원칙에 따라 앱 클래스는 당연히 작고 잘 구성되며 쉽게 테스트되는 편입니다.By following the SOLID Principles of Object Oriented Design, app classes naturally tend to be small, well-factored, and easily tested.

클래스에 주입된 종속성이 너무 많아 보이면 일반적으로 클래스에 역할이 너무 많고 SRP(단일 책임 원칙)를 위반하는 것일 수 있습니다.If a class seems to have too many injected dependencies, this is generally a sign that the class has too many responsibilities and is violating the Single Responsibility Principle (SRP). 해당 책임 몇 가지를 새로운 클래스로 이동하여 클래스를 리팩터링해 보세요.Attempt to refactor the class by moving some of its responsibilities into a new class. Razor 페이지의 페이지 모델 클래스 및 MVC 컨트롤러 클래스는 UI 고려 사항에 집중해야 합니다.Keep in mind that Razor Pages page model classes and MVC controller classes should focus on UI concerns. 비즈니스 규칙 및 데이터 액세스 구현 세부 정보는 이러한 별도의 문제에 적합한 클래스에 유지되어야 합니다.Business rules and data access implementation details should be kept in classes appropriate to these separate concerns.

서비스 삭제Disposal of services

컨테이너는 만든 IDisposable 형식에 대해 Dispose를 호출합니다.The container calls Dispose for the IDisposable types it creates. 인스턴스가 사용자 코드로 컨테이너에 추가된 경우에는 자동으로 삭제되지 않습니다.If an instance is added to the container by user code, it isn't disposed automatically.

// Services that implement IDisposable:
public class Service1 : IDisposable {}
public class Service2 : IDisposable {}
public class Service3 : IDisposable {}

public interface ISomeService {}
public class SomeServiceImplementation : ISomeService, IDisposable {}

public void ConfigureServices(IServiceCollection services)
{
    // The container creates the following instances and disposes them automatically:
    services.AddScoped<Service1>();
    services.AddSingleton<Service2>();
    services.AddSingleton<ISomeService>(sp => new SomeServiceImplementation());

    // The container doesn't create the following instances, so it doesn't dispose of
    // the instances automatically:
    services.AddSingleton<Service3>(new Service3());
    services.AddSingleton(new Service3());
}

참고

ASP.NET Core 1.0에서 컨테이너는 만들지 않은 개체를 포함한 모든 IDisposable 개체에서 dispose를 호출했습니다.In ASP.NET Core 1.0, the container calls dispose on all IDisposable objects, including those it didn't create.

기본 서비스 컨테이너 바꾸기Default service container replacement

기본 제공 서비스 컨테이너는 프레임워크의 조건 및 대부분의 소비자 앱을 제공하는 것을 의미합니다.The built-in service container is meant to serve the needs of the framework and most consumer apps. 지원하지 않는 특정 기능이 필요하지 않는 한 기본 제공 컨테이너를 사용하는 것이 좋습니다.We recommend using the built-in container unless you need a specific feature that it doesn't support. 기본 제공 컨테이너에서 찾을 수 없는 타사 컨테이너에서 지원되는 일부 기능:Some of the features supported in 3rd party containers not found in the built-in container:

  • 속성 삽입Property injection
  • 이름을 기준으로 삽입Injection based on name
  • 자식 컨테이너Child containers
  • 사용자 지정 수명 관리Custom lifetime management
  • 초기화 지연에 대한 Func<T> 지원Func<T> support for lazy initialization

어댑터를 지원하는 일부 컨테이너의 목록은 종속성 주입 readme.md 파일을 참조하세요.See the Dependency Injection readme.md file for a list of some of the containers that support adapters.

다음 샘플은 기본 제공 컨테이너를 Autofac로 대체합니다.The following sample replaces the built-in container with Autofac:

  • 적절한 컨테이너 패키지를 설치합니다.Install the appropriate container package(s):

  • 컨테이너를 Startup.ConfigureServices에 구성하고 IServiceProvider를 반환합니다.Configure the container in Startup.ConfigureServices and return an IServiceProvider:

    public IServiceProvider ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();
        // Add other framework services
    
        // Add Autofac
        var containerBuilder = new ContainerBuilder();
        containerBuilder.RegisterModule<DefaultModule>();
        containerBuilder.Populate(services);
        var container = containerBuilder.Build();
        return new AutofacServiceProvider(container);
    }
    

    타사 컨테이너를 사용하려면 Startup.ConfigureServicesIServiceProvider를 반환해야 합니다.To use a 3rd party container, Startup.ConfigureServices must return IServiceProvider.

  • DefaultModule에 Autofac을 구성합니다.Configure Autofac in DefaultModule:

    public class DefaultModule : Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            builder.RegisterType<CharacterRepository>().As<ICharacterRepository>();
        }
    }
    

런타임 시 형식을 확인하고 종속성을 주입하는 데 Autofac이 사용됩니다.At runtime, Autofac is used to resolve types and inject dependencies. ASP.NET Core에서 Autofac을 사용하는 방법에 대한 자세한 내용은 Autofac documentation(Autofac 설명서)을 참조하세요.To learn more about using Autofac with ASP.NET Core, see the Autofac documentation.

스레드로부터의 안전성Thread safety

Singleton 서비스는 스레드로부터 안전해야 합니다.Singleton services need to be thread safe. Singleton 서비스가 Transient 서비스에 대한 종속성을 갖는 경우 Transient 서비스는 Singleton에서 사용되는 방식에 따라 스레드로부터 안전해야 할 수도 있습니다.If a singleton service has a dependency on a transient service, the transient service may also need to be thread safe depending how it's used by the singleton.

AddSingleton<TService>(IServiceCollection, Func<IServiceProvider,TService>)의 두 번째 인수와 같은 단일 서비스의 팩터리 메서드는 스레드로부터 안전할 필요가 없습니다.The factory method of single service, such as the second argument to AddSingleton<TService>(IServiceCollection, Func<IServiceProvider,TService>), doesn't need to be thread-safe. 형식(static) 생성자와 같이 이 메서드는 단일 스레드에서 한 번만 호출됩니다.Like a type (static) constructor, it's guaranteed to be called once by a single thread.

권장 사항Recommendations

  • async/awaitTask 기반 서비스 해결은 지원되지 않습니다.async/await and Task based service resolution is not supported. C#은 비동기 생성자를 지원하지 않으므로, 서비스를 동기식으로 해결한 후 비동기 메서드를 사용하는 것이 좋습니다.C# does not support asynchronous constructors, therefore the recommended pattern is to use asynchronous methods after synchronously resolving the service.

  • 데이터 및 구성을 서비스 컨테이너에 직접 저장하지 마세요.Avoid storing data and configuration directly in the service container. 예를 들어 사용자의 쇼핑 카트는 일반적으로 서비스 컨테이너에 추가하지 말아야 합니다.For example, a user's shopping cart shouldn't typically be added to the service container. 구성은 옵션 패턴을 사용해야 합니다.Configuration should use the options pattern. 마찬가지로 다른 일부 개체에 대한 액세스를 허용하기 위해서만 존재하는 “데이터 보유자” 개체를 사용하지 마십시오.Similarly, avoid "data holder" objects that only exist to allow access to some other object. DI를 통해 실제 항목을 요청하는 것이 좋습니다.It's better to request the actual item via DI.

  • 서비스에 정적으로 액세스(예를 들어 다른 곳에 사용하기 위해 IApplicationBuilder.ApplicationServices를 정적으로 입력)하지 마세요.Avoid static access to services (for example, statically-typing IApplicationBuilder.ApplicationServices for use elsewhere).

  • ‘서비스 로케이터 패턴’을 사용하지 마세요.Avoid using the service locator pattern. 예를 들어 DI를 대신 사용할 수 있는 경우 서비스 인스턴스를 가져오기 위해 GetService를 호출하지 마세요.For example, don't invoke GetService to obtain a service instance when you can use DI instead. 피해야 하는 또 다른 서비스 로케이터 변형은 런타임에 종속성을 해결하는 팩터리를 주입하는 것입니다.Another service locator variation to avoid is injecting a factory that resolves dependencies at runtime. 이러한 두 가지 방법 모두 제어 반전 전략을 혼합합니다.Both of these practices mix Inversion of Control strategies.

  • HttpContext(예: IHttpContextAccessor.HttpContext)에 정적으로 액세스하지 마세요.Avoid static access to HttpContext (for example, IHttpContextAccessor.HttpContext).

모든 권장 사항과 마찬가지로, 하나를 무시해야 하는 상황이 발생할 수 있습니다.Like all sets of recommendations, you may encounter situations where ignoring a recommendation is required. 예외는 드물게 발생하며, 대부분 프레임워크 자체 내에서 특별한 경우에만 발생합니다.Exceptions are rare—mostly special cases within the framework itself.

DI는 정적/전역 개체 액세스 패턴의 ‘대안’입니다.DI is an alternative to static/global object access patterns. 고정 개체 액세스와 함께 사용할 경우 DI의 장점을 실현할 수 없습니다.You may not be able to realize the benefits of DI if you mix it with static object access.

추가 자료Additional resources