使用ASP.NET Core DI解析实例

时间:2015-09-08 13:53:47

标签: c# dependency-injection asp.net-core asp.net-core-mvc

如何使用ASP.NET Core MVC内置依赖注入框架手动解析类型?

设置容器非常简单:

public void ConfigureServices(IServiceCollection services)
{
    // ...

    services.AddTransient<ISomeService, SomeConcreteService>();
}

但是如何在不执行注射的情况下解决ISomeService?例如,我想这样做:

ISomeService service = services.Resolve<ISomeService>();

IServiceCollection中没有此类方法。

8 个答案:

答案 0 :(得分:315)

IServiceCollection接口用于构建依赖注入容器。在完全构建之后,它将被组合到IServiceProvider实例,您可以使用它来解析服务。您可以将IServiceProvider注入任何课程。 IApplicationBuilderHttpContext类也可以分别通过ApplicationServicesRequestServices属性为服务提供商提供。

IServiceProvider定义了解析服务的GetService(Type type)方法:

var service = (IFooService)serviceProvider.GetService(typeof(IFooService));

还有一些便利扩展方法,例如serviceProvider.GetService<IFooService>()。 (为Microsoft.Extensions.DependencyInjection添加一个用途。)

解析启动类中的服务

注入依赖项

运行时可以在Startup类的构造函数中注入服务,例如IHostingEnvironmentIConfigurationIServiceProvider。请注意,此服务提供商是由托管层构建的实例,仅包含启动应用程序的服务。

也可以使用Configure()方法注入服务。您可以在IApplicationBuilder参数后添加任意数量的参数。您还可以注入您在ConfigureServices()方法中注册的自己的服务,它们将从应用程序服务提供商而非托管服务提供商处解析。

public void Configure(IApplicationBuilder app, IFooService fooService)
{
   // ...
}

ConfigureServices()方法不允许注入服务,它只接受IServiceCollection参数。这是配置应用程序依赖项注入容器的方法。您可以在此处使用在启动构造函数中注入的服务。例如:

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}

public IConfiguration Configuration { get; }

public void ConfigureServices(IServiceCollection services)
{
    // Use Configuration here
}

手动解决依赖关系

如果要手动解析服务,可以让运行时在构造函数中注入IServiceProvider实例,或者使用ApplicationServices方法中IApplicationBuilder提供的Configure()

public Startup(IServiceProvider serviceProvider)
{
    var hostingEnv = serviceProvider.GetService<IHostingEnvironment>();
}

public void Configure(IApplicationBuilder app)
{
    var serviceProvider = app.ApplicationServices;
    var hostingEnv = serviceProvider.GetService<IHostingEnvironment>();
}

但是,如果您需要使用ConfigureServices()方法解析服务,则需要采用不同的方法。您可以从IServiceProvider实例构建中间IServiceCollection,其中包含在此之前注册的服务:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IFooService, FooService>();

    // Build the intermediate service provider
    var sp = services.BuildServiceProvider();
    var fooService = sp.GetService<IFooService>();
}

您需要Microsoft.Extensions.DependencyInjection包。

请注意:
通常,您不应该在ConfigureServices()方法中解析服务,因为这实际上是您配置应用程序服务的地方。有时您只需要访问某个IOptions<MyOptions>实例。您可以通过将IConfiguration实例中的值绑定到MyOptions的实例(这实际上是选项框架的功能)来实现此目的:

public void ConfigureServices(IServiceCollection services)
{
    var myOptions = new MyOptions();
    Configuration.GetSection("SomeSection").Bind(myOptions);
}

一般来说,手动解析服务(又名服务定位器)是known as an anti-pattern。虽然它有用例(对于框架和/或基础设施层),但你应该尽可能地避免使用它。

答案 1 :(得分:67)

手动解析实例涉及使用IServiceProvider界面:

解决Startup.ConfigureServices中的依赖关系

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<IMyService, MyService>();

    var serviceProvider = services.BuildServiceProvider();
    var service = serviceProvider.GetService<IMyService>();
}

解决Startup.Configure

中的依赖项
public void Configure(
    IApplicationBuilder application,
    IServiceProvider serviceProvider)
{
    // By type.
    var service1 = (MyService)serviceProvider.GetService(typeof(MyService));

    // Using extension method.
    var service2 = serviceProvider.GetService<MyService>();

    // ...
}

使用运行时注入服务

某些类型可以作为方法参数注入:

public class Startup
{
    public Startup(
        IHostingEnvironment hostingEnvironment,
        ILoggerFactory loggerFactory)
    {
    }

    public void ConfigureServices(
        IServiceCollection services)
    {
    }

    public void Configure(
        IApplicationBuilder application,
        IHostingEnvironment hostingEnvironment,
        IServiceProvider serviceProvider,
        ILoggerFactory loggerfactory,
        IApplicationLifetime applicationLifetime)
    {
    }
}

解决控制器操作中的依赖关系

[HttpGet("/some-action")]
public string SomeAction([FromServices] IMyService myService) => "Hello";

答案 2 :(得分:13)

如果您使用模板生成应用程序,那么Startup类将会有类似的内容:

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddApplicationInsightsTelemetry(Configuration);

    services.AddMvc();
}

然后,您可以在那里添加依赖项,例如:

services.AddTransient<ITestService, TestService>();

如果您想在控制器上访问ITestService,可以在构造函数上添加IServiceProvider,然后注入:

public HomeController(IServiceProvider serviceProvider)

然后您可以解决您添加的服务:

var service = serviceProvider.GetService<ITestService>();

请注意,要使用通用版本,您必须在命名空间中包含扩展名:

using Microsoft.Extensions.DependencyInjection;

ITestService.cs

public interface ITestService
{
    int GenerateRandom();
}

TestService.cs

public class TestService : ITestService
{
    public int GenerateRandom()
    {
        return 4;
    }
}

Startup.cs(ConfigureServices)

public void ConfigureServices(IServiceCollection services)
{
    services.AddApplicationInsightsTelemetry(Configuration);
    services.AddMvc();

    services.AddTransient<ITestService, TestService>();
}

HomeController.cs

using Microsoft.Extensions.DependencyInjection;

namespace Core.Controllers
{
    public class HomeController : Controller
    {
        public HomeController(IServiceProvider serviceProvider)
        {
            var service = serviceProvider.GetService<ITestService>();
            int rnd = service.GenerateRandom();
        }

答案 3 :(得分:1)

如果只需要解析一个依赖项以将其传递给正在注册的另一个依赖项的构造函数,则可以执行此操作。

假设您有一个接受字符串和ISomeService的服务。

public class AnotherService : IAnotherService
{
    public AnotherService(ISomeService someService, string serviceUrl)
    {
        ...
    }
}

当您在Startup.cs中进行注册时,您需要执行以下操作:

services.AddScoped<IAnotherService>(ctx => 
      new AnotherService(ctx.GetService<ISomeService>(), "https://someservice.com/")
);

答案 4 :(得分:1)

您可以通过这种方式使用 IApplicationBuilder 实例注入依赖项

public void Configure(IApplicationBuilder app)
    {
        //---------- Your code
        
        using (var serviceScope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>().CreateScope())
        {
            var resultLogic = serviceScope.ServiceProvider.GetService<IResultLogic>();
            resultLogic.YourMethod();
        }           

        //---------- Your code
    }

答案 5 :(得分:0)

您可以通过这种方式在诸如AuthorizeAttribute之类的属性中注入依赖项

var someservice = (ISomeService)context.HttpContext.RequestServices.GetService(typeof(ISomeService));

答案 6 :(得分:0)

我知道这是一个老问题,但我惊讶的是这里没有一个相当明显且令人作呕的骇客。

您可以利用定义自己的ctor函数的能力来在定义服务时从服务中获取必要的值……显然,每次请求该服务时都会运行该值,除非您明确删除/清除并重新添加该服务的定义在利用ctor的第一个构造中

此方法的优点是在服务配置期间不需要您构建或使用服务树。您仍在定义如何配置服务。

public void ConfigureServices(IServiceCollection services)
{
    //Prey this doesn't get GC'd or promote to a static class var
    string? somevalue = null;

    services.AddSingleton<IServiceINeedToUse, ServiceINeedToUse>(scope => {
         //create service you need
         var service = new ServiceINeedToUse(scope.GetService<IDependantService>())
         //get the values you need
         somevalue = somevalue ?? service.MyDirtyHack();
         //return the instance
         return service;
    });
    services.AddTransient<IOtherService, OtherService>(scope => {
         //Explicitly ensuring the ctor function above is called, and also showcasing why this is an anti-pattern.
         scope.GetService<IServiceINeedToUse>();
         //TODO: Clean up both the IServiceINeedToUse and IOtherService configuration here, then somehow rebuild the service tree.
         //Wow!
         return new OtherService(somevalue);
    });
}

解决此模式的方法是给OtherService一个对IServiceINeedToUse的显式依赖,而不是隐式地依赖于它或其方法的返回值...或在某些情况下显式地解决该依赖关系。其他时尚。

答案 7 :(得分:-5)

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

    services.AddDbContext<ConfigurationRepository>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("SqlConnectionString")));

    services.AddScoped<IConfigurationBL, ConfigurationBL>();
    services.AddScoped<IConfigurationRepository, ConfigurationRepository>();
}