ASP.NET Core의 컨트롤러에 종속성 주입

샤 디 알남루티 와 릭 앤더슨

ASP.NET Core MVC 컨트롤러는 생성자를 통해 명시적으로 종속성을 요청합니다. ASP.NET Core는 기본적으로 DI(종속성 주입 )를 지원합니다. DI를 사용하면 앱의 테스트와 유지 관리가 쉬워집니다.

샘플 코드 보기 및 다운로드(다운로드 방법)

생성자 주입

서비스는 생성자 매개 변수로 추가되며, 런타임은 서비스 컨테이너에서 서비스를 해결합니다. 서비스는 일반적으로 인터페이스를 사용하여 정의됩니다. 예를 들어, 현재 시간이 필요한 앱을 고려해보세요. 다음 인터페이스는 IDateTime 서비스를 노출합니다.

public interface IDateTime
{
    DateTime Now { get; }
}

다음 코드는 IDateTime 인터페이스를 구현합니다.

public class SystemDateTime : IDateTime
{
    public DateTime Now
    {
        get { return DateTime.Now; }
    }
}

서비스를 서비스 컨테이너에 추가합니다.

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IDateTime, SystemDateTime>();

    services.AddControllersWithViews();
}

AddSingleton에 대한 자세한 내용은 DI 서비스 수명을 참조하세요.

다음 코드는 현재 시간을 기준으로 사용자에게 인사말을 표시합니다.

public class HomeController : Controller
{
    private readonly IDateTime _dateTime;

    public HomeController(IDateTime dateTime)
    {
        _dateTime = dateTime;
    }

    public IActionResult Index()
    {
        var serverTime = _dateTime.Now;
        if (serverTime.Hour < 12)
        {
            ViewData["Message"] = "It's morning here - Good Morning!";
        }
        else if (serverTime.Hour < 17)
        {
            ViewData["Message"] = "It's afternoon here - Good Afternoon!";
        }
        else
        {
            ViewData["Message"] = "It's evening here - Good Evening!";
        }
        return View();
    }

앱을 실행하면 시간을 기준으로 메시지가 표시됩니다.

FromServices을 사용하여 작업 주입

FromServicesAttribute를 사용하면 생성자 주입을 사용하지 않고 작업 메서드에 직접 서비스를 주입할 수 있습니다.

public IActionResult About([FromServices] IDateTime dateTime)
{
    return Content( $"Current server time: {dateTime.Now}");
}

FromKeyedServices을 사용하여 작업 주입

다음 코드에서는 특성을 사용하여 DI 컨테이너에서 키 서비스에 액세스하는 [FromKeyedServices] 방법을 보여 줍니다.

using Microsoft.AspNetCore.Mvc;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddKeyedSingleton<ICache, BigCache>("big");
builder.Services.AddKeyedSingleton<ICache, SmallCache>("small");
builder.Services.AddControllers();

var app = builder.Build();

app.MapControllers();

app.Run();

public interface ICache
{
    object Get(string key);
}
public class BigCache : ICache
{
    public object Get(string key) => $"Resolving {key} from big cache.";
}

public class SmallCache : ICache
{
    public object Get(string key) => $"Resolving {key} from small cache.";
}

[ApiController]
[Route("/cache")]
public class CustomServicesApiController : Controller
{
    [HttpGet("big")]
    public ActionResult<object> GetBigCache([FromKeyedServices("big")] ICache cache)
    {
        return cache.Get("data-mvc");
    }

    [HttpGet("small")]
    public ActionResult<object> GetSmallCache([FromKeyedServices("small")] ICache cache)
    {
        return cache.Get("data-mvc");
    }
}

컨트롤러에서 설정 액세스

컨트롤러 내에서 앱 또는 구성 설정에 액세스하는 것은 일반적인 패턴입니다. ASP.NET Core의 옵션 패턴에 설명된 옵션 패턴은 설정을 관리하는 데 선호되는 방법입니다. 일반적으로 컨트롤러에 IConfiguration을 직접 주입하지 마세요.

옵션을 나타내는 클래스를 만듭니다. 예시:

public class SampleWebSettings
{
    public string Title { get; set; }
    public int Updates { get; set; }
}

서비스 컬렉션에 구성 클래스를 추가합니다.

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IDateTime, SystemDateTime>();
    services.Configure<SampleWebSettings>(Configuration);

    services.AddControllersWithViews();
}

JSON 형식 파일에서 설정을 읽도록 앱을 구성합니다.

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.AddJsonFile("samplewebsettings.json",
                    optional: false,
                    reloadOnChange: true);
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

다음 코드는 서비스 컨테이너에서 IOptions<SampleWebSettings> 설정을 요청하고 이를 Index 메서드에 사용합니다.

public class SettingsController : Controller
{
    private readonly SampleWebSettings _settings;

    public SettingsController(IOptions<SampleWebSettings> settingsOptions)
    {
        _settings = settingsOptions.Value;
    }

    public IActionResult Index()
    {
        ViewData["Title"] = _settings.Title;
        ViewData["Updates"] = _settings.Updates;
        return View();
    }
}

추가 리소스

• 컨트롤러에서 종속성을 명시적으로 요청하여 코드를 더 쉽게 테스트할 수 있는 방법을 알아보려면 ASP.NET Core에서 컨트롤러 논리 테스트를 참조하세요.
• 키 지정된 서비스 종속성 주입 컨테이너 지원
• 기본 종속성 주입 컨테이너를 타사 구현으로 바꿉니다.