From b2e1fd48dc7ddba0716ad18c4a44877d7853cc88 Mon Sep 17 00:00:00 2001 From: cKey <35512826+colinin@users.noreply.github.com> Date: Tue, 11 Jan 2022 15:55:42 +0800 Subject: [PATCH] feat(tasks): add exception handling README.MD --- ...p.BackgroundTasks.ExceptionHandling.csproj | 1 - ...pBackgroundTasksExceptionHandlingModule.cs | 5 ++-- .../README.md | 27 +++++++++++++++++++ 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/README.md diff --git a/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN.Abp.BackgroundTasks.ExceptionHandling.csproj b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN.Abp.BackgroundTasks.ExceptionHandling.csproj index 08e166f0c..74c4f48de 100644 --- a/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN.Abp.BackgroundTasks.ExceptionHandling.csproj +++ b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN.Abp.BackgroundTasks.ExceptionHandling.csproj @@ -13,7 +13,6 @@ - diff --git a/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN/Abp/BackgroundTasks/ExceptionHandling/AbpBackgroundTasksExceptionHandlingModule.cs b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN/Abp/BackgroundTasks/ExceptionHandling/AbpBackgroundTasksExceptionHandlingModule.cs index 716c72f8c..0f11234c3 100644 --- a/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN/Abp/BackgroundTasks/ExceptionHandling/AbpBackgroundTasksExceptionHandlingModule.cs +++ b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/LINGYUN/Abp/BackgroundTasks/ExceptionHandling/AbpBackgroundTasksExceptionHandlingModule.cs @@ -1,9 +1,10 @@ -using LINGYUN.Abp.ExceptionHandling; +using LINGYUN.Abp.BackgroundTasks.Jobs; using Volo.Abp.Modularity; namespace LINGYUN.Abp.BackgroundTasks.ExceptionHandling; -[DependsOn(typeof(AbpExceptionHandlingModule))] +[DependsOn(typeof(AbpBackgroundTasksModule))] +[DependsOn(typeof(AbpBackgroundTasksJobsModule))] public class AbpBackgroundTasksExceptionHandlingModule : AbpModule { diff --git a/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/README.md b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/README.md new file mode 100644 index 000000000..4f0cf8d92 --- /dev/null +++ b/aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.ExceptionHandling/README.md @@ -0,0 +1,27 @@ +# LINGYUN.Abp.BackgroundTasks.ExceptionHandling + +后台作业执行异常通知实现, 默认使用Email发送通知 + +## 配置使用 + +模块按需引用 + +```csharp +[DependsOn(typeof(AbpBackgroundTasksExceptionHandlingModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 先决条件 + +** 在定义作业时在参数中指定如下参数,在作业执行失败时将发送通知 + +* exception.to 必须, 接收者邮件地址 +* exception.from 必须, 邮件抬头发送者名称 +* exception.body 可选, 邮件内容(未指定模板名称则为必须参数) +* exception.subject 必须, 邮件标题 +* exception.template 可选, 邮件模板 +* exception.context 可选, 使用模板时的上下文参数 +* exception.culture 可选, 使用模板时的模板区域性