WPF+ASP.NET SignalR實現(xiàn)后臺通知功能的示例代碼

更新時間：2022年09月14日 08:36:14 作者：小六公子

本文以一個簡單示例，簡述如何通過WPF+ASP.NET SignalR實現(xiàn)消息后臺通知以及數(shù)據(jù)的實時刷新，僅供學習分享使用，如有不足之處，還請指正

在實際業(yè)務中，當后臺數(shù)據(jù)發(fā)生變化，客戶端能夠?qū)崟r的收到通知，而不是由用戶主動的進行頁面刷新才能查看，這將是一個非常人性化的設計。比如數(shù)字化大屏，并沒有人工的干預，而是自動的刷新數(shù)據(jù)，那如何才能實現(xiàn)數(shù)據(jù)的實時刷新呢？本文以一個簡單示例，簡述如何通過WPF+ASP.NET SignalR實現(xiàn)消息后臺通知以及數(shù)據(jù)的實時刷新，僅供學習分享使用，如有不足之處，還請指正。

通過上一篇文章的學習，了解了如何通過SignalR實現(xiàn)在線聊天功能，在示例中，我們發(fā)現(xiàn)每一次的客戶端連接都是一個新的實例對象，所以沒有辦法在中心對象中存儲狀態(tài)信息，所以為了存儲用戶列表，我們采用了靜態(tài)變量的方式。并且在線聊天功能是用戶發(fā)送一條消息（Chat），然后觸發(fā)中心對象（ChatHub），轉(zhuǎn)發(fā)給另一個用戶（SendAsync）。那么如果實現(xiàn)數(shù)字化大屏，需要服務端持續(xù)的往客戶端發(fā)送消息，而不是客戶端主動觸發(fā)，應該怎么做呢？這就是本文需要分享的內(nèi)容。

涉及知識點

在本示例中，涉及知識點如下所示：

開發(fā)工具：Visual Studio 2022 目標框架：.NET6.0
ASP.NET SignalR，一個ASP .NET 下的類庫，可以在ASP .NET 的Web項目中實現(xiàn)實時通信，目前新版已支持.NET6.0及以上版本。在本示例中，作為消息通知的服務端。
WPF，是微軟推出的基于Windows 的用戶界面框架，主要用于開發(fā)客戶端程序。

前提條件

實現(xiàn)服務端持續(xù)往客戶端發(fā)送消息，除了業(yè)務上的需求外，還需要滿足兩個條件：

在服務端有一個常駐內(nèi)存對象，監(jiān)聽數(shù)據(jù)變化。
常駐內(nèi)存對象，可以訪問中心對象（ChatHub），能夠獲取中心對象的所有連接客戶端，并發(fā)送消息。

滿足以上兩個條件，才可以實現(xiàn)想要的功能。

服務端

經(jīng)過以上分析后，服務端分為兩方面，核心對象（ChatHub），處理業(yè)務對象（Worker）。下面我們逐一說明：

ChatHub 中心是用于向連接到 SignalR 服務器的客戶端發(fā)送消息的核心抽象，負責客戶端的連接和斷開。如下所示：

using Microsoft.AspNetCore.SignalR;

namespace SignalRChat.Chat
{
    public class ChatHub:Hub
    {
        public override Task OnConnectedAsync()
        {
            Console.WriteLine($"ID:{Context.ConnectionId} 已連接");
            return base.OnConnectedAsync();
        }

        public override Task OnDisconnectedAsync(Exception? exception)
        {
            Console.WriteLine($"ID:{Context.ConnectionId} 已斷開");
            return base.OnDisconnectedAsync(exception);
        }
    }
}

Worker實例為一個單例對象，常駐內(nèi)容，實時監(jiān)聽數(shù)據(jù)變化，并通過ChatHub上下文（IHubContext<ChatHub>）獲取連接信息，然后發(fā)送消息，如下所示：

using Microsoft.AspNetCore.SignalR;

namespace SignalRChat.Chat
{
    public class Worker
    {
        public static Worker Instance;

        private static readonly object locker=new object();

        private IHubContext<ChatHub> context;

        private System.Timers.Timer timer;

        public Worker(IHubContext<ChatHub> context) {
            this.context = context;
            timer= new System.Timers.Timer(500);//單位毫秒
            timer.Enabled=true;
            timer.AutoReset=true;//自動重新
            timer.Elapsed += Timer_Elapsed;
            timer.Start();
        }

        private void Timer_Elapsed(object? sender, System.Timers.ElapsedEventArgs e)
        {
            //模擬數(shù)據(jù)，一般情況下，從數(shù)據(jù)庫獲取，然后通知到客戶端
            Dictionary<string, object> data = new Dictionary<string, object>();
            var online = new Random().Next(0, 100);
            var male = Math.Floor(new Random().NextSingle() * online);
            var female = online - male;
            data["online"]=online;
            data["male"] =male;
            data["female"] = female;
            context.Clients.All.SendAsync("Data",data);
        }

        public static void Register(IHubContext<ChatHub> context)
        {
            if (Instance == null)
            {
                lock (locker)
                {
                    if (Instance == null)
                    {
                        Instance = new Worker(context);
                    }
                }
            }
        }
    }
}

注意：此處發(fā)送數(shù)據(jù)的是Data方法，客戶端必須監(jiān)聽Data方法，才能接收數(shù)據(jù)。

如何創(chuàng)建單例對象呢，中心對象上下文不能自己創(chuàng)建，必須要和ChatHub通過注入方式的上下文是同一個，不然無法獲取客戶端連接信息。在項目啟動時，通過中間件的方式創(chuàng)建，如下所示：

using Microsoft.AspNetCore.SignalR;
using SignalRChat.Chat;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
//1.添加SignalR服務
builder.Services.AddSignalR();
var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseRouting();
app.UseHttpsRedirection();

app.UseAuthorization();
//在Use中注冊單例實例
app.Use(async (context, next) =>
{
    var hubContext = context.RequestServices
                            .GetRequiredService<IHubContext<ChatHub>>();
    Worker.Register(hubContext);//調(diào)用靜態(tài)方法注冊

    if (next != null)
    {
        await next.Invoke();
    }
});
app.MapControllers();
//2.映射路由
app.UseEndpoints(endpoints => {
    endpoints.MapHub<ChatHub>("/chat");
});

app.Run();

客戶端

客戶端主要是連接服務器，然后監(jiān)聽服務端發(fā)送數(shù)據(jù)的方法即可，如下所示：

namespace SignalRClient
{
    public class ShowDataViewModel : ObservableObject
    {
        #region 屬性及構造函數(shù)

        private int online;

        public int Online
        {
            get { return online; }
            set { SetProperty(ref online, value); }
        }

        private int male;

        public int Male
        {
            get { return male; }
            set { SetProperty(ref male, value); }
        }


        private int female;

        public int Female
        {
            get { return female; }
            set { SetProperty(ref female, value); }
        }

        private HubConnection hubConnection;

        public ShowDataViewModel()
        {

        }

        #endregion

        #region 命令

        private ICommand loadedCommand;

        public ICommand LoadedCommand
        {
            get
            {
                if (loadedCommand == null)
                {
                    loadedCommand = new RelayCommand<object>(Loaded);
                }
                return loadedCommand;
            }
        }

        private void Loaded(object obj)
        {
            //1.初始化
            InitInfo();
            //2.監(jiān)聽
            Listen();
            //3.連接
            Link();
        }

        #endregion

        /// <summary>
        /// 初始化Connection對象
        /// </summary>
        private void InitInfo()
        {
            hubConnection = new HubConnectionBuilder().WithUrl("https://localhost:7149/chat").WithAutomaticReconnect().Build();
            hubConnection.KeepAliveInterval = TimeSpan.FromSeconds(5);
        }

        /// <summary>
        /// 監(jiān)聽
        /// </summary>
        private void Listen()
        {
            hubConnection.On<Dictionary<string,object>>("Data", ReceiveInfos);
        }

        /// <summary>
        /// 連接
        /// </summary>
        private async void Link()
        {
            try
            {
                await hubConnection.StartAsync();
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }

        private void ReceiveInfos(Dictionary<string, object> data)
        {
            if (data == null || data.Count < 1)
            {
                return;
            }
            int.TryParse(data["online"]?.ToString(),out int online);
            int.TryParse(data["male"]?.ToString(),out int male);
            int.TryParse(data["female"]?.ToString(),out int female);
            this.Online=online;
            this.Male = male;
            this.Female=female;
        }
    }
}

注意：監(jiān)聽Data方法，和服務端發(fā)送時保持一致。