mirror of https://github.com/abpframework/abp.git
maliming
5 years ago
626 changed files with 9037 additions and 3063 deletions
@ -0,0 +1,4 @@ |
|||
codecov: |
|||
branch: dev |
|||
require_ci_to_pass: yes |
|||
allow_coverage_offsets: true |
|||
@ -0,0 +1,99 @@ |
|||
# Hangfire Background Worker Manager |
|||
|
|||
[Hangfire](https://https://www.hangfire.io/) is an advanced background jobs and worker manager. You can integrate Hangfire with the ABP Framework to use it instead of the [default background worker manager](Background-Workers.md). |
|||
|
|||
The major advantage is that you can use the same server farm to manage your Background Jobs and Workers, as well as leverage the advanced scheduling that is available from Hangfire for [Recurring Jobs](https://docs.hangfire.io/en/latest/background-methods/performing-recurrent-tasks.html?highlight=recurring), aka Background Workers. |
|||
|
|||
## Installation |
|||
|
|||
It is suggested to use the [ABP CLI](CLI.md) to install this package. |
|||
|
|||
### Using the ABP CLI |
|||
|
|||
Open a command line window in the folder of the project (.csproj file) and type the following command: |
|||
|
|||
````bash |
|||
abp add-package Volo.Abp.BackgroundWorkers.Hangfire |
|||
```` |
|||
|
|||
### Manual Installation |
|||
|
|||
If you want to manually install; |
|||
|
|||
1. Add the [Volo.Abp.BackgroundWorkers.Hangfire](https://www.nuget.org/packages/Volo.Abp.BackgroundWorkers.Hangfire) NuGet package to your project: |
|||
|
|||
```` |
|||
Install-Package Volo.Abp.BackgroundWorkers.Hangfire |
|||
```` |
|||
|
|||
2. Add the `AbpBackgroundWorkersHangfireModule` to the dependency list of your module: |
|||
|
|||
````csharp |
|||
[DependsOn( |
|||
//...other dependencies |
|||
typeof(AbpBackgroundWorkersHangfireModule) //Add the new module dependency |
|||
)] |
|||
public class YourModule : AbpModule |
|||
{ |
|||
} |
|||
```` |
|||
|
|||
> Hangfire background worker integration provides an adapter `HangfirePeriodicBackgroundWorkerAdapter` to automatically load any `PeriodicBackgroundWorkerBase` and `AsyncPeriodicBackgroundWorkerBase` derived classes as `IHangfireBackgroundWorker` instances. This allows you to still to easily switch over to use Hangfire as the background manager even you have existing background workers that are based on the [default background workers implementation](Background-Workers.md). |
|||
|
|||
## Create a Background Worker |
|||
|
|||
`HangfireBackgroundWorkerBase` is an easy way to create a background worker. |
|||
|
|||
```` csharp |
|||
public class MyLogWorker : HangfireBackgroundWorkerBase |
|||
{ |
|||
public MyLogWorker() |
|||
{ |
|||
RecurringJobId = nameof(MyLogWorker); |
|||
CronExpression = Cron.Daily(); |
|||
} |
|||
|
|||
public override Task DoWorkAsync() |
|||
{ |
|||
Logger.LogInformation("Executed MyLogWorker..!"); |
|||
return Task.CompletedTask; |
|||
} |
|||
} |
|||
```` |
|||
|
|||
* **RecurringJobId** Is an optional parameter, see [Hangfire document](https://docs.hangfire.io/en/latest/background-methods/performing-recurrent-tasks.html) |
|||
* **CronExpression** Is a CRON expression, see [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) |
|||
|
|||
> You can directly implement the `IHangfireBackgroundWorker`, but `HangfireBackgroundWorkerBase` provides some useful properties like Logger. |
|||
|
|||
## 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: |
|||
|
|||
```` csharp |
|||
[DependsOn(typeof(AbpBackgroundWorkersModule))] |
|||
public class MyModule : AbpModule |
|||
{ |
|||
public override void OnApplicationInitialization( |
|||
ApplicationInitializationContext context) |
|||
{ |
|||
context.AddBackgroundWorker<MyLogWorker>(); |
|||
} |
|||
} |
|||
```` |
|||
|
|||
`context.AddBackgroundWorker(...)` is a shortcut extension method for the expression below: |
|||
|
|||
```` csharp |
|||
context.ServiceProvider |
|||
.GetRequiredService<IBackgroundWorkerManager>() |
|||
.Add( |
|||
context |
|||
.ServiceProvider |
|||
.GetRequiredService<MyLogWorker>() |
|||
); |
|||
```` |
|||
|
|||
So, it resolves the given background worker and adds to the `IBackgroundWorkerManager`. |
|||
|
|||
While we generally add workers in OnApplicationInitialization, there are no restrictions on that. You can inject IBackgroundWorkerManager anywhere and add workers at runtime. Background worker manager will stop and release all the registered workers when your application is being shut down. |
|||
@ -0,0 +1,10 @@ |
|||
## Angular UI Extensions |
|||
|
|||
Angular UI extensions system allows you to add a new action to the actions menu, a new column to the data table, a new action to the toolbar of a page, and add a new field to the create and/or edit forms. |
|||
|
|||
See the documents below for the details: |
|||
|
|||
* [Entity Action Extensions](Entity-Action-Extensions.md) |
|||
* [Data Table Column (or Entity Prop) Extensions](Data-Table-Column-Extensions.md) |
|||
* [Page Toolbar Extension](Page-Toolbar-Extensions.md) |
|||
* [Dynamic Form (or Form Prop) Extensions](Dynamic-Form-Extensions.md) |
|||
@ -0,0 +1,100 @@ |
|||
# Hangfire Background Worker Manager |
|||
|
|||
[Hangfire](https://https://www.hangfire.io/)是一个高级的后台工作者管理. 你可以用ABP框架Hangfire集成代替[默认后台工作者管理](Background-Workers.md). |
|||
|
|||
主要优点是你可以使用相同的服务器群来管理你的后台作业和工作线程以及利用 Hangfire 提供的[Recurring Jobs](https://docs.hangfire.io/en/latest/background-methods/performing-recurrent-tasks.html?highlight=recurring)高级调度功能. |
|||
|
|||
## 安装 |
|||
|
|||
建议使用[ABP CLI](CLI.md)安装包. |
|||
|
|||
|
|||
### 使用ABP CLI |
|||
|
|||
在项目的文件夹(.csproj文件)中打开命令行窗口输入以下命令: |
|||
|
|||
````bash |
|||
abp add-package Volo.Abp.BackgroundWorkers.Hangfire |
|||
```` |
|||
|
|||
### 手动安装 |
|||
|
|||
如果你想手动安装; |
|||
|
|||
1. 添加 [Volo.Abp.BackgroundWorkers.Hangfire](https://www.nuget.org/packages/Volo.Abp.BackgroundWorkers.Hangfire) NuGet包添加到你的项目: |
|||
|
|||
```` |
|||
Install-Package Volo.Abp.BackgroundWorkers.Hangfire |
|||
```` |
|||
|
|||
2. 添加 `AbpBackgroundWorkersHangfireModule` 到你的模块的依赖列表: |
|||
|
|||
````csharp |
|||
[DependsOn( |
|||
//...other dependencies |
|||
typeof(AbpBackgroundWorkersHangfireModule) //Add the new module dependency |
|||
)] |
|||
public class YourModule : AbpModule |
|||
{ |
|||
} |
|||
```` |
|||
|
|||
> Hangfire后台工作者集成提供了 `HangfirePeriodicBackgroundWorkerAdapter` 来适配 `PeriodicBackgroundWorkerBase` 和 `AsyncPeriodicBackgroundWorkerBase` 派生类. 所以你依然可以按照[后台工作者文档](Background-Workers.md)来定义后台作业. |
|||
|
|||
## 创建后台工作者 |
|||
|
|||
`HangfireBackgroundWorkerBase` 是创建一个后台工作者简单的方法. |
|||
|
|||
```` csharp |
|||
public class MyLogWorker : HangfireBackgroundWorkerBase |
|||
{ |
|||
public MyLogWorker() |
|||
{ |
|||
RecurringJobId = nameof(MyLogWorker); |
|||
CronExpression = Cron.Daily(); |
|||
} |
|||
|
|||
public override Task DoWorkAsync() |
|||
{ |
|||
Logger.LogInformation("Executed MyLogWorker..!"); |
|||
return Task.CompletedTask; |
|||
} |
|||
} |
|||
```` |
|||
|
|||
* **RecurringJobId** 是一个可选参数, 参阅 [Hangfire文档](https://docs.hangfire.io/en/latest/background-methods/performing-recurrent-tasks.html) |
|||
* **CronExpression** 是CRON表达式, 参阅 [CRON 表达式](https://en.wikipedia.org/wiki/Cron#CRON_expression) |
|||
|
|||
> 你可以直接实现 `IHangfireBackgroundWorker`, 但是 `HangfireBackgroundWorkerBase` 提供了一些有用的属性,例如 `Logger`. |
|||
|
|||
## 注册到后台工作者管理器 |
|||
|
|||
创建一个后台工作者后, 你应该添加到 `IBackgroundWorkerManager`, 最常用的地方是在你模块类的 `OnApplicationInitialization` 方法中: |
|||
|
|||
```` csharp |
|||
[DependsOn(typeof(AbpBackgroundWorkersModule))] |
|||
public class MyModule : AbpModule |
|||
{ |
|||
public override void OnApplicationInitialization( |
|||
ApplicationInitializationContext context) |
|||
{ |
|||
context.AddBackgroundWorker<MyLogWorker>(); |
|||
} |
|||
} |
|||
```` |
|||
|
|||
`context.AddBackgroundWorker(...)` 是一个是以下代码快捷的扩展方法: |
|||
|
|||
```` csharp |
|||
context.ServiceProvider |
|||
.GetRequiredService<IBackgroundWorkerManager>() |
|||
.Add( |
|||
context |
|||
.ServiceProvider |
|||
.GetRequiredService<MyLogWorker>() |
|||
); |
|||
```` |
|||
|
|||
它解析给定的后台工作者并添加到 `IBackgroundWorkerManager`. |
|||
|
|||
虽然我们通常在 `OnApplicationInitialization` 中添加后台工作者, 但对此没有限制. 你可以在任何地方注入 `IBackgroundWorkerManager` 并在运行时添加后台工作者. |
|||
@ -0,0 +1,3 @@ |
|||
<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd"> |
|||
<ConfigureAwait ContinueOnCapturedContext="false" /> |
|||
</Weavers> |
|||
@ -1,4 +1,4 @@ |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> |
|||
<!-- This file was generated by Fody. Manual changes to this file will be lost when your project is rebuilt. --> |
|||
<xs:element name="Weavers"> |
|||
@ -0,0 +1,36 @@ |
|||
using System; |
|||
using Hangfire; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
using Microsoft.Extensions.Options; |
|||
using Volo.Abp.Hangfire; |
|||
using Volo.Abp.Modularity; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Hangfire |
|||
{ |
|||
[DependsOn( |
|||
typeof(AbpBackgroundWorkersModule), |
|||
typeof(AbpHangfireModule))] |
|||
public class AbpBackgroundWorkerHangfireModule : AbpModule |
|||
{ |
|||
public override void OnPreApplicationInitialization(ApplicationInitializationContext context) |
|||
{ |
|||
var options = context.ServiceProvider.GetRequiredService<IOptions<AbpBackgroundWorkerOptions>>().Value; |
|||
if (!options.IsEnabled) |
|||
{ |
|||
var hangfireOptions = context.ServiceProvider.GetRequiredService<IOptions<AbpHangfireOptions>>().Value; |
|||
hangfireOptions.BackgroundJobServerFactory = CreateOnlyEnqueueJobServer; |
|||
} |
|||
} |
|||
|
|||
public override void ConfigureServices(ServiceConfigurationContext context) |
|||
{ |
|||
context.Services.AddSingleton(typeof(HangfirePeriodicBackgroundWorkerAdapter<>)); |
|||
} |
|||
|
|||
private BackgroundJobServer CreateOnlyEnqueueJobServer(IServiceProvider serviceProvider) |
|||
{ |
|||
serviceProvider.GetRequiredService<JobStorage>(); |
|||
return null; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,13 @@ |
|||
using System.Threading.Tasks; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Hangfire |
|||
{ |
|||
public abstract class HangfireBackgroundWorkerBase : BackgroundWorkerBase, IHangfireBackgroundWorker |
|||
{ |
|||
public string RecurringJobId { get; set; } |
|||
|
|||
public string CronExpression { get; set; } |
|||
|
|||
public abstract Task DoWorkAsync(); |
|||
} |
|||
} |
|||
@ -0,0 +1,91 @@ |
|||
using System; |
|||
using System.Reflection; |
|||
using System.Threading; |
|||
using System.Threading.Tasks; |
|||
using Hangfire; |
|||
using Volo.Abp.DependencyInjection; |
|||
using Volo.Abp.Threading; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Hangfire |
|||
{ |
|||
[Dependency(ReplaceServices = true)] |
|||
public class HangfireBackgroundWorkerManager : IBackgroundWorkerManager, ISingletonDependency |
|||
{ |
|||
public Task StartAsync(CancellationToken cancellationToken = default) |
|||
{ |
|||
return Task.CompletedTask; |
|||
} |
|||
|
|||
public Task StopAsync(CancellationToken cancellationToken = default) |
|||
{ |
|||
return Task.CompletedTask; |
|||
} |
|||
|
|||
public void Add(IBackgroundWorker worker) |
|||
{ |
|||
if (worker is IHangfireBackgroundWorker hangfireBackgroundWorker) |
|||
{ |
|||
if (hangfireBackgroundWorker.RecurringJobId.IsNullOrWhiteSpace()) |
|||
{ |
|||
RecurringJob.AddOrUpdate(() => hangfireBackgroundWorker.DoWorkAsync(), |
|||
hangfireBackgroundWorker.CronExpression); |
|||
} |
|||
else |
|||
{ |
|||
RecurringJob.AddOrUpdate(hangfireBackgroundWorker.RecurringJobId,() => hangfireBackgroundWorker.DoWorkAsync(), |
|||
hangfireBackgroundWorker.CronExpression); |
|||
} |
|||
} |
|||
else |
|||
{ |
|||
int? period; |
|||
|
|||
if (worker is AsyncPeriodicBackgroundWorkerBase or PeriodicBackgroundWorkerBase) |
|||
{ |
|||
var timer = (AbpTimer) worker.GetType() |
|||
.GetProperty("Timer", BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(worker); |
|||
period = timer?.Period; |
|||
} |
|||
else |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
if (period == null) |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
var adapterType = typeof(HangfirePeriodicBackgroundWorkerAdapter<>).MakeGenericType(worker.GetType()); |
|||
var workerAdapter = Activator.CreateInstance(adapterType) as IHangfireBackgroundWorker; |
|||
|
|||
RecurringJob.AddOrUpdate(() => workerAdapter.DoWorkAsync(), GetCron(period.Value)); |
|||
} |
|||
} |
|||
|
|||
protected virtual string GetCron(int period) |
|||
{ |
|||
var time = TimeSpan.FromMilliseconds(period); |
|||
string cron; |
|||
|
|||
if (time.TotalSeconds <= 59) |
|||
{ |
|||
cron = $"*/{time.TotalSeconds} * * * * *"; |
|||
} |
|||
else if (time.TotalMinutes <= 59) |
|||
{ |
|||
cron = $"*/{time.TotalMinutes} * * * *"; |
|||
} |
|||
else if (time.TotalHours <= 23) |
|||
{ |
|||
cron = $"0 */{time.TotalHours} * * *"; |
|||
} |
|||
else |
|||
{ |
|||
cron = $"0 0 */{time.TotalDays} * *"; |
|||
} |
|||
|
|||
return cron; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,36 @@ |
|||
using System.Reflection; |
|||
using System.Threading.Tasks; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Hangfire |
|||
{ |
|||
public class HangfirePeriodicBackgroundWorkerAdapter<TWorker> : HangfireBackgroundWorkerBase |
|||
where TWorker : IBackgroundWorker |
|||
{ |
|||
private readonly MethodInfo _doWorkAsyncMethod; |
|||
private readonly MethodInfo _doWorkMethod; |
|||
|
|||
public HangfirePeriodicBackgroundWorkerAdapter() |
|||
{ |
|||
_doWorkAsyncMethod = |
|||
typeof(TWorker).GetMethod("DoWorkAsync", BindingFlags.Instance | BindingFlags.NonPublic); |
|||
_doWorkMethod = typeof(TWorker).GetMethod("DoWork", BindingFlags.Instance | BindingFlags.NonPublic); |
|||
} |
|||
|
|||
public override async Task DoWorkAsync() |
|||
{ |
|||
var workerContext = new PeriodicBackgroundWorkerContext(ServiceProvider); |
|||
var worker = ServiceProvider.GetRequiredService<TWorker>(); |
|||
|
|||
switch (worker) |
|||
{ |
|||
case AsyncPeriodicBackgroundWorkerBase asyncPeriodicBackgroundWorker: |
|||
await (Task) _doWorkAsyncMethod.Invoke(asyncPeriodicBackgroundWorker, new object[] {workerContext}); |
|||
break; |
|||
case PeriodicBackgroundWorkerBase periodicBackgroundWorker: |
|||
_doWorkMethod.Invoke(periodicBackgroundWorker, new object[] {workerContext}); |
|||
break; |
|||
} |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,15 @@ |
|||
using System.Threading.Tasks; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Hangfire |
|||
{ |
|||
public interface IHangfireBackgroundWorker : IBackgroundWorker |
|||
{ |
|||
string RecurringJobId { get; set; } |
|||
|
|||
string CronExpression { get; set; } |
|||
|
|||
Task DoWorkAsync(); |
|||
} |
|||
} |
|||
|
|||
|
|||
@ -1,27 +1,22 @@ |
|||
using System; |
|||
using Microsoft.Extensions.DependencyInjection; |
|||
using System.Collections.Generic; |
|||
using Volo.Abp.DependencyInjection; |
|||
|
|||
namespace Volo.Abp.BackgroundWorkers.Quartz |
|||
{ |
|||
public class AbpQuartzConventionalRegistrar : DefaultConventionalRegistrar |
|||
{ |
|||
public override void AddType(IServiceCollection services, Type type) |
|||
protected override bool IsConventionalRegistrationDisabled(Type type) |
|||
{ |
|||
if (!typeof(IQuartzBackgroundWorker).IsAssignableFrom(type)) |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
var dependencyAttribute = GetDependencyAttributeOrNull(type); |
|||
var lifeTime = GetLifeTimeOrNull(type, dependencyAttribute); |
|||
return !typeof(IQuartzBackgroundWorker).IsAssignableFrom(type) || base.IsConventionalRegistrationDisabled(type); |
|||
} |
|||
|
|||
if (lifeTime == null) |
|||
protected override List<Type> GetExposedServiceTypes(Type type) |
|||
{ |
|||
return new List<Type>() |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
services.Add(ServiceDescriptor.Describe(typeof(IQuartzBackgroundWorker), type, lifeTime.Value)); |
|||
typeof(IQuartzBackgroundWorker) |
|||
}; |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -0,0 +1,24 @@ |
|||
namespace Volo.Abp.Cli.Utils |
|||
{ |
|||
public interface ICmdHelper |
|||
{ |
|||
void OpenWebPage(string url); |
|||
|
|||
void Run(string file, string arguments); |
|||
|
|||
string GetArguments(string command); |
|||
|
|||
string GetFileName(); |
|||
|
|||
void RunCmd(string command, string workingDirectory = null); |
|||
|
|||
void RunCmd(string command, out int exitCode, string workingDirectory = null); |
|||
|
|||
string RunCmdAndGetOutput(string command, string workingDirectory = null); |
|||
|
|||
|
|||
string RunCmdAndGetOutput(string command, out bool isExitCodeSuccessful, string workingDirectory = null); |
|||
|
|||
string RunCmdAndGetOutput(string command, out int exitCode, string workingDirectory = null); |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue