企业推送架构指南

项目
08/12/2024

当今企业正在逐渐趋向为其最终用户（外部）或员工（内部）创建移动应用程序。它们已经拥有现成的后端系统，无论是大型机还是一些 LoB 应用程序都必须集成到移动应用程序体系结构中。本指南介绍如何最好地实现此集成，并针对常见场景建议可能的解决方案。

一个常见需求是在后端系统中发生了用户感兴趣的事件时，通过其移动应用程序向用户发送推送通知。例如，某位在 iPhone 上安装了银行的银行应用的客户想要在记入其帐户的借方金额超过特定值时收到通知，或者在 Intranet 方案中，某位在 Windows Phone 上安装了预算审批应用的财务部门员工，希望在收到审批请求时获得通知。

银行帐户或审批处理很可能要在某个后端系统中完成，该系统必须启动到用户的推送。可能有多个此类后端系统，所有这些系统在事件触发通知时都必须生成同样的逻辑来进行推送。此处的复杂性在于将多个后端系统与单个推送系统集成在一起，在此系统中，最终用户可能已订阅不同的通知，甚至可能存在多个移动应用程序。例如，对于 Intranet 移动应用来说，一个移动应用程序可能需要从多个此类后端系统接收通知。后端系统不知道或不需要知道推送语义/技术，因此常见的解决方案是引入一个组件，该组件轮询后端系统是否存在任何相关事件并负责将推送消息发送到客户端。

更好的解决方案是使用 Azure 服务总线 - 主题/订阅模型，该模型会降低复杂性，同时使解决方案可扩展。

下面是该解决方案的一般体系结构（普遍用于多个移动应用，但在只有一个移动应用时也同样适用）

体系结构

显示事件、订阅和推送消息流的企业体系结构关系图。

此体系结构图中的关键部分是 Azure 服务总线，它提供了主题/订阅编程模型（可在服务总线 Pub/Sub 编程中找到有关它的更多内容）。接收方，在本示例中是移动后端（通常是 Azure 移动服务，它会启动到移动应用的推送）不直接从后端系统接收消息，而是改用 Azure 服务总线提供的中间抽象层，移动后端通过它可从一个或多个后端系统接收消息。需要为每个后端系统创建服务总线主题，例如帐户、人力资源、财务等，这些基本上都是相关“主题”，会启动要作为推送通知发送的消息。后端系统会向这些主题发送消息。移动后端可以通过创建服务总线订阅来订阅一个或多个此类主题。这会授权移动后端从相应的后端系统接收通知。移动后端将继续在其订阅上侦听消息，一条消息到达后，它将立即返回并将该消息作为通知发送到通知中心。然后，通知中心最终将该消息传送到移动应用。下面是关键组件列表：

后端系统（LoB/旧系统）
- 创建服务总线主题
- 发送消息
移动后端
- 创建服务订阅
- 接收消息（来自后端系统）
- 将通知发送到客户端（通过 Azure 通知中心）
移动应用程序
- 接收并显示通知

优点

接收方（通过通知中心的移动应用/服务）和发送方（后端系统）之间的这种解耦使得只需要最小的更改即可集成其他后端系统。
这还使得采用多个移动应用的方案能够从一个或多个后端系统接收事件。

示例

先决条件

完成以下教程，熟悉相关概念以及常见的创建和配置步骤：

服务总线 Pub/Sub 编程 - 此教程说明了使用服务总线主题/订阅的详细信息、如何创建命名空间以包含主题/订阅、如何通过它们发送和接收消息。
通知中心 - Windows 通用教程 - 此教程说明了如何设置 Windows 应用商店应用以及如何使用通知中心注册，并接收通知。

代码示例

完整的示例代码可在通知中心示例中找到。它分为三个组件：

EnterprisePushBackendSystem

a. 此项目使用 Azure.Messaging.ServiceBus NuGet 包，并基于服务总线 Pub/Sub 编程构建。

b. 此应用程序是一个简单的 C# 控制台应用，可模拟启动要传送到移动应用的消息的 LoB 系统。

static async Task Main(string[] args)
{
    string connectionString =
        ConfigurationManager.AppSettings.Get("Azure.ServiceBus.ConnectionString");

    // Create the topic
    await CreateTopicAsync(connectionString);

    // Send message
    await SendMessageAsync(connectionString);
}

c. CreateTopicAsync 用于创建服务总线主题。

public static async Task CreateTopicAsync(string connectionString)
{
    // Create the topic if it does not exist already
    ServiceBusAdministrationClient client = new ServiceBusAdministrationClient(connectionString);

    if (!await client.TopicExistsAsync(topicName))
    {
        await client.CreateTopicAsync(topicName);
    }
}

d. SendMessageAsync 用于将消息发送到此服务总线主题。出于本示例的目的，此代码只定期向此主题发送一组随机消息。通常会有在事件发生时发送消息的后端系统。

public static sync Task SendMessageAsync(string connectionString)
{
    await using var client = new ServiceBusClient(connectionString);
    ServiceBusSender sender = client.CreateSender(topicName);

    // Sends random messages every 10 seconds to the topic
    string[] messages =
    {
        "Employee Id '{0}' has joined.",
        "Employee Id '{0}' has left.",
        "Employee Id '{0}' has switched to a different team."
    };

    while (true)
    {
        Random rnd = new Random();
        string employeeId = rnd.Next(10000, 99999).ToString();
        string notification = String.Format(messages[rnd.Next(0,messages.Length)], employeeId);

        // Send Notification
        ServiceBusMessage message = new ServiceBusMessage(notification);
        await sender.SendMessageAsync(message);

        Console.WriteLine("{0} Message sent - '{1}'", DateTime.Now, notification);

        System.Threading.Thread.Sleep(new TimeSpan(0, 0, 10));
    }
}

ReceiveAndSendNotification

a. 此项目使用 Azure.Messaging.ServiceBus 和 Microsoft.Web.WebJobs.Publish NuGet 包，并基于服务总线 Pub/Sub 编程构建。

b. 以下控制台应用作为 [Azure WebJob] 运行，因为它必须连续运行才能侦听来自 LoB/后端系统的消息。此应用程序是移动后端的一部分。

static async Task Main(string[] args)
{
    string connectionString =
             ConfigurationManager.AppSettings.Get("Azure.ServiceBus.ConnectionString");

    // Create the subscription that receives messages
    await CreateSubscriptionAsync(connectionString);

    // Receive message
    await ReceiveMessageAndSendNotificationAsync(connectionString);
}

c. CreateSubscriptionAsync 用于为后端系统发送消息的主题创建服务总线订阅。根据业务方案，该组件会创建符合相应主题的一个或多个订阅（例如，一些用户可以从人力资源系统接收消息，一些可从财务系统接收消息，等等）

static async Task CreateSubscriptionAsync(string connectionString)
{
    // Create the subscription if it does not exist already
    ServiceBusAdministrationClient client = new ServiceBusAdministrationClient(connectionString);

    if (!await client.SubscriptionExistsAsync(topicName, subscriptionName))
    {
        await client.CreateSubscriptionAsync(topicName, subscriptionName);
    }
}

d. ReceiveMessageAndSendNotificationAsync 用于使用其订阅从主题中读取消息，如果读取成功，则会制作要使用 Azure 通知中心发送到移动应用程序的通知（在示例方案中为 Windows 本机 toast 通知）。

static async Task ReceiveMessageAndSendNotificationAsync(string connectionString)
{
    // Initialize the Notification Hub
    string hubConnectionString = ConfigurationManager.AppSettings.Get
            ("Microsoft.NotificationHub.ConnectionString");
    hub = NotificationHubClient.CreateClientFromConnectionString
            (hubConnectionString, "enterprisepushservicehub");

    ServiceBusClient Client = new ServiceBusClient(connectionString);
    ServiceBusReceiver receiver = Client.CreateReceiver(topicName, subscriptionName);

    // Continuously process messages received from the subscription
    while (true)
    {
        ServiceBusReceivedMessage message = await receiver.ReceiveMessageAsync();
        var toastMessage = @"<toast><visual><binding template=""ToastText01""><text id=""1"">{messagepayload}</text></binding></visual></toast>";

        if (message != null)
        {
            try
            {
                Console.WriteLine(message.MessageId);
                Console.WriteLine(message.SequenceNumber);
                string messageBody = message.Body.ToString();
                Console.WriteLine("Body: " + messageBody + "\n");

                toastMessage = toastMessage.Replace("{messagepayload}", messageBody);
                SendNotificationAsync(toastMessage);

                // Remove message from subscription
                await receiver.CompleteMessageAsync(message);
            }
            catch (Exception)
            {
                // Indicate a problem, unlock message in subscription
                await receiver.AbandonMessageAsync(message);
            }
        }
    }
}
static async void SendNotificationAsync(string message)
{
    await hub.SendWindowsNativeNotificationAsync(message);
}

e. 要将此应用发布为 WebJob，请右键单击 Visual Studio 中的解决方案，然后选择“发布为 WebJob”

显示的右键单击选项的屏幕截图，其中“发布为 Azure Web 作业”以红色标出。

f. 选择发布配置文件并创建新的 Azure 网站（如果它尚未存在），该网站会托管此 WebJob，拥有该网站后，单击“发布”。

显示在 Azure 上创建网站的工作流的屏幕截图。

g. 将该作业配置为“连续运行”，以便在登录到 Azure 门户时，可看到如下内容：

Azure 门户的屏幕截图，其中显示了企业推送后端 Web 作业，名称、计划和日志值以红色标出。

EnterprisePushMobileApp

a. 此应用程序一个 Windows 应用商店应用程序，它从作为移动后端的一部分运行的 WebJob 接收 toast 通知并显示。此代码基于通知中心 - Windows 通用教程构建。

b. 确保应用程序已启用接收 toast 通知。

c. 确保在应用启动时（替换 HubName 和 DefaultListenSharedAccessSignature 值后）调用以下通知中心注册代码：

private async void InitNotificationsAsync()
{
    var channel = await PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync();

    var hub = new NotificationHub("[HubName]", "[DefaultListenSharedAccessSignature]");
    var result = await hub.RegisterNativeAsync(channel.Uri);

    // Displays the registration ID so you know it was successful
    if (result.RegistrationId != null)
    {
        var dialog = new MessageDialog("Registration successful: " + result.RegistrationId);
        dialog.Commands.Add(new UICommand("OK"));
        await dialog.ShowAsync();
    }
}

运行示例

确保 WebJob 成功运行并且计划为“连续运行”。
运行 EnterprisePushMobileApp，这可启动 Windows 应用商店应用。
运行 EnterprisePushBackendSystem 控制台应用程序，这可模拟 LoB 后端并开始发送消息，应该出现如下图所示的 toast 通知：
这些消息最初会发送到由 Web 作业中的服务总线订阅监视的服务总线主题。收到消息后，将创建通知并将其发送到移动应用。转到 Azure 门户中 Web 作业的“日志”链接时，可以仔细查看 Web 作业日志来确认处理：

通过

企业推送架构指南

体系结构

优点

示例

先决条件

代码示例

运行示例

其他资源