使用ASP.NET Core 2.0将简单的Injector组件注入IHostedService

时间:2018-05-17 15:01:43

标签: c# dependency-injection asp.net-core-2.0 simple-injector

在ASP.NET Core 2.0中,有一种方法可以通过实现IHostedService接口来添加后台任务(请参阅https://docs.microsoft.com/en-us/aspnet/core/fundamentals/hosted-services?view=aspnetcore-2.0)。通过本教程,我能够使它工作的方式是在ASP.NET Core容器中注册它。我的目标是从队列中读取消息并在后台处理作业;消息将发布到队列中(通过控制器操作),然后在后台以定时间隔进行处理。

// Not registered in SimpleInjector
services.AddSingleton<IHostedService, MyTimedService>(); 

当我将此注册放在ASP.NET Core容器中时,它会在应用程序启动时自动启动该过程。但是,当我在SimpleInjector中注册时,服务不会自动启动。我相信这是因为我们只使用MvcControllers和MvcViewComponents注册SimpleInjector容器:

// Wire up simple injector to the MVC components
container.RegisterMvcControllers(app);
container.RegisterMvcViewComponents(app);

我遇到的问题是当我想开始从SimpleInjector注入组件寄存器(例如存储库,带有装饰器的通用处理程序......)到IHostedService的实现中时,如下所示:

public class TimedService : IHostedService, IDisposable
{
    private IJobRepository _repo;
    private Timer _timer;

    public TimedService(IJobRepository repo)
    {
        this._repo = repo;
    }
    ...
    ...
    ...
}

由于IHostedService已在ASP.NET Core而非Simple Injector中注册,因此在运行定时后台服务时收到以下错误:

  

未处理的异常:System.InvalidOperationException:无法解析类型&#39; Optimization.Core.Interfaces.IJobRepository&#39;的服务。在尝试激活&#39; Optimization.API.BackgroundServices.TimedService&#39;。

所以我的问题是,在Simple Injector中实现后台任务的最佳方法是什么?这是否需要一个独立的集成包而不是标准的MVC集成?我怎样才能将我的Simple Injector注册注入IHostedService?如果我们可以在Simple Injector中注册后自动启动服务,我认为这样可以解决这个问题。

感谢您在此提出任何建议以及有关此主题的任何建议!我可能做错了什么。在过去的一年里,我非常喜欢使用Simple Injector。

2 个答案:

答案 0 :(得分:12)

有多种方法可以解决这个问题。最简单的方法可能是以内置配置系统从Simple Injector解析托管服务的方式交叉连接托管服务:

// Register in Simple Injector as Singleton
container.RegisterSingleton<THostedService>();

// Cross-wire TimedService in the built-in configuration system
services.AddSingleton<IHostedService>(
    c => container.GetInstance<TimedService>());

请注意,托管服务只需解析一次,并且可以永久缓存,从而有效地使它们成为单身人士。这就是为什么你应该把它作为Singleton注册在Simple Injector中。

然而,概念是,您无法将任何ScopedTransient个依赖项注入托管服务。最重要的是,它会强制您让应用程序组件(TimedService)依赖于ASP.NET Core抽象(IHostedService)。这不太理想。

因此,我首选的方法是创建一个适配器实现,您可以向ASP.NET Core配置系统注册,该系统将调用转发给Simple Injector,同时使用特定于应用程序的抽象来实现您的服务。因此,创建许多IHostedService实现,您可以定义一个特定且适合您的应用程序的抽象。让我们称之为抽象IMyJob

IHostedService适配器实现可能如下所示:

public class SimpleInjectorJobProcessorHostedService : IHostedService, IDisposable
{
    private readonly Container container;
    private Timer timer;

    public SimpleInjectorJobProcessorHostedService(Container c) => this.container = c;

    public Task StartAsync(CancellationToken cancellationToken)
    {
        this.timer = new Timer(this.DoWork, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));
        return Task.CompletedTask;
    }

    private void DoWork(object state)
    {
        // Run operation in a scope
        using (AsyncScopedLifestyle.BeginScope(this.container))
        {
            // Resolve the collection of IMyJob implementations
            foreach (var service in this.container.GetAllInstances<IMyJob>())
            {
                service.DoWork();
            }
        }
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        this.timer?.Change(Timeout.Infinite, 0);
        return Task.CompletedTask;
    }

    public void Dispose() => this.timer?.Dispose();
}

您可以在ASP.NET核心中注册它,如下所示:

services.AddSingleton<IHostedService>(
    new SimpleInjectorJobProcessorHostedService(container)); 

这样,您运行的实际作业可能无视ASP.NET Core,可以定义如下:

public class CoolJob : IMyJob
{
    private readonly IJobRepository repo;

    public CoolJob(IJobRepository repo) => this.repo = repo;

    public void DoWork() => ...
}

所有工作都可以在Simple Injector中注册,如下所示:

 // NOTE: Simple Injector v4.3 API
container.Collection.Register<IMyJob>(typeof(CoolJob).Assembly);

答案 1 :(得分:0)

我将连接到HostBuilder的ConfigureContainer方法并在其中设置simpleinjectore,如下所示:

                   IHostBuilder()
                   .ConfigureContainer<ServiceCollection>((builder, services) =>
                   {
                       var container = new Container();

                       container.RegisterSingleton<IJobRepository, JobRepository>();
                       services.AddTransient<IHostedService, TimedService>();

                   })
                   .ConfigureServices((hostContext, services) =>
                   {
                       // Originally we would have done this
                       //services.AddHostedService<Service>();
                   })
                   .Build();

        using (host)
        {
            await host.StartAsync();
            await host.WaitForShutdownAsync();
        }

虽然确实可以使用IHostedService实现,但我认为它可能隐藏正在发生的事情。我相信基础架构自举应该在一个地方完成,或者至少在一个地方精心策划。我认为容器是基础架构,可以通过HostBuilder方法将其与应用程序的其余部分一起设置。

一个附加的优势还可能是您不完全替换ServiceCollection,因为它可以很好地完成其他与框架相关的事情。我仍将使用ServiceCollection做一些事情的例子:

                   IHostBuilder()
                   .ConfigureServices((hostContext, services) =>
                   {
                       services.AddLogging();
                       services.AddOptions();
                   })

这与simpleinjector文档中有关使用ASP.NET Core设置容器的说明一致:

  

Simple Injector的实践是使用Simple Injector构建应用程序组件的对象图,并让内置容器构建框架和第三方组件。SimpleInjector的实践是使用Simple Injector进行构建应用程序组件的对象图,并让内置容器构建框架和第三方组件

.net核心和通用HostBuilder也应如此。