Внедрение зависимостей в контроллеры в ASP.NET Core
Шади Альнамрути и Рик Андерсон
Контроллеры ASP.NET Core MVC запрашивают зависимости явно с помощью конструкторов. ASP.NET Core имеет встроенную поддержку внедрения зависимостей (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, см. в разделе Время существования службы внедрения зависимости.
Следующий код отображает приветствие пользователю в зависимости от времени дня:
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 , чтобы узнать, как упростить тестирование кода путем явного запроса зависимостей в контроллерах.
- Поддержка контейнера внедрения зависимостей к ключу службы
- Замените контейнер внедрения зависимостей по умолчанию на стороннюю реализацию.
Шади Альнамрути, Рик Андерсон и Стив Смит
Контроллеры ASP.NET Core MVC запрашивают зависимости явно с помощью конструкторов. ASP.NET Core имеет встроенную поддержку внедрения зависимостей (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, см. в разделе Время существования службы внедрения зависимости.
Следующий код отображает приветствие пользователю в зависимости от времени дня:
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}");
}
Доступ к параметрам из контроллера
Доступ к параметрам приложения или конфигурации из контроллера относится к типичным шаблонам. Шаблон параметров, описанный в шаблоне параметров в 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 , чтобы узнать, как упростить тестирование кода путем явного запроса зависимостей в контроллерах.
Замените контейнер внедрения зависимостей по умолчанию на стороннюю реализацию.
Авторы: Shadi Namrouti (Шади Намрути), Рик Андерсон (Rick Anderson) и Стив Смит (Steve Smith)
Контроллеры ASP.NET Core MVC запрашивают зависимости явно с помощью конструкторов. ASP.NET Core имеет встроенную поддержку внедрения зависимостей (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.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
Дополнительные сведения о AddSingleton, см. в разделе Время существования службы внедрения зависимости.
Следующий код отображает приветствие пользователю в зависимости от времени дня:
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)
{
ViewData["Message"] = $"Current server time: {dateTime.Now}";
return View();
}
Доступ к параметрам из контроллера
Доступ к параметрам приложения или конфигурации из контроллера относится к типичным шаблонам. Шаблон параметров, описанный в шаблоне параметров в 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.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
Настройте приложение для чтения параметров из файла формата 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>();
}
Следующий код запрашивает параметры 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 , чтобы узнать, как упростить тестирование кода путем явного запроса зависимостей в контроллерах.
Замените контейнер внедрения зависимостей по умолчанию на стороннюю реализацию.
ASP.NET Core