Abp后台工作者類使用hangfire

一、Abp中的后台工作及后台工作者類

請閱讀這篇文章

二 、Abp官方實現的缺點

Abp官方實現方式很簡單，也很容易上手，但缺點是工作者類依賴了具體的基類（PeriodicBackgroundWorkerBase），就會存在應用程序耦合。

 

為什么會耦合呢，假設以后想采用HangFire或Quartz.NET來調度工作者，我們就需要把所有工作類的基類進行修改，這不利於系統的維護和可擴展，而且采用官方實現無法監測和管控工作者。

 

三、開始改造

1、核心庫

 要消除工作者類對具體調度類的依賴，則只能讓后台工作者類繼承自不含調度實現的基類(BackgroundWorkerBase)或直接實現接口(IBackgroundWorker)。我定義了一個泛型基類(BackgroundWorker<T>)，該基類繼承ABP核心庫的BackgroundWorkerBase，同時該基類必須實現我自定定義的IBackgroundWorkerDo接口。

BackgroundWorker<T>：所有后台工作者類都該繼承的基類，加泛型參數的目的是Hangfire的RecurringJob.AddOrUpdate<T>方法在創建輪詢任務時必須知道它該調用哪個類的哪個方法

IBackgroundWorkerDo:  約束所有后台工作者類必須實現DoWork，配合泛型參數，Hangfire的輪詢任務便可以知道T類型一定會有一個DoWork方法，然后在RecurringJob.AddOrUpdate<T>的方法體中便可以調用T類型實的DoWork方法

WorkerConfig類: 每個后台工作者都應該有一個唯一的標識，執行間隔時間，這樣輪詢代理類才知道如何處理

IBackgroudWorkerProxy: 代替后台工作者類執行其DoWork方法，所有輪詢調度類都應該實現該接口

    /// <summary>
    /// 所有的后台工作者類都應實現該接口
    /// </summary>
    public interface IBackgroundWorkerDo
    {
        /// <summary>
        /// 執行具體的任務
        /// </summary>
        void DoWork();
    }

 

    /// <summary>
    /// 所有后台工作者類都應繼承該類
    /// </summary>
    public abstract class BackgroundWorker<T> : BackgroundWorkerBase, IBackgroundWorkerDo where T : IBackgroundWorkerDo
    {
        protected readonly IBackgroudWorkerProxy _workProxy;
        protected readonly WorkerConfig _config;
        protected BackgroundWorker(IBackgroudWorkerProxy workProxy, WorkerConfig config)
        {
            _workProxy = workProxy;
            _config = config;
        }
        /// <summary>
        /// 任務啟動
        /// </summary>
        public override void Start()
        {
            Logger.Debug("輪詢任務啟動");
            _workProxy.Excete<T>(DoWork, _config); //主要指定當前任務類，不然hangfire無法調用，不然可以移到父類去
        }
        /// <summary>
        /// 具體的任務執行
        /// </summary>
        public abstract void DoWork();
    }

 

    /// <summary>
    /// 工作任務配置
    /// </summary>
    public class WorkerConfig
    {
        /// <summary>
        /// 輪詢秒數
        /// </summary>
        public int IntervalSecond { get; set; }
        /// <summary>
        /// 工作唯一編號
        /// </summary>
        public string WorkerId { get; set; }
    }

    public interface IBackgroudWorkerProxy
    {
        /// <summary>
        /// 執行
        /// </summary>
        /// <param name="method"></param>
        void Excete<T>(Action method, WorkerConfig config) where T : IBackgroundWorkerDo;
    }

 

以上便是解耦的核心代碼，在核心代碼中，仿照Abp官方的PeriodicBackgroundWorkerBase類提供了一個基於Timer的輪詢調度實現：

   public class PeriodicWorkerPxoxy : IBackgroudWorkerProxy
    {
        private Action ExetuteMethod { get; set; }
        protected readonly AbpTimer Timer;
        public PeriodicWorkerPxoxy(AbpTimer timer)
        {
            Timer = timer;
            Timer.Elapsed += Timer_Elapsed;
        }

        private void Timer_Elapsed(object sender, EventArgs e)
        {
            try
            {
                DoWork();
            }
            catch (Exception ex)
            {

            }
        }

        public void Excete<T>(Action method, WorkerConfig config) where T: IBackgroundWorkerDo
        {
            ExetuteMethod = method;
            Timer.Period = config.IntervalSecond*1000;//將傳入的秒數轉化為毫秒
            Timer.Start();
        }

        protected  void DoWork()
        {
            ExetuteMethod();
        }
    }

作為一個核心模塊，所以還需要定義一個模塊啟動配置文件

public class FastWorkWorkerPxoxyModule : AbpModule
    {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
        }
        public override void PreInitialize()
        {
            IocManager.RegisterIfNot<IBackgroudWorkerProxy, PeriodicWorkerPxoxy>();
        }
    }

 

核心庫解決方案圖如下,(記住要引用Abp核心庫)

在需要的項目中引入該Dll，然后按照模塊啟動配置依賴進行配置

    [DependsOn(typeof(AbpZeroCoreModule), typeof(AbpZeroLdapModule), typeof(AbpAutoMapperModule), typeof(FastWorkWorkerPxoxyModule))]
    public class FastWorkCoreModule : AbpModule
    {
          ...
    }

后台工作者類示例：

namespace ORS.FastWork.Core.Sms
{
    /// <summary>
    /// 清理短信日志
    /// </summary>
    public class SmsWorker : BackgroundWorker<SmsWorker>, ISingletonDependency
    {
        private readonly IRepository<SmsSendLog, long> _smsLogRepository;
        public SmsWorker(IRepository<SmsSendLog, long> smsLogRepository,IBackgroudWorkerProxy workMiddleware) : base(workMiddleware, new WorkerConfig { IntervalSecond=60,WorkerId="smsworker"})
        {
            _smsLogRepository = smsLogRepository;
        }
        public override void DoWork()
        {
            //_smsLogRepository.Insert(new SmsSendLog { IsOk = true, Content = "輪詢任務創建的", CreationTime = DateTime.Now });
        }
    }
}

 

 

2、HangFire實現

主要的類有兩個，一個是啟動配置，一個實現了IBackgroudWorkerProxy接口，解決方案目錄如下：

解決方案記得引用上面定義好的核心庫,Hangfire實現輪詢的代碼如下：

  public class HangfireWorkerPxoxy : IBackgroudWorkerProxy
    {
        public HangfireWorkerPxoxy()
        {

        }
        private WorkerConfig Config { get; set; }
        public void Excete<T>(Action method, WorkerConfig config) where T: IBackgroundWorkerDo
        {
            Config = config;
            string workerId = config.WorkerId;
            string cron = Cron.MinuteInterval(config.IntervalSecond/60);
            RecurringJob.AddOrUpdate<T>(config.WorkerId, (t)=>t.DoWork(), cron,TimeZoneInfo.Local);
            RecurringJob.Trigger(config.WorkerId);
        }
    }

 模塊啟動文件中的代碼很關鍵，當后台工作采用了Hangfire來調度時(即在web模塊的啟動文件中使用了 Configuration.BackgroundJobs.UseHangfire(...))，則后台工作者類的調度也將由我們核心庫中的PeriodicWorkerPxoxy變更為Hangfire來接管

 public class HangFireWorkerModule : AbpModule
 {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
        }
        public override void PreInitialize()
        {
            IocManager.RegisterIfNot<IBackgroudWorkerProxy, HangfireWorkerPxoxy>();
        }
        public override void PostInitialize()
        {
            //判斷是否啟用了hangfire，如果啟用了，則將IBackgroudWorkerProxy的實例改為hangfire
            var hangfireConfig = IocManager.Resolve<IAbpHangfireConfiguration>();
            if (hangfireConfig?.Server!= null) {
                IocManager.IocContainer.Register(Component.For<IBackgroudWorkerProxy>().ImplementedBy<HangfireWorkerPxoxy>().IsDefault());
            }
        }
}

 

 在Web項目中引用該項目，然后在模塊啟動中加入對該模塊的依賴

在PostInitialize方法中向后台工作管理類加入具體的工作

最終效果如下：

 

3.進一步優化

該方案目前已在我們公司的項目中投入使用，由於時間和精力關系，我個人沒有對該方案進行進一步優化。在web模塊啟動文件中，還是需要做兩步工作：1.引用了dll 2.啟動文件上標注依賴關系，每增加一種輪詢調度方式我們都需要重復這兩步，如果想做得更靈活的話，可以弄成插件模塊（拷入dll到站點PlugIns目錄，然后再后台設置一下即可），下一篇文章我會以短信網關插件實戰來演示Abp插件模塊的妙用。