Injeção de dependência em controladores no ASP.NET Core

Artigo
11/30/2023

Controladores do ASP.NET Core MVC solicitam dependências explicitamente por meio de construtores. O ASP.NET Core tem suporte interno para DI (injeção de dependência). A injeção de dependência torna mais fácil testar e manter aplicativos.

Exibir ou baixar código de exemplo (como baixar)

Injeção de construção

Os serviços são adicionados como um parâmetro de construtor e o runtime resolve o serviço de contêiner de serviço. Os serviços são normalmente definidos usando interfaces. Por exemplo, considere um aplicativo que exige a hora atual. A interface a seguir expõe o serviço IDateTime:

public interface IDateTime
{
    DateTime Now { get; }
}

O código a seguir implementa a interface IDateTime:

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

Adicione o serviço ao contêiner de serviço:

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

    services.AddControllersWithViews();
}

Para obter mais informações sobre AddSingleton, veja tempos de vida do serviço DI.

O código a seguir exibe uma saudação ao usuário com base na hora do dia:

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

Execute o aplicativo e será exibida uma mensagem com base no horário.

Injeção de ação com `FromServices`

O FromServicesAttribute habilita a injeção de um serviço diretamente em um método de ação sem usar a injeção de construtor:

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

Injeção de ação com `FromKeyedServices`

O código a seguir mostra como acessar serviços com chave do contêiner DI por meio do atributo [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");
    }
}

Acessar configurações de um controlador

Acessar definições de configuração ou do aplicativo de dentro de um controlador é um padrão comum. O padrão de opções descrito em Padrão de opções no ASP.NET Core é a abordagem preferencial para gerenciar as configurações. Em geral, não convém injetar IConfiguration diretamente em um controlador.

Crie uma classe que representa as opções. Por exemplo:

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

Adicione a classe de configuração à coleção de serviços:

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

    services.AddControllersWithViews();
}

Configure o aplicativo para ler as configurações de um arquivo formatado em 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>();
            });
}

O código a seguir solicita as configurações IOptions<SampleWebSettings> do contêiner de serviço e usa-as no método 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();
    }
}

Recursos adicionais

Confira Tetar a lógica do controlador no ASP.NET Core para facilitar o teste do código ao solicitar dependências explicitamente em controladores.
Suporte a contêiner de injeção de dependência de serviço com chave
Substitui o contêiner de injeção de dependência padrão por uma implementação de terceiros.

Por Shadi Alnamrouti, Rick Anderson e Steve Smith

Exibir ou baixar código de exemplo (como baixar)

Injeção de construção

public interface IDateTime
{
    DateTime Now { get; }
}

O código a seguir implementa a interface IDateTime:

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

Adicione o serviço ao contêiner de serviço:

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

    services.AddControllersWithViews();
}

Para obter mais informações sobre AddSingleton, veja tempos de vida do serviço DI.

O código a seguir exibe uma saudação ao usuário com base na hora do dia:

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

Execute o aplicativo e será exibida uma mensagem com base no horário.

Injeção de ação com `FromServices`

O FromServicesAttribute habilita a injeção de um serviço diretamente em um método de ação sem usar a injeção de construtor:

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

Acessar configurações de um controlador

Crie uma classe que representa as opções. Por exemplo:

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

Adicione a classe de configuração à coleção de serviços:

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

    services.AddControllersWithViews();
}

Configure o aplicativo para ler as configurações de um arquivo formatado em 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>();
            });
}

O código a seguir solicita as configurações IOptions<SampleWebSettings> do contêiner de serviço e usa-as no método 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();
    }
}

Recursos adicionais

Confira Tetar a lógica do controlador no ASP.NET Core para facilitar o teste do código ao solicitar dependências explicitamente em controladores.
Substitui o contêiner de injeção de dependência padrão por uma implementação de terceiros.

Por Shadi Namrouti, Rick Anderson e Steve Smith

Exibir ou baixar código de exemplo (como baixar)

Injeção de construção

public interface IDateTime
{
    DateTime Now { get; }
}

O código a seguir implementa a interface IDateTime:

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

Adicione o serviço ao contêiner de serviço:

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

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

Para obter mais informações sobre AddSingleton, veja tempos de vida do serviço DI.

O código a seguir exibe uma saudação ao usuário com base na hora do dia:

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

Execute o aplicativo e será exibida uma mensagem com base no horário.

Injeção de ação com `FromServices`

O FromServicesAttribute habilita a injeção de um serviço diretamente em um método de ação sem usar a injeção de construtor:

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

    return View();
}

Acessar configurações de um controlador

Crie uma classe que representa as opções. Por exemplo:

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

Adicione a classe de configuração à coleção de serviços:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IDateTime, SystemDateTime>();
    services.Configure<SampleWebSettings>(Configuration);
    
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

Configure o aplicativo para ler as configurações de um arquivo formatado em JSON:

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

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            config.AddJsonFile("samplewebsettings.json", 
                                optional: false,        // File is not optional.
                                reloadOnChange: false);
        })
        .UseStartup<Startup>();
}

O código a seguir solicita as configurações IOptions<SampleWebSettings> do contêiner de serviço e usa-as no método 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();
    }
}

Recursos adicionais

Confira Tetar a lógica do controlador no ASP.NET Core para facilitar o teste do código ao solicitar dependências explicitamente em controladores.
Substitui o contêiner de injeção de dependência padrão por uma implementação de terceiros.

Compartilhar via

Injeção de dependência em controladores no ASP.NET Core

Injeção de construção

Injeção de ação com FromServices

Injeção de ação com FromKeyedServices

Acessar configurações de um controlador

Recursos adicionais

Injeção de construção

Injeção de ação com FromServices

Acessar configurações de um controlador

Recursos adicionais

Injeção de construção

Injeção de ação com FromServices

Acessar configurações de um controlador

Recursos adicionais

Recursos adicionais

Injeção de ação com `FromServices`

Injeção de ação com `FromKeyedServices`

Injeção de ação com `FromServices`

Injeção de ação com `FromServices`