Merge pull request #11189 from abpframework/liangshiwei/backgroundworkers

Support proxy class

docs/en/Background-Workers-Hangfire.md

@@ -66,6 +66,33 @@ public class MyLogWorker : HangfireBackgroundWorkerBase
 
 > You can directly implement the `IHangfireBackgroundWorker`, but `HangfireBackgroundWorkerBase` provides some useful properties like Logger.
 
+### UnitOfWork
+
+For use with `UnitOfWorkAttribute`, you need to define an interface for worker:
+
+```csharp
+public interface IMyLogWorker : IHangfireBackgroundWorker
+{
+}
+
+[ExposeServices(typeof(IMyLogWorker))]
+public class MyLogWorker : HangfireBackgroundWorkerBase, IMyLogWorker
+{
+    public MyLogWorker()
+    {
+        RecurringJobId = nameof(MyLogWorker);
+        CronExpression = Cron.Daily();
+    }
+
+    [UnitOfWork]
+    public override Task DoWorkAsync()
+    {
+        Logger.LogInformation("Executed MyLogWorker..!");
+        return Task.CompletedTask;
+    }
+}
+```
+
 ## Register BackgroundWorkerManager
 
 After creating a background worker class, you should add it to the `IBackgroundWorkerManager`. The most common place is the `OnApplicationInitialization` method of your module class:
@@ -78,6 +105,9 @@ public class MyModule : AbpModule
         ApplicationInitializationContext context)
     {
         context.AddBackgroundWorker<MyLogWorker>();
+
+        //If the interface is defined
+        //context.AddBackgroundWorker<IMyLogWorker>(); 
     }
 }
 ````

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

@@ -67,6 +67,33 @@ public class MyLogWorker : HangfireBackgroundWorkerBase
 
 > 你可以直接实现 `IHangfireBackgroundWorker`, 但是 `HangfireBackgroundWorkerBase` 提供了一些有用的属性,例如 `Logger`.
 
+### UnitOfWork
+
+使用 `UnitOfWorkAttribute` 你需要为工作者定义一个接口:
+
+```csharp
+public interface IMyLogWorker : IHangfireBackgroundWorker
+{
+}
+
+[ExposeServices(typeof(IMyLogWorker))]
+public class MyLogWorker : HangfireBackgroundWorkerBase, IMyLogWorker
+{
+    public MyLogWorker()
+    {
+        RecurringJobId = nameof(MyLogWorker);
+        CronExpression = Cron.Daily();
+    }
+
+    [UnitOfWork]
+    public override Task DoWorkAsync()
+    {
+        Logger.LogInformation("Executed MyLogWorker..!");
+        return Task.CompletedTask;
+    }
+}
+```
+
 ## 注册到后台工作者管理器
 
 创建一个后台工作者后, 你应该添加到 `IBackgroundWorkerManager`, 最常用的地方是在你模块类的 `OnApplicationInitialization` 方法中:
@@ -79,6 +106,9 @@ public class MyModule : AbpModule
         ApplicationInitializationContext context)
     {
         context.AddBackgroundWorker<MyLogWorker>();
+
+        //如果定义了接口
+        //context.AddBackgroundWorker<IMyLogWorker>(); 
     }
 }
 ````

framework/src/Volo.Abp.BackgroundWorkers.Hangfire/Volo/Abp/BackgroundWorkers/Hangfire/HangfireBackgroundWorkerManager.cs

@@ -4,6 +4,7 @@ using System.Threading;
 using System.Threading.Tasks;
 using Hangfire;
 using Volo.Abp.DependencyInjection;
+using Volo.Abp.DynamicProxy;
 using Volo.Abp.Threading;
 
 namespace Volo.Abp.BackgroundWorkers.Hangfire
@@ -25,14 +26,14 @@ namespace Volo.Abp.BackgroundWorkers.Hangfire
         {
             if (worker is IHangfireBackgroundWorker hangfireBackgroundWorker)
             {
+                var unProxyWorker = ProxyHelper.UnProxy(hangfireBackgroundWorker);
                 if (hangfireBackgroundWorker.RecurringJobId.IsNullOrWhiteSpace())
                 {
-                    RecurringJob.AddOrUpdate(() => hangfireBackgroundWorker.DoWorkAsync(),
-                        hangfireBackgroundWorker.CronExpression);
+                    RecurringJob.AddOrUpdate(() => ((IHangfireBackgroundWorker)unProxyWorker).DoWorkAsync(),hangfireBackgroundWorker.CronExpression);
                 }
                 else
                 {
-                    RecurringJob.AddOrUpdate(hangfireBackgroundWorker.RecurringJobId,() => hangfireBackgroundWorker.DoWorkAsync(),
+                    RecurringJob.AddOrUpdate(hangfireBackgroundWorker.RecurringJobId,() => ((IHangfireBackgroundWorker)unProxyWorker).DoWorkAsync(),
                         hangfireBackgroundWorker.CronExpression);
                 }
             }
@@ -64,7 +65,7 @@ namespace Volo.Abp.BackgroundWorkers.Hangfire
                     return;
                 }
 
-                var adapterType = typeof(HangfirePeriodicBackgroundWorkerAdapter<>).MakeGenericType(worker.GetType());
+                var adapterType = typeof(HangfirePeriodicBackgroundWorkerAdapter<>).MakeGenericType(ProxyHelper.GetUnProxiedType(worker));
                 var workerAdapter = Activator.CreateInstance(adapterType) as IHangfireBackgroundWorker;
 
                 RecurringJob.AddOrUpdate(() => workerAdapter.DoWorkAsync(), GetCron(period.Value));

framework/src/Volo.Abp.BackgroundWorkers.Quartz/Volo/Abp/BackgroundWorkers/Quartz/QuartzBackgroundWorkerManager.cs

@@ -3,6 +3,7 @@ using System.Threading;
 using System.Threading.Tasks;
 using Quartz;
 using Volo.Abp.DependencyInjection;
+using Volo.Abp.DynamicProxy;
 using Volo.Abp.Threading;
 
 namespace Volo.Abp.BackgroundWorkers.Quartz
@@ -56,7 +57,7 @@ namespace Volo.Abp.BackgroundWorkers.Quartz
             }
             else
             {
-                var adapterType = typeof(QuartzPeriodicBackgroundWorkerAdapter<>).MakeGenericType(worker.GetType());
+                var adapterType = typeof(QuartzPeriodicBackgroundWorkerAdapter<>).MakeGenericType(ProxyHelper.GetUnProxiedType(worker));
 
                 var workerAdapter = Activator.CreateInstance(adapterType) as IQuartzBackgroundWorkerAdapter;
 

framework/src/Volo.Abp.BackgroundWorkers.Quartz/Volo/Abp/BackgroundWorkers/Quartz/QuartzPeriodicBackgroundWorkerAdapter.cs

@@ -2,6 +2,7 @@
 using System.Reflection;
 using System.Threading.Tasks;
 using Quartz;
+using Volo.Abp.DynamicProxy;
 using Volo.Abp.Threading;
 
 namespace Volo.Abp.BackgroundWorkers.Quartz
@@ -26,16 +27,16 @@ namespace Volo.Abp.BackgroundWorkers.Quartz
         public void BuildWorker(IBackgroundWorker worker)
         {
             int? period;
-            var workerType = worker.GetType();
+            var workerType = ProxyHelper.GetUnProxiedType(worker);
 
             if (worker is AsyncPeriodicBackgroundWorkerBase or PeriodicBackgroundWorkerBase)
             {
-                if (typeof(TWorker) != worker.GetType())
+                if (typeof(TWorker) != workerType)
                 {
                     throw new ArgumentException($"{nameof(worker)} type is different from the generic type");
                 }
 
-                var timer = worker.GetType().GetProperty("Timer", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(worker);
+                var timer = workerType.GetProperty("Timer", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(worker);
 
                 if (worker is AsyncPeriodicBackgroundWorkerBase)
                 {

framework/src/Volo.Abp.Core/Volo/Abp/DynamicProxy/ProxyHelper.cs

@@ -7,9 +7,9 @@ namespace Volo.Abp.DynamicProxy
     public static class ProxyHelper
     {
         private const string ProxyNamespace = "Castle.Proxies";
-        
+
         /// <summary>
-        /// Returns dynamic proxy target object if this is a proxied object, otherwise returns the given object. 
+        /// Returns dynamic proxy target object if this is a proxied object, otherwise returns the given object.
         /// It supports Castle Dynamic Proxies.
         /// </summary>
         public static object UnProxy(object obj)
@@ -33,7 +33,21 @@ namespace Volo.Abp.DynamicProxy
 
         public static Type GetUnProxiedType(object obj)
         {
-            return UnProxy(obj).GetType();
+            if (obj.GetType().Namespace == ProxyNamespace)
+            {
+                var target = UnProxy(obj);
+                if (target != null)
+                {
+                    if (target == obj)
+                    {
+                        return obj.GetType().GetTypeInfo().BaseType;
+                    }
+
+                    return target.GetType();
+                }
+            }
+
+            return obj.GetType();
         }
     }
 }