Wstrzykiwanie zależności do kontrolerów w ASP.NET Core
Przez Shadi Alnamrouti i Rick Anderson
ASP.NET podstawowe 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ć)
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 uwidacznia 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 AddSingletonusługi , zobacz Okresy istnienia usługi 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.
Funkcja FromServicesAttribute umożliwia wstrzykiwanie usługi bezpośrednio do metody akcji bez użycia iniekcji konstruktora:
public IActionResult About([FromServices] IDateTime dateTime)
{
return Content( $"Current server time: {dateTime.Now}");
}
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");
}
}
Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec opcji opisany w temacie Wzorzec opcji w ASP.NET Core jest preferowanym podejściem do zarządzania ustawieniami. Ogólnie rzecz biorąc, nie należy bezpośrednio wprowadzać IConfiguration do kontrolera.
Utwórz klasę reprezentującą opcje. Na 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();
}
}
- Zobacz Logika kontrolera testów w programie ASP.NET Core , aby dowiedzieć się, jak ułatwić testowanie kodu przez jawne żądanie zależności w kontrolerach.
- Obsługa kontenera wstrzykiwania zależności usługi kluczy
- Zastąp domyślny kontener wstrzykiwania zależności implementacją innej firmy.
Przez Shadi Alnamrouti, Rick Anderson i Steve Smith
ASP.NET podstawowe 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ć)
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 uwidacznia 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 AddSingletonusługi , zobacz Okresy istnienia usługi 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.
Funkcja FromServicesAttribute umożliwia wstrzykiwanie usługi bezpośrednio do metody akcji bez użycia iniekcji konstruktora:
public IActionResult About([FromServices] IDateTime dateTime)
{
return Content( $"Current server time: {dateTime.Now}");
}
Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec opcji opisany w temacie Wzorzec opcji w ASP.NET Core jest preferowanym podejściem do zarządzania ustawieniami. Ogólnie rzecz biorąc, nie należy bezpośrednio wprowadzać IConfiguration do kontrolera.
Utwórz klasę reprezentującą opcje. Na 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();
}
}
Zobacz Logika kontrolera testów w programie ASP.NET Core , aby dowiedzieć się, jak ułatwić testowanie kodu przez jawne żądanie zależności w kontrolerach.
Zastąp domyślny kontener wstrzykiwania zależności implementacją innej firmy.
Przez Shadi Namrouti, Rick Anderson i Steve Smith
ASP.NET podstawowe 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ć)
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 uwidacznia 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 AddSingletonusługi , zobacz Okresy istnienia usługi 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.
Funkcja FromServicesAttribute umożliwia wstrzykiwanie usługi bezpośrednio do metody akcji bez użycia iniekcji konstruktora:
public IActionResult About([FromServices] IDateTime dateTime)
{
ViewData["Message"] = $"Current server time: {dateTime.Now}";
return View();
}
Uzyskiwanie dostępu do ustawień aplikacji lub konfiguracji z poziomu kontrolera jest typowym wzorcem. Wzorzec opcji opisany w temacie Wzorzec opcji w ASP.NET Core jest preferowanym podejściem do zarządzania ustawieniami. Ogólnie rzecz biorąc, nie należy bezpośrednio wprowadzać IConfiguration do kontrolera.
Utwórz klasę reprezentującą opcje. Na 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();
}
}
Zobacz Logika kontrolera testów w programie ASP.NET Core , aby dowiedzieć się, jak ułatwić testowanie kodu przez jawne żądanie zależności w kontrolerach.
Zastąp domyślny kontener wstrzykiwania zależności implementacją innej firmy.
Opinia o produkcie ASP.NET Core
ASP.NET Core to projekt typu open source. Wybierz link, aby przekazać opinię: