Wstrzykiwanie zależności do kontrolerów w ASP.NET Core

Autor: Rick Anderson

ASP.NET Core kontrolery MVC żądają zależności jawnie za pośrednictwem konstruktorów. ASP.NET Core ma wbudowaną obsługę wstrzykiwania zależności (DI). Di ułatwia testowanie i konserwację aplikacji.

Wyświetl lub pobierz przykładowy kod (jak pobrać)

Wstrzykiwanie konstruktora

Usługi są dodawane jako parametr konstruktora, a środowisko uruchomieniowe rozpoznaje usługę z kontenera usługi. Usługi są zwykle definiowane przy użyciu interfejsów. Rozważmy na przykład aplikację, która wymaga bieżącego czasu. Następujący interfejs udostępnia usługę IDateTime:

public interface IDateTime
{
    DateTime Now { get; }
}

Poniższy kod implementuje IDateTime interfejs:

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

Dodaj usługę do kontenera usługi:

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

    services.AddControllersWithViews();
}

Aby uzyskać więcej informacji na temat AddSingleton, zobacz Cykle życia usług DI.

Poniższy kod wyświetla powitanie dla użytkownika na podstawie godziny dnia:

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

Uruchom aplikację i zostanie wyświetlony komunikat na podstawie czasu.

Wstrzykiwanie akcji za pomocą FromServices

Element FromServicesAttribute umożliwia wstrzyknięcie usługi bezpośrednio do metody akcji bez użycia wstrzykiwania przez konstruktor:

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

Wstrzykiwanie akcji za pomocą FromKeyedServices

Poniższy kod pokazuje, jak uzyskać dostęp do usług kluczy z kontenera DI przy użyciu atrybutu [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");
    }
}

Wstrzykiwanie właściwości za pomocą FromServices

FromServicesAttribute można również zastosować do właściwości publicznych w kontrolerze MVC. Środowisko uruchomieniowe rozpoznaje i wypełnia te właściwości z kontenera DI podczas wiązania modelu:

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [FromServices]
    public required ILogger<WeatherForecastController> Logger { get; set; }

    [FromServices]
    public required IWeatherService WeatherService { get; set; }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        Logger.LogInformation("Fetching weather forecast");
        return WeatherService.GetForecast();
    }
}

Uwaga / Notatka

Wstrzykiwanie właściwości przy użyciu [FromServices] jest obsługiwane we właściwościach kontrolera z publicznymi setterami. Nie jest obsługiwana w przypadku usług ogólnie rozpoznawanych za pośrednictwem kontenera wstrzykiwania zależności.

Ustawienia dostępu z kontrolera

Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec options opisany w Options w ASP.NET Core jest preferowaną metodą zarządzania ustawieniami. Zasadniczo nie należy bezpośrednio wstrzykiwać IConfiguration do kontrolera.

Utwórz klasę reprezentującą opcje. Przykład:

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

Dodaj klasę konfiguracji do kolekcji usług:

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

    services.AddControllersWithViews();
}

Skonfiguruj aplikację do odczytywania ustawień z pliku w formacie 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>();
            });
}

Poniższy kod żąda IOptions<SampleWebSettings> ustawień z kontenera usługi i używa ich w metodzie 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();
    }
}

Kontrolery jako usługi

Domyślnie ASP.NET Core nie rejestruje kontrolerów jako usług w kontenerze DI. Środowisko uruchomieniowe używa klasy DefaultControllerActivator do tworzenia instancji kontrolera i pobierania usług z kontenera DI dla parametrów konstruktora, ale sam kontroler nie jest pobierany z kontenera.

Wywołanie AddControllersAsServices rejestruje wszystkie kontrolery jako usługi w kontenerze DI:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllersWithViews().AddControllersAsServices();

Rejestrowanie kontrolerów jako usług umożliwia:

  • Przechwytywanie tworzenia kontrolera za pomocą niestandardowego IControllerActivator.
  • Używanie dowolnego zarządzania cyklem życia DI w odniesieniu do kontrolerów.
  • Wstrzykiwanie usług do kontrolerów przy użyciu dowolnego zarejestrowanego konstruktora, ponieważ kontener DI wybiera konstruktora.

Uwaga / Notatka

Skonfiguruj ApplicationPartManagerprzed wywołaniem AddControllersAsServices. Aby uzyskać szczegółowe informacje, odniesienie się do Udostępnianie kontrolerów, widoków, stron i więcej za pomocą Składników aplikacji w ASP.NET CoreRazor.

Autorzy: Rick Anderson i Steve Smith

ASP.NET Core kontrolery MVC żądają zależności jawnie za pośrednictwem konstruktorów. ASP.NET Core ma wbudowaną obsługę wstrzykiwania zależności (DI). Di ułatwia testowanie i konserwację aplikacji.

Wyświetl lub pobierz przykładowy kod (jak pobrać)

Wstrzykiwanie konstruktora

Usługi są dodawane jako parametr konstruktora, a środowisko uruchomieniowe rozpoznaje usługę z kontenera usługi. Usługi są zwykle definiowane przy użyciu interfejsów. Rozważmy na przykład aplikację, która wymaga bieżącego czasu. Następujący interfejs udostępnia usługę IDateTime:

public interface IDateTime
{
    DateTime Now { get; }
}

Poniższy kod implementuje IDateTime interfejs:

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

Dodaj usługę do kontenera usługi:

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

    services.AddControllersWithViews();
}

Aby uzyskać więcej informacji na temat AddSingleton, zobacz Cykle życia usług DI.

Poniższy kod wyświetla powitanie dla użytkownika na podstawie godziny dnia:

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

Uruchom aplikację i zostanie wyświetlony komunikat na podstawie czasu.

Wstrzykiwanie akcji za pomocą FromServices

Element FromServicesAttribute umożliwia wstrzyknięcie usługi bezpośrednio do metody akcji bez użycia wstrzykiwania przez konstruktor:

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

Ustawienia dostępu z kontrolera

Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec options opisany w Options w ASP.NET Core jest preferowaną metodą zarządzania ustawieniami. Zasadniczo nie należy bezpośrednio wstrzykiwać IConfiguration do kontrolera.

Utwórz klasę reprezentującą opcje. Przykład:

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

Dodaj klasę konfiguracji do kolekcji usług:

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

    services.AddControllersWithViews();
}

Skonfiguruj aplikację do odczytywania ustawień z pliku w formacie 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>();
            });
}

Poniższy kod żąda IOptions<SampleWebSettings> ustawień z kontenera usługi i używa ich w metodzie 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();
    }
}

Kontrolery jako usługi

Domyślnie ASP.NET Core nie rejestruje kontrolerów jako usług w kontenerze DI. Środowisko uruchomieniowe używa klasy DefaultControllerActivator do tworzenia instancji kontrolera i pobierania usług z kontenera DI dla parametrów konstruktora, ale sam kontroler nie jest pobierany z kontenera.

Wywołanie AddControllersAsServices rejestruje wszystkie kontrolery jako usługi w kontenerze DI:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews().AddControllersAsServices();
}

Rejestrowanie kontrolerów jako usług umożliwia:

  • Przechwytywanie tworzenia kontrolera za pomocą niestandardowego IControllerActivator.
  • Używanie dowolnego zarządzania cyklem życia DI w odniesieniu do kontrolerów.
  • Wstrzykiwanie usług do kontrolerów przy użyciu dowolnego zarejestrowanego konstruktora, ponieważ kontener DI wybiera konstruktora.

Uwaga / Notatka

Skonfiguruj ApplicationPartManagerprzed wywołaniem AddControllersAsServices. Aby uzyskać szczegółowe informacje, odniesienie się do Udostępnianie kontrolerów, widoków, stron i więcej za pomocą Składników aplikacji w ASP.NET CoreRazor.

Dodatkowe zasoby

ASP.NET Core kontrolery MVC żądają zależności jawnie za pośrednictwem konstruktorów. ASP.NET Core ma wbudowaną obsługę wstrzykiwania zależności (DI). Di ułatwia testowanie i konserwację aplikacji.

Wyświetl lub pobierz przykładowy kod (jak pobrać)

Wstrzykiwanie konstruktora

Usługi są dodawane jako parametr konstruktora, a środowisko uruchomieniowe rozpoznaje usługę z kontenera usługi. Usługi są zwykle definiowane przy użyciu interfejsów. Rozważmy na przykład aplikację, która wymaga bieżącego czasu. Następujący interfejs udostępnia usługę IDateTime:

public interface IDateTime
{
    DateTime Now { get; }
}

Poniższy kod implementuje IDateTime interfejs:

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

Dodaj usługę do kontenera usługi:

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

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

Aby uzyskać więcej informacji na temat AddSingleton, zobacz Cykle życia usług DI.

Poniższy kod wyświetla powitanie dla użytkownika na podstawie godziny dnia:

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

Uruchom aplikację i zostanie wyświetlony komunikat na podstawie czasu.

Wstrzykiwanie akcji za pomocą FromServices

Element FromServicesAttribute umożliwia wstrzyknięcie usługi bezpośrednio do metody akcji bez użycia wstrzykiwania przez konstruktor:

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

    return View();
}

Ustawienia dostępu z kontrolera

Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec options opisany w Options w ASP.NET Core jest preferowaną metodą zarządzania ustawieniami. Zasadniczo nie należy bezpośrednio wstrzykiwać IConfiguration do kontrolera.

Utwórz klasę reprezentującą opcje. Przykład:

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

Dodaj klasę konfiguracji do kolekcji usług:

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

Skonfiguruj aplikację do odczytywania ustawień z pliku w formacie 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>();
}

Poniższy kod żąda IOptions<SampleWebSettings> ustawień z kontenera usługi i używa ich w metodzie 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();
    }
}

Kontrolery jako usługi

Domyślnie ASP.NET Core nie rejestruje kontrolerów jako usług w kontenerze DI. Środowisko uruchomieniowe używa klasy DefaultControllerActivator do tworzenia instancji kontrolera i pobierania usług z kontenera DI dla parametrów konstruktora, ale sam kontroler nie jest pobierany z kontenera.

Wywołanie AddControllersAsServices rejestruje wszystkie kontrolery jako usługi w kontenerze DI:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc().AddControllersAsServices();
}

Rejestrowanie kontrolerów jako usług umożliwia:

  • Przechwytywanie tworzenia kontrolera za pomocą niestandardowego IControllerActivator.
  • Używanie dowolnego zarządzania cyklem życia DI w odniesieniu do kontrolerów.
  • Wstrzykiwanie usług do kontrolerów przy użyciu dowolnego zarejestrowanego konstruktora, ponieważ kontener DI wybiera konstruktora.

Uwaga / Notatka

Skonfiguruj ApplicationPartManagerprzed wywołaniem AddControllersAsServices. Aby uzyskać szczegółowe informacje, odniesienie się do Udostępnianie kontrolerów, widoków, stron i więcej za pomocą Składników aplikacji w ASP.NET CoreRazor.

Dodatkowe zasoby