我的一个依赖项(DbContext)是使用WebApiRequestLifestyle范围注册的。
现在,我的后台工作使用IoC并依赖于使用WebApiRequestLifestyle在上面注册的服务。当Hangfire调用我为后台作业注册的方法时,我想知道这是如何工作的。由于不涉及web api,DbContext是否会被视为一个transistent对象?
任何指导都会很棒!
这是我在启动时出现的初始化代码:
public void Configuration(IAppBuilder app)
{
var httpConfig = new HttpConfiguration();
var container = SimpleInjectorWebApiInitializer.Initialize(httpConfig);
var config = (IConfigurationProvider)httpConfig.DependencyResolver
.GetService(typeof(IConfigurationProvider));
ConfigureJwt(app, config);
ConfigureWebApi(app, httpConfig, config);
ConfigureHangfire(app, container);
}
private void ConfigureHangfire(IAppBuilder app, Container container)
{
Hangfire.GlobalConfiguration.Configuration
.UseSqlServerStorage("Hangfire");
Hangfire.GlobalConfiguration.Configuration
.UseActivator(new SimpleInjectorJobActivator(container));
app.UseHangfireDashboard();
app.UseHangfireServer();
}
public static Container Initialize(HttpConfiguration config)
{
var container = new Container();
container.Options.DefaultScopedLifestyle = new WebApiRequestLifestyle();
InitializeContainer(container);
container.RegisterMvcControllers(Assembly.GetExecutingAssembly());
container.RegisterWebApiControllers(config);
container.RegisterMvcIntegratedFilterProvider();
container.Register<Mailer>(Lifestyle.Scoped);
container.Register<PortalContext>(Lifestyle.Scoped);
container.RegisterSingleton<TemplateProvider, TemplateProvider>();
container.Verify();
DependencyResolver.SetResolver(new SimpleInjectorDependencyResolver(container));
config.DependencyResolver = new SimpleInjectorWebApiDependencyResolver(container);
return container;
}
以下是启动后台工作的代码:
public class MailNotificationHandler : IAsyncNotificationHandler<FeedbackCreated>
{
private readonly Mailer mailer;
public MailNotificationHandler(Mailer mailer)
{
this.mailer = mailer;
}
public Task Handle(FeedbackCreated notification)
{
BackgroundJob.Enqueue<Mailer>(x => x.SendFeedbackToSender(notification.FeedbackId));
BackgroundJob.Enqueue<Mailer>(x => x.SendFeedbackToManagement(notification.FeedbackId));
return Task.FromResult(0);
}
}
最后,这是在后台线程上运行的代码:
public class Mailer
{
private readonly PortalContext dbContext;
private readonly TemplateProvider templateProvider;
public Mailer(PortalContext dbContext, TemplateProvider templateProvider)
{
this.dbContext = dbContext;
this.templateProvider = templateProvider;
}
public void SendFeedbackToSender(int feedbackId)
{
Feedback feedback = dbContext.Feedbacks.Find(feedbackId);
Send(TemplateType.FeedbackSender, new { Name = feedback.CreateUserId });
}
public void SendFeedbackToManagement(int feedbackId)
{
Feedback feedback = dbContext.Feedbacks.Find(feedbackId);
Send(TemplateType.FeedbackManagement, new { Name = feedback.CreateUserId });
}
public void Send(TemplateType templateType, object model)
{
MailMessage msg = templateProvider.Get(templateType, model).ToMailMessage();
using (var client = new SmtpClient())
{
client.Send(msg);
}
}
}
答案 0 :(得分:4)
我想知道当Hangfire调用我为后台作业注册的方法时这是如何工作的。由于不涉及web api,DbContext是否会被视为一个transistent对象?
正如design decisions所述,Simple Injector永远不会允许您解析活动范围之外的实例。这样DbContext就不会被解析为瞬态或单身;如果没有范围,Simple Injector将抛出异常。
每种应用类型都需要自己的范围生活方式。 Web API需要AsyncScopedLifestyle
(在先前版本WebApiRequestLifestyle
中),WCF为WcfOperationLifestyle
,MVC为WebRequestLifestyle
。对于Windows服务,您通常会使用AsyncScopedLifestyle
。
如果您的Hangfire作业在Windows服务中运行,则必须使用ThreadScopedLifestyle
或AsyncScopedLifestyle
。这些范围需要明确的启动。
在Web(或Web API)应用程序中的后台线程上运行作业时,无法访问所需的上下文,这意味着如果您尝试这样做,Simple Injector将抛出异常。
但您正在使用Hangfire.SimpleInjector
集成库。该库实现了一个名为JobActivator
的自定义SimpleInjectorJobActivator
实现,此实现将在后台线程上为您创建一个Scope
。 Hangfire实际上会在此执行上下文范围的上下文中解析您的Mailer
。因此,Mailer
中的MailNotificationHandler
构造函数参数实际上从未使用过; Hangfire将为您解决此类问题。
WebApiRequestLifestyle
和AsyncScopedLifestyle
可以互换; WebApiRequestLifestyle
在后台使用执行上下文作用域,SimpleInjectorWebApiDependencyResolver
实际上启动了执行上下文作用域。所以有趣的是你的WebApiRequestLifestyle
也可以用于后台操作(虽然它可能有点令人困惑)。所以你的解决方案可以正常工作。
但是,在MVC中运行时,这将无效,在这种情况下,您必须创建Hybrid lifestyle,例如:
var container = new Container();
container.Options.DefaultScopedLifestyle = Lifestyle.CreateHybrid(
new AsyncScopedLifestyle(),
new WebRequestLifestyle());
您可以按如下方式注册DbContext:
container.Register<DbContext>(() => new DbContext(...), Lifestyle.Scoped);
如果您不介意,可以在此处获得有关您的应用程序设计的一些反馈。
防止让应用程序代码(例如MailNotificationHandler
)直接依赖外部库(如Hangfire)。这直接违反了依赖性倒置原则,使您的应用程序代码非常难以测试和维护。相反,只让您的Composition Root(连接依赖项的地方)依赖于Hangfire。在你的情况下,解决方案非常简单,我甚至会说愉快,它看起来如下:
public interface IMailer
{
void SendFeedbackToSender(int feedbackId);
void SendFeedbackToManagement(int feedbackId);
}
public class MailNotificationHandler : IAsyncNotificationHandler<FeedbackCreated>
{
private readonly IMailer mailer;
public MailNotificationHandler(IMailer mailer)
{
this.mailer = mailer;
}
public Task Handle(FeedbackCreated notification)
{
this.mailer.SendFeedbackToSender(notification.FeedbackId));
this.mailer.SendFeedbackToManagement(notification.FeedbackId));
return Task.FromResult(0);
}
}
这里我们添加了一个新的IMailer
抽象,并使MailNotificationHandler
依赖于这个新的抽象;不知道存在任何后台处理。现在靠近配置服务的部分,定义一个{@ 1}}代理,将调用转发给Hangfire:
IMailer
这需要以下注册:
// Part of your composition root
private sealed class HangfireBackgroundMailer : IMailer
{
public void SendFeedbackToSender(int feedbackId) {
BackgroundJob.Enqueue<Mailer>(m => m.SendFeedbackToSender(feedbackId));
}
public void SendFeedbackToManagement(int feedbackId) {
BackgroundJob.Enqueue<Mailer>(m => m.SendFeedbackToManagement(feedbackId));
}
}
这里我们将新的container.Register<IMailer, HangfireBackgroundMailer>(Lifestyle.Singleton);
container.Register<Mailer>(Lifestyle.Transient);
映射到HangfireBackgroundMailer
抽象。这可确保IMailer
注入BackgroundMailer
,而MailNotificationHandler
类在后台线程启动时由Hangfire解析。 Mailer
的注册是可选的,但是可取的,因为它已成为根对象,并且由于它具有依赖性,我们希望Simple Injector知道此类型以允许它验证和诊断此注册。 / p>
我希望您同意从Mailer
的角度来看,应用程序现在更加清晰。