Injektáž závislostí do kontrolerů v ASP.NET Core

Od Shadi Alnamrouti a Rick Anderson

ASP.NET řadičů Core MVC explicitně vyžaduje závislosti prostřednictvím konstruktorů. ASP.NET Core má integrovanou podporu injektáže závislostí (DI). Di usnadňuje testování a údržbu aplikací.

Zobrazení nebo stažení ukázkového kódu (postup stažení)

Injektáž konstruktoru

Služby se přidávají jako parametr konstruktoru a modul runtime překládá službu z kontejneru služby. Služby se obvykle definují pomocí rozhraní. Představte si například aplikaci, která vyžaduje aktuální čas. Následující rozhraní zpřístupňuje IDateTime službu:

public interface IDateTime
{
    DateTime Now { get; }
}

Následující kód implementuje IDateTime rozhraní:

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

Přidejte službu do kontejneru služby:

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

    services.AddControllersWithViews();
}

Další informace naleznete AddSingletonv tématu Životnosti služby DI.

Následující kód zobrazí uživateli pozdrav na základě denního času:

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

Spusťte aplikaci a zobrazí se zpráva podle času.

Injektáž akce s FromServices

Umožňuje FromServicesAttribute vložení služby přímo do metody akce bez použití injektáže konstruktoru:

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

Injektáž akce s FromKeyedServices

Následující kód ukazuje, jak přistupovat ke službám s klíči z kontejneru DI pomocí atributu [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");
    }
}

Nastavení přístupu z kontroleru

Přístup k nastavení aplikace nebo konfigurace z kontroleru je běžný vzor. Model možností popsaný v modelu Možnosti v ASP.NET Core je upřednostňovaným přístupem ke správě nastavení. Obecně platí, že přímo nesouvejte IConfiguration do kontroleru.

Vytvořte třídu, která představuje možnosti. Příklad:

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

Přidejte do kolekce služeb třídu konfigurace:

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

    services.AddControllersWithViews();
}

Nakonfigurujte aplikaci tak, aby načetla nastavení ze souboru ve formátu 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>();
            });
}

Následující kód požaduje IOptions<SampleWebSettings> nastavení z kontejneru služby a používá je v Index metodě:

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

Další materiály

• V tématu Logika kontroleru testů v ASP.NET Core se dozvíte, jak usnadnit testování kódu explicitním vyžádáním závislostí v kontroleru.
• Podpora kontejneru injektáže závislostí služby s klíči
• Nahraďte výchozí kontejner injektáže závislostí implementací třetí strany.