Merge pull request #13921 from abpframework/liangshiwei/hangfire

Hangfire support specific queue

docs/en/Background-Jobs-Hangfire.md

@@ -80,6 +80,41 @@ After you have installed these NuGet packages, you need to configure your projec
  }
 ````
 
+### Specifying Queue
+
+You can use the [`QueueAttribute`](https://docs.hangfire.io/en/latest/background-processing/configuring-queues.html) to specify the queue.
+
+````csharp
+using System.Threading.Tasks;
+using Volo.Abp.BackgroundJobs;
+using Volo.Abp.DependencyInjection;
+using Volo.Abp.Emailing;
+
+namespace MyProject
+{
+    [Queue("alpha")]
+    public class EmailSendingJob
+        : AsyncBackgroundJob<EmailSendingArgs>, ITransientDependency
+    {
+        private readonly IEmailSender _emailSender;
+
+        public EmailSendingJob(IEmailSender emailSender)
+        {
+            _emailSender = emailSender;
+        }
+
+        public override async Task ExecuteAsync(EmailSendingArgs args)
+        {
+            await _emailSender.SendAsync(
+                args.EmailAddress,
+                args.Subject,
+                args.Body
+            );
+        }
+    }
+}
+````
+
 ### Dashboard Authorization
 
 Hangfire Dashboard provides information about your background jobs, including method names and serialized arguments as well as gives you an opportunity to manage them by performing different actions – retry, delete, trigger, etc. So it is important to restrict access to the Dashboard.

docs/zh-Hans/Background-Jobs-Hangfire.md

@@ -66,6 +66,41 @@ public class YourModule : AbpModule
   }
 ````
 
+### 指定队列
+
+你可以使用 [`QueueAttribute`](https://docs.hangfire.io/en/latest/background-processing/configuring-queues.html) 来指定队列.
+
+````csharp
+using System.Threading.Tasks;
+using Volo.Abp.BackgroundJobs;
+using Volo.Abp.DependencyInjection;
+using Volo.Abp.Emailing;
+
+namespace MyProject
+{
+    [Queue("alpha")]
+    public class EmailSendingJob
+        : AsyncBackgroundJob<EmailSendingArgs>, ITransientDependency
+    {
+        private readonly IEmailSender _emailSender;
+
+        public EmailSendingJob(IEmailSender emailSender)
+        {
+            _emailSender = emailSender;
+        }
+
+        public override async Task ExecuteAsync(EmailSendingArgs args)
+        {
+            await _emailSender.SendAsync(
+                args.EmailAddress,
+                args.Subject,
+                args.Body
+            );
+        }
+    }
+}
+````
+
 1. 如果你想要使用Hangfire的面板,你可以在 `Module` 类的 `OnApplicationInitialization` 方法添加: `UseHangfireDashboard`
 
 ````csharp

framework/src/Volo.Abp.BackgroundJobs.HangFire/Volo/Abp/BackgroundJobs/Hangfire/HangfireBackgroundJobManager.cs

@@ -1,6 +1,9 @@
 using System;
+using System.Reflection;
 using System.Threading.Tasks;
 using Hangfire;
+using Hangfire.States;
+using Microsoft.Extensions.Options;
 using Volo.Abp.DependencyInjection;
 
 namespace Volo.Abp.BackgroundJobs.Hangfire;
@@ -8,16 +11,35 @@ namespace Volo.Abp.BackgroundJobs.Hangfire;
 [Dependency(ReplaceServices = true)]
 public class HangfireBackgroundJobManager : IBackgroundJobManager, ITransientDependency
 {
+    protected AbpBackgroundJobOptions Options { get; }
+    
+    public HangfireBackgroundJobManager(IOptions<AbpBackgroundJobOptions> options)
+    {
+        Options = options.Value;
+    }
+    
     public virtual Task<string> EnqueueAsync<TArgs>(TArgs args, BackgroundJobPriority priority = BackgroundJobPriority.Normal,
         TimeSpan? delay = null)
     {
         return Task.FromResult(delay.HasValue
             ? BackgroundJob.Schedule<HangfireJobExecutionAdapter<TArgs>>(
-                adapter => adapter.ExecuteAsync(args),
+                adapter => adapter.ExecuteAsync(GetQueueName(typeof(TArgs)),args),
                 delay.Value
             )
             : BackgroundJob.Enqueue<HangfireJobExecutionAdapter<TArgs>>(
-                adapter => adapter.ExecuteAsync(args)
+                adapter => adapter.ExecuteAsync(GetQueueName(typeof(TArgs)) ,args)
             ));
     }
+
+    protected virtual string GetQueueName(Type argsType)
+    {
+        var queueName = EnqueuedState.DefaultQueue;
+        var queueAttribute = Options.GetJob(argsType).JobType.GetCustomAttribute<QueueAttribute>();
+        if (queueAttribute != null)
+        {
+            queueName = queueAttribute.Queue;
+        }
+
+        return queueName;
+    }
 }

framework/src/Volo.Abp.BackgroundJobs.HangFire/Volo/Abp/BackgroundJobs/Hangfire/HangfireJobExecutionAdapter.cs

@@ -1,4 +1,5 @@
 using System.Threading.Tasks;
+using Hangfire;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 
@@ -20,7 +21,8 @@ public class HangfireJobExecutionAdapter<TArgs>
         Options = options.Value;
     }
 
-    public async Task ExecuteAsync(TArgs args)
+    [Queue("{0}")] 
+    public async Task ExecuteAsync(string queue, TArgs args)
     {
         if (!Options.IsJobExecutionEnabled)
         {