如何在封闭系统中注入正确的具体类

本文关键字:注入 系统 | 更新日期: 2023-09-27 18:04:44

Hangfire看起来相当光滑。然而,我有一个挑战,让Hangfire激活正确的具体类。

一些背景:

public interface IJob
{
    bool Execute(string payload);
}
public interface IJobPayload
{
    string UserId { get; set; }
    string JobName { get; set; }
    string JobQueueName { get; set; }
    int Id { get; set; }
    JobType JobType { get; set; }
    CronExpression Cron { get; set; }
}

现在,我有(潜在的)数百个所有继承自IJob的作业,并在继承自IJobPayload的有效负载上执行。在不深入了解每个作业的执行代码的情况下,我有如下内容:

[Queue("critical")] class Job1 : IJob {...}
[Queue("doors")] class Job2 : IJob {...}
[Queue("doors")] class Job3 : IJob {...}
[Queue("lights")] class Job4 : IJob {...}
[Queue("lights")] class Job5 : IJob {...}
[Queue("adhoc")] class Job6 : IJob {...}
...
[Queue("critical")] class JobN : IJob {...}

提供一个基本作业的示例:

public class JobDoorStatusChanged : IJob
{
    [Queue("doors")]
    public bool Execute(string payload)
    {
        var command = JsonConvert.DeserializeObject<Payload>(payload);
        // handle execution here...
        return true/false;
    }
    public class Payload : IJobPayload
    {
        public string UserId { get; set; }
        public string JobName { get; set; }
        public string JobQueueName { get; set; }
        public int Id { get; set; }
        public JobType JobType { get; set; }
        public CronExpression Cron { get; set; }
    }
}

我有一个Web API Post控制器,非常简单:

[HttpPost]
public string Post()
{
    var payload = Request.Content.ReadAsStringAsync().Result;
    var queueHandler = new QueueHandler();
    return queueHandler.Load(payload);
}

下一步就是我遇到失败的地方。他和我要成为最好的朋友了。不幸的是!

Hangfire有4个Enqueue方法(2个同步,2个异步):

public static string Enqueue([NotNull, InstantHandle] Expression<Action> methodCall)
public static string Enqueue([NotNull, InstantHandle] Expression<Func<Task>> methodCall)
public static string Enqueue<T>([NotNull, InstantHandle] Expression<Action<T>> methodCall)
public static string Enqueue<T>([NotNull, InstantHandle] Expression<Func<T, Task>> methodCall)

它们要么接受静态类:

var id = BackgroundJob.Enqueue(() => MyStaticJob.Execute(payload));

或者它们采用一个应该可以从Unity解析的类型:

var id = BackgroundJob.Enqueue<ConcreteJobDefinition>(a => a.Execute(payload));

因为我有几十个,分数甚至太多的对象都是基于IJob这两个入口点都不适合我。

我甚至尝试用一个类来包装我所有的工作,并让Hangfire执行这个类,到目前为止,没有运气:

public interface IJobService
{
    bool Execute(string payload);
}
public class JobService : IJobService
{
    private readonly IUnityContainer _container = UnityConfig.GetConfiguredContainer();
    public bool Execute(string payload)
    {
        var command = JsonConvert.DeserializeObject<PayloadStub>(payload);
        var job = _container.Resolve<IJob>(command.JobName);
        return job.Execute(payload);
    }
    internal class PayloadStub : IJobPayload
    {
        public string UserId { get; set; }
        public string JobName { get; set; }
        public string JobQueueName { get; set; }
        public int Id { get; set; }
        public JobType JobType { get; set; }
        public CronExpression Cron { get; set; }
    }
}

现在我可以这样执行一个具体的实现(这是混淆!):

var id = BackgroundJob.Enqueue<JobService>(a => a.Execute(payload));

还没有!,你失去了Queue Attribute从每一个作业!

所以,我回到startup.cs文件:
public partial class Startup
{
    public void Configuration(IAppBuilder app)
    {
        Framework.Initialize(); // internal framework here at work...
        AreaRegistration.RegisterAllAreas();
        GlobalConfiguration.Configure(WebApiConfig.Register);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
        UnityConfig.RegisterUnity();           // <== UNITY ==
        ConfigureAuth(app);
        HangfireConfig.RegisterHangfire(app);  // <== HANGFIRE ==
    }
}
类UnityConfig:

public class UnityConfig
{
    public static void RegisterUnity()
    {
        var container = Sol3.Web.WebApi.App_Start.UnityConfig.GetConfiguredContainer();
        // Register Auth & Exception handlers...
        container.RegisterType<IAccessDeniedResult, AccessDeniedResult>();
        container.RegisterType<IExceptionResult, ExceptionResult>();
        container.RegisterType<IJobService, JobService>();
        // Register all IJob concrete implementations found in this project...
        container.RegisterTypes(
            AllClasses.FromLoadedAssemblies().Where(type => typeof(IJob).IsAssignableFrom(type) && type.IsClass),
            WithMappings.FromAllInterfaces,
            t => t.IsNested ? t.DeclaringType.Name + "." + t.Name : t.Name,
            WithLifetime.Transient);
    }
}
类HangfireConfig:

public class HangfireConfig
{
    public static void RegisterHangfire(IAppBuilder app)
    {
        GlobalConfiguration.Configuration.UseSqlServerStorage(Globals.DatabaseHangfire);
        GlobalJobFilters.Filters.Add(new LogAttribute());
        app.UseHangfireDashboard();
        var options = new BackgroundJobServerOptions
        {
            Queues = Globals.QueueNames,
            Activator = new UnityJobActivator(Sol3.Web.WebApi.App_Start.UnityConfig.GetConfiguredContainer()),
        };
        app.UseHangfireServer(options);
    }
}

我看不出有什么不对。Unity拥有所有的注册。因为我有这么多基于单一接口的对象,我知道我破坏了Unity通常用于依赖注入的方式。

任何想法吗?您可以看到对代码的任何调整?

TIA

如何在封闭系统中注入正确的具体类

看起来开发人员发现了一个错误并修复了它。我现在正在测试它,到目前为止,它看起来很有前途。

Hangfire Issue #656

我还发现了我的定义错误。我需要将Executebool更改为void返回类型。

我有一个类似的问题,并使用称为JobHandler<T>的通用包装器来对作业进行排队。它是这样工作的:

首先,一个基本的JobHandler:

public abstract class JobHandler
{
    public abstract void Enqueue(string payload);
}

接下来是JobHandler<T>,它将使用Hangfire作为正确的具体类型来处理队列:

public abstract class JobHandler<T> : JobHandler 
    where T: IJob
{
    public override void Enqueue(string payload)
    {
        BackgroundJob.Enqueue<T>(x => x.Execute(payload));
    }
}

JobHandler<T>不一定需要是抽象的,但在我的情况下,我有处理程序执行的附加逻辑,并为每个作业类型提供它的具体实现。然后将每种类型的处理程序注册到我的应用程序中,我可以简单地执行:

JobHandler handler = Activator.CreateInstance(GetHandler("MyJobType")) as JobHandler;
handler.Enqueue(payload)

应该很容易做同样的事情,使用Unity来解决JobHandler。也就是说,我不确定这比简单地解决IJob和排队实例提供了多少好处,现在导致您的问题的bug已经修复了。

虽然核心概念略有不同,而且可能有更简洁的方法,但您可以尝试将Jobs注册为IEnumerable,然后根据名称选择所需的Jobs。我有一个相关的问题,我想根据传入的标准为一个实现处理N个处理程序。我在博客上写了一篇文章。

在这个Stack Overflow答案中有一个Unity的例子