基础概念

两种通知发送方式

  1. 直接发送给目标用户
  2. 用户订阅某类通知,发送这类通知时直接分发给它们。

两种通知类型

  1. 一般通知:任意的通知类型

    “如果一个用户发送一个好友请求,那么通知我”就是一个此类型的通知
  2. 实体通知:与一个特定的实体关联,

    “如果一个用户给这张(photo)图片发了评论,那么通知我”就是一个基于实体的通知,因为它与一个特定的photo实体关联,用户可能想为某些图片发出通知,而不是所有图片

通知数据

一个通知通常包含一个通知数据,但有些通知也可能不需要数据

例如:“如果一个用户发送一个好友请求,那么通知我”该通知可能有两个数据属性:发送者名字(谁发送了这个好友请求)和备注(发送者写在请求里的信息),很明显,通知数据类型与通知类型是紧密联系的,不同的通知类型有不同的数据类型。

ABP已经提供足以满足大部分情况的预定义通知数据类型,简单的信息可以用MessageNotificationData,本地化和可参数化的通知信息可以使用LocalizableMessageNotificationData。

通知重要性级别

通知重要性有5个级别,定义在NotificationSeverity枚举里:Info,Success,Warn,Error和Fatal,默认为Info。

示例

订阅通知

INotificationSubscriptionManager提供了用来订阅通知的API,例如:

public class MyService : ITransientDependency
{
private readonly INotificationSubscriptionManager _notificationSubscriptionManager; public MyService(INotificationSubscriptionManager notificationSubscriptionManager)
{
_notificationSubscriptionManager = notificationSubscriptionManager;
} //订阅一个一般通知
public async Task Subscribe_SentFrendshipRequest(int? tenantId, long userId)
{
await _notificationSubscriptionManager.SubscribeAsync(new UserIdentifier(tenantId, userId), "SentFrendshipRequest");
} //订阅一个实体通知
public async Task Subscribe_CommentPhoto(int? tenantId, long userId, Guid photoId)
{
await _notificationSubscriptionManager.SubscribeAsync(new UserIdentifier(tenantId, userId), "CommentPhoto", new EntityIdentifier(typeof(Photo), photoId));
}
}

每一个通知类型都应当有一个唯一的名称(如示例中的SentFrendshipRequest 和CommentPhoto)。

INotificationSubscriptionManager还有UnsubscribeAsync,IsSubscribedAsync,GetSubscriptionsAsyn等方法来管理订阅。

发布通知

INotificationPublisher用来发布通知,例如:

public class MyService : ITransientDependency
{
private readonly INotificationPublisher _notiticationPublisher; public MyService(INotificationPublisher notiticationPublisher)
{
_notiticationPublisher = notiticationPublisher;
} //发送一个一般通知给一个特定用户
public async Task Publish_SentFrendshipRequest(string senderUserName, string friendshipMessage, UserIdentifier targetUserId)
{
await _notiticationPublisher.PublishAsync("SentFrendshipRequest", new SentFrendshipRequestNotificationData(senderUserName, friendshipMessage), userIds: new[] { targetUserId });
} //发送一个实体通知给一个特定用户
public async Task Publish_CommentPhoto(string commenterUserName, string comment, Guid photoId, UserIdentifier photoOwnerUserId)
{
await _notiticationPublisher.PublishAsync("CommentPhoto", new CommentPhotoNotificationData(commenterUserName, comment), new EntityIdentifier(typeof(Photo), photoId), userIds: new[] { photoOwnerUserId });
} //发送一个一般通知给所有当前租户(在会话里)里的订阅它的用户
public async Task Publish_LowDisk(int remainingDiskInMb)
{
//Example "LowDiskWarningMessage" content for English -> "Attention! Only {remainingDiskInMb} MBs left on the disk!"
var data = new LocalizableMessageNotificationData(new LocalizableString("LowDiskWarningMessage", "MyLocalizationSourceName"));
data["remainingDiskInMb"] = remainingDiskInMb; await _notiticationPublisher.PublishAsync("System.LowDisk", data, severity: NotificationSeverity.Warn);
}
}

通知类型

在第一个例子里, 我们发布一个通知给一个单独的用户,SentFrendshipRequestNotificationData应该继承于NotificationData,如下所示:

[Serializable]
public class SentFrendshipRequestNotificationData : NotificationData
{
public string SenderUserName { get; set; } public string FriendshipMessage { get; set; } public SentFrendshipRequestNotificationData(string senderUserName, string friendshipMessage)
{
SenderUserName = senderUserName;
FriendshipMessage = friendshipMessage;
}
}

第二个例子,我们发送一个通知给一个特定用户并传递一个特定实体,通知数据类不需要可序列化(因为默认使用JSON序列器),但建议把它标记为可序列化,因为你可能会在不同应用中移动而且你将来也可能想使用二进制可序列化器。当然如前面所述,通知数据是可选的,并不是所有的通知都需要它。

注意:如果我们发布一个通知给一个特定用户,那么这个用户不需要订阅这个通知。

第三个例子,我们没有定义一个专用的通知数据类,而是直接使用内容的LocalizableMessageNotificationData类,并使用基于字典的数据,并发布一个“Warn”通知,LocalizableMessageNotificationData可以存储基于字典的任意数据(如果自定义的通知数据类继承于NotificationData类,那么也可以这么用),我们使用“remainingDiskInMb”作为本地化参数,本地化信息可以包含这些参数(如示例中的“Attention!Only{remainingDiskInMb} MBs left on the disk!”)。

用户通知管理器IUserNotificationManager

IUserNotificationManager用来管理用户的通知,它get,update或delete一个用户的通知,你可以用它为你的应用准备一个通知列表页面。

实时通知IRealTimeNotifier + SignalR

虽然可以用IUserNotificationManager来查询通知,但我们通常想推送一个实时通知到客户端。

通知系统使用IRealTimeNotifier来发送实时通知给用户,这可以使用任何类型的实时通讯系统实现,我们可以用一个单独实现的SignalR包,启动模板已经安装了SignalR,查看SignalR集成文档获取更多信息。

注意:通知系统用一个后台作业异步调用IRealTimeNotifier,所以,通知可能会有一点点的延迟。

客户端

当接收到一个实时的通知,ABP在客户端触发一个全局事件,你可以用如下的方式注册来得到通知:

abp.event.on('abp.notifications.received', function (userNotification) {
console.log(userNotification);
});

每接收到一个实时通知,都会触发abp.notifications.received事件事件,你可以像上面那样注册该事件来获取通知,查看javascript事件总线文档获取事件更多信息。一个收到的“System.LowDisk”通知的Json示例:

{
"userId": 2,
"state": 0,
"notification": {
"notificationName": "System.LowDisk",
"data": {
"message": {
"sourceName": "MyLocalizationSourceName",
"name": "LowDiskWarningMessage"
},
"type": "Abp.Notifications.LocalizableMessageNotificationData",
"properties": {
"remainingDiskInMb": "42"
}
},
"entityType": null,
"entityTypeName": null,
"entityId": null,
"severity": 0,
"creationTime": "2016-02-09T17:03:32.13",
"id": "0263d581-3d8a-476b-8e16-4f6a6f10a632"
},
"id": "4a546baf-bf17-4924-b993-32e420a8d468"
}

在这个对象里:

  • userId:当前用户Id,通常你不需要这个因为你知道当前的户。
  • state:UserNotificationState的枚举值,0:Unread(未读),1:Read(已读)。
  • notification:通知明细:
    • notificationName:这个通知的唯一名称(发布时也用这个名称)。
    • data:通知数据,在这个示例里,我们使用LocalizableMessageNotificationData(和之前发布的示例一致):
      • message:本地化的消息信息,我们可以用sourceName和name来本地化界面上的消息。
      • type:通知数据类型,全类型名,包含命名空间,当在处理通知数据时,我们可以检查这个类型。
      • properties:基于字典的自定义属性。
    • entityType、entityTypeName和entityId:实体信息(如果这是一个实体实时通知)
    • severity:一个NotificationSeverity枚举值,0:Info,1:Success,2:Warn,3:Error,4:Fatal。
    • id:通知Id。
  • id:用户通知Id。

把通知信息显示给用户

abp.event.on('abp.notifications.received', function (userNotification) {
if (userNotification.notification.data.type === 'Abp.Notifications.LocalizableMessageNotificationData') {
var localizedText = abp.localization.localize(
userNotification.notification.data.message.name,
userNotification.notification.data.message.sourceName
); $.each(userNotification.notification.data.properties, function (key, value) {
localizedText = localizedText.replace('{' + key + '}', value);
}); alert('New localized notification: ' + localizedText);
} else if (userNotification.notification.data.type === 'Abp.Notifications.MessageNotificationData') {
alert('New simple notification: ' + userNotification.notification.data.message);
}
});

为了能处理通知数据,我们应当检查这个数据类型,这个例子简单的从通知数据里获取消息,如果是本地化的消息(LocalizableMessageNotificationData),我们本地化这个消息并替换参数, 如果是简单消息(MessageNotificationData),我们直接获取这个消息,当然,在真实的项目里,我们不会使用alert函数,我们可以使用abp.notify api来显示良好的UI通知。

如果你想实现上面这样的逻辑,有一个更容易且富有弹性的方式,当接收到一个推送的通知,你只需要一行代码来显示UI通知:

abp.event.on('abp.notifications.received', function (userNotification) {
abp.notifications.showUiNotifyForUserNotification(userNotification);
});

这显示一个UI通知,如下所示(上面描述的推送的System.LowDisk通知):

它可工作于内容的通知数据类型(LocalizableMessageNotificationData和MessageNotificationData),如果你是自定义的通知数据类型,那么你应该像下面这样注册数据格式:

abp.notifications.messageFormatters['MyProject.MyNotificationDataType'] = function(userNotification) {
return ...; //此处格式化并返回消息
};

因此,showUiNotifyForUserNotification可以为你的数据类型创建显示的消息,如果你只是需要格式的消息,你可以直接使用abp.notifications.getFormattedMessageFromUserNotification(userNotification), 它内部被showUiNotifyForUserNotification。

通知存储

通知系统使用INotificationStore来持久化通知,该接口实现后才能使通知系统正常工作,你可以自己实现它或使用已经实现它的module-zero。

通知定义

你不需要在用前先定义一个通知,你只管使用任何通知名称而无需定义,但是,定义它可能给你带来额外的好处,例如,定义后你可以在你的应用里检查所有的通知。鉴于这种情况,我们可以为我们的模块定义一个通知供应器,如下所示:

public class MyAppNotificationProvider : NotificationProvider
{
public override void SetNotifications(INotificationDefinitionContext context)
{
context.Manager.Add(
new NotificationDefinition(
"App.NewUserRegistered",
displayName: new LocalizableString("NewUserRegisteredNotificationDefinition", "MyLocalizationSourceName"),
permissionDependency: new SimplePermissionDependency("App.Pages.UserManagement")
)
);
}
}

在模块的PreInitialize事件里注册它

 Configuration.Notifications.Providers.Add<MyAppNotificationProvider>();

最后,你可以在你应用中注入并使用INotificationDefinitionManager来获取通知定义,接着你可能想准备一个允许用户自己订阅这些通知的页面。

ABP文档笔记 - 通知的更多相关文章

  1. ABP文档笔记系列

    ABP文档笔记 - 模块系统 及 配置中心 ABP文档笔记 - 事件BUS ABP文档笔记 - 数据过滤 ABP文档笔记 - 规约 ABP文档笔记 - 配置.设置.版本.功能.权限 ABP文档笔记 - ...

  2. ABP文档笔记 - 事件BUS

    文档: ABP框架 - 领域事件(EventBus) EventBus & Domain Events ABP源码分析二十五:EventBus EventBus(事件总线) EventBus是 ...

  3. ABP文档笔记 - 数据过滤

    预定义的过滤 ISoftDelete 软删除过滤用来在查询数据库时,自动过滤(从结果中抽取)已删除的实体.如果一个实体可以被软删除,它必须实现ISoftDelete接口,该接口只定义了一个IsDele ...

  4. ABP文档笔记 - 配置、设置、版本、功能、权限

    配置 全局仅一个单例,保存一组配置信息,一般直接在模块的预启动事件中赋值or修改.没有Scope划分,无论租户还是房东亦或者用户读取的值都不会有差异.每个模块都可以扩展这个配置. 设置 它没有层级关系 ...

  5. ABP文档笔记 - 规约

    ABP框架 - 规约 简介 规约模式是一个特别的软件设计模式,业务逻辑可以使用boolean逻辑重新链接业务逻辑(维基百科). 实践中的大部分情况,它是为实体或其它业务对象,定义可复用的过滤器. 理解 ...

  6. ABP文档笔记 - 模块系统 及 配置中心

    ABP框架 - 模块系统 ABP框架 - 启动配置 Module System Startup Configuration ABP源码分析三:ABP Module ABP源码分析四:Configura ...

  7. ABP文档 - 通知系统

    文档目录 本节内容: 简介 发送模式 通知类型 通知数据 通知重要性 关于通知持久化 订阅通知 发布通知 用户通知管理器 实时通知 客户端 通知存储 通知定义 简介 通知用来告知用户系统里特定的事件发 ...

  8. ABP文档 - Javascript Api - AJAX

    本节内容: AJAX操作相关问题 ABP的方式 AJAX 返回信息 处理错误 HTTP 状态码 WrapResult和DontWrapResult特性 Asp.net Mvc 控制器 Asp.net ...

  9. ABP文档 - SignalR 集成

    文档目录 本节内容: 简介 安装 服务端 客户端 连接确立 内置功能 通知 在线客户端 帕斯卡 vs 骆峰式 你的SignalR代码 简介 使用Abp.Web.SignalR nuget包,使基于应用 ...

随机推荐

  1. Tess4J OCR简单使用教程

    Tess4J简介 Tesseract-OCR支持中文识别,并且开源和提供全套的训练工具,是快速低成本开发的首选.而Tess4J则是Tesseract在Java PC上的应用.在英文和数字识别中性能还是 ...

  2. oracle11g导出表时会发现少表,空表导不出解决方案

    oracle11g导出表时会发现少表,空表导不出解决方案.   一:背景引入 oracle11g用exp命令导出数据库表时,有时会发现只导出了一部分表时而且不会报错,原因是有空表没有进行导出,之前一直 ...

  3. Hive函数:LAG,LEAD,FIRST_VALUE,LAST_VALUE

    参考自大数据田地:http://lxw1234.com/archives/2015/04/190.htm 测试数据准备: create external table test_data ( cooki ...

  4. hdu1060 Leftmost Digit---求N的N次方的首位(对数)

    题目链接: http://acm.hdu.edu.cn/showproblem.php?pid=1060 题目描述:求N的N次方的第一位. 思路: 第一次做这种类型的题目,学到了如何运用对数. 首先推 ...

  5. JavaScript的屏幕对象

    screen 屏幕对象 反映了当前用户的屏幕设置. width 返回屏幕的宽度(像素数). height 返回屏幕的高度. availWidth 返回屏幕的可用宽度(除去了一些不自动隐藏的类似任务栏的 ...

  6. Treap讲解

    Treap讲解 上一篇blog提出了Treap这个算法,在这里我就要详细讲解. 首先,我们可以从字面上理解这个算法,Treap这个单词是由Tree和Heap两个单词构成的,所以它的性质就很好理解了,明 ...

  7. [C#]在 DotNetCore 下的 Swagger UI 自定义操作

    1.Swagger UI 是什么? Swagger UI 是一个在线的 API 文档生成与测试工具,你可以将其集成在你的 API 项目当中. 支持 API 自动同步生成文档 高度自定义,可以自己扩展功 ...

  8. osx mitmproxy ssl 错误

    记录一下,总是在这里折腾. cd ~ cd .mitmproxy cp mitmproxy-ca-cert.pem ~/ 然后到目录下双击mitmproxy-ca-cert.pem ,在钥匙串中的登录 ...

  9. ●POJ poj 2112 Optimal Milking

    ●题目大意: 给出K个挤奶机器(编号1~K),C头牛(编号K+1~K+C)(机器和牛各在不同的地方)和每台机器最多可M头牛挤奶: 然后以邻接矩阵告诉各点间的直接距离(不同的地方间若直接距离等于0,则表 ...

  10. ●BZOJ 4518 [Sdoi2016]征途

    题链: http://www.lydsy.com/JudgeOnline/problem.php?id=4518 题解: 斜率优化DP 首先看看最后答案的形式: 设a[i]为第i天走的距离,那么 $A ...