SignalR

SignalR是一个.NET Core/.NET Framework的开源实时框架. SignalR的可使用Web Socket, Server Sent Events 和 Long Polling作为底层传输方式.

SignalR基于这三种技术构建, 抽象于它们之上, 它让你更好的关注业务问题而不是底层传输技术问题.

SignalR这个框架分服务器端和客户端, 服务器端支持ASP.NET Core 和 ASP.NET; 而客户端除了支持浏览器里的javascript以外, 也支持其它类型的客户端, 例如桌面应用.

 

回落机制

SignalR使用的三种底层传输技术分别是Web Socket, Server Sent Events 和 Long Polling.

其中Web Socket仅支持比较现代的浏览器, Web服务器也不能太老.

而Server Sent Events 情况可能好一点, 但是也存在同样的问题.

 

所以SignalR采用了回落机制, SignalR有能力去协商支持的传输类型.

Web Socket是最好的最有效的传输方式, 如果浏览器或Web服务器不支持它的话, 就会降级使用SSE, 实在不行就用Long Polling.

 

一旦建立连接, SignalR就会开始发送keep alive消息, 来检查连接是否还正常. 如果有问题, 就会抛出异常.

因为SignalR是抽象于三种传输方式的上层, 所以无论底层采用的哪种方式, SignalR的用法都是一样的.

 

SignalR默认采用这种回落机制来进行传输和连接.

但是也可以禁用回落机制, 只采用其中一种传输方式.

 

RPC

RPC (Remote Procedure Call). 它的优点就是可以像调用本地方法一样调用远程服务.

SignalR采用RPC范式来进行客户端与服务器端之间的通信.

SignalR利用底层传输来让服务器可以调用客户端的方法, 反之亦然, 这些方法可以带参数, 参数也可以是复杂对象, SignalR负责序列化和反序列化.

 

Hub

Hub是SignalR的一个组件, 它运行在ASP.NET Core应用里. 所以它是服务器端的一个类.

Hub使用RPC接受从客户端发来的消息, 也能把消息发送给客户端. 所以它就是一个通信用的Hub.

 

在ASP.NET Core里, 自己创建的Hub类需要继承于基类Hub.

在Hub类里面, 我们就可以调用所有客户端上的方法了. 同样客户端也可以调用Hub类里的方法.

这种Hub+RPC的方式还是非常适合实时场景的.

 

之前说过方法调用的时候可以传递复杂参数, SignalR可以将参数序列化和反序列化. 这些参数被序列化的格式叫做Hub 协议, 所以Hub协议就是一种用来序列化和反序列化的格式.

Hub协议的默认协议是JSON, 还支持另外一个协议是MessagePack. MessagePack是二进制格式的, 它比JSON更紧凑, 而且处理起来更简单快速, 因为它是二进制的.

此外, SignalR也可以扩展使用其它协议..

 

横向扩展

随着系统的运行, 有时您可能需要进行横向扩展. 就是应用运行在多个服务器上.

这时负载均衡器会保证每个进来的请求按照一定的逻辑分配到可能是不同的服务器上.

在使用Web Socket的时候, 没什么问题, 因为一旦Web Socket的连接建立, 就像在浏览器和那个服务器之间打开了隧道一样, 服务器是不会切换的.

但是如果使用Long Polling, 就可能有问题了, 因为使用Long Polling的情况下, 每次发送消息都是不同的请求, 而每次请求可能会到达不同的服务器. 不同的服务器可能不知道前一个服务器通信的内容, 这就会造成问题.

针对这个问题, 我们需要使用Sticky Sessions (粘性会话).

 

Sticky Sessions 貌似有很多中实现方式, 但是主要是下面要介绍的这种方式.

作为第一次请求的响应的一部分, 负载均衡器会在浏览器里面设置一个Cookie, 来表示使用过这个服务器. 在后续的请求里, 负载均衡器读取Cookie, 然后把请求分配给同一个服务器. 

 

在ASP.NET Core 中使用SignalR

创建项目，新建SignalRHub：

using Core.Parameters;
using Microsoft.AspNetCore.SignalR;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace XXXXX.SignalR
{
    public class SignalRHub : Hub
    {
        private readonly DcListService _dcListService;
        public SignalRHub(DcListService dcListService)
        {
            _dcListService = dcListService;
        }
        public void AddMachineCode(string dcCode)
        {
            _dcListService.Add(dcCode, Context.ConnectionId);
        }

        public void Exec(Paramete paramete)
        {
            string connectionId = Context.ConnectionId;
            var toClient = _dcListService.FirstOrDefault(paramete.MachineCode);
            if (toClient == null)
            {
                Clients.Client(Context.ConnectionId).SendAsync("Result", connectionId, false, "系统消息：当前设备不在线!");
            }
            else
            {
                Clients.Client(toClient.ConnectionId).SendAsync("Exec", connectionId, paramete);
            }
        }

        public void Result(string connectionId,bool flag, string data)
        {
            Clients.Client(connectionId).SendAsync("Result", connectionId, flag, data);
        }

        public async override Task OnDisconnectedAsync(Exception exception)
        {
            _dcListService.Remove(Context.ConnectionId);
        }

        public async override Task OnConnectedAsync()
        {
            //string connectionId = Context.ConnectionId;
        }
    }
    public class Paramete
    {
        public string MachineCode { get; set; }
        public string ProcessPath { get; set; }
        public string ExecType { get; set; }
        public string ViewType { get; set; }
        public DateTime? StartDate { get; set; }
        public DateTime? EndDate { get; set; }
    }
}

在Startup里添加：

services.AddScoped<DcListService>();
services.AddSignalR();
app.UseSignalR(routes =>
{
    routes.MapHub<SignalRHub>("/signalR");
});

Winform客户端代码：

using Microsoft.AspNetCore.SignalR.Client;
using System;
using System.Drawing;
using System.Windows.Forms;

namespace WindowsFormsSample
{
    public partial class ChatForm : Form
    {
        private HubConnection _connection;

        public ChatForm()
        {
            InitializeComponent();
        }

        private void ChatForm_Load(object sender, EventArgs e)
        {
            addressTextBox.Focus();
        }

        private void addressTextBox_Enter(object sender, EventArgs e)
        {
            AcceptButton = connectButton;
        }

        private async void connectButton_Click(object sender, EventArgs e)
        {
            UpdateState(connected: false);

            _connection = new HubConnectionBuilder()
                .WithUrl(addressTextBox.Text)
                .Build();

            _connection.On<string, Paramete>("Exec", Exec);

            Log(Color.Gray, "Starting connection...");
            try
            {
                await _connection.StartAsync();
                await _connection.InvokeAsync("AddMachineCode", this.dcCodeTextBox.Text);
            }
            catch (Exception ex)
            {
                Log(Color.Red, ex.ToString());
                return;
            }

            Log(Color.Gray, "Connection established.");

            UpdateState(connected: true);

            messageTextBox.Focus();
        }

        private async void disconnectButton_Click(object sender, EventArgs e)
        {
            Log(Color.Gray, "Stopping connection...");
            try
            {
                await _connection.StopAsync();
            }
            catch (Exception ex)
            {
                Log(Color.Red, ex.ToString());
            }

            Log(Color.Gray, "Connection terminated.");

            UpdateState(connected: false);
        }

        private void messageTextBox_Enter(object sender, EventArgs e)
        {
            AcceptButton = sendButton;
        }

        private async void sendButton_Click(object sender, EventArgs e)
        {
            try
            {
                await _connection.InvokeAsync("SendSingle", this.toDcCodeTextBox.Text, messageTextBox.Text);
            }
            catch (Exception ex)
            {
                Log(Color.Red, ex.ToString());
            }
        }

        private void UpdateState(bool connected)
        {
            disconnectButton.Enabled = connected;
            connectButton.Enabled = !connected;
            addressTextBox.Enabled = !connected;

            messageTextBox.Enabled = connected;
            sendButton.Enabled = connected;
        }

        private async void Exec(string connectionId, Paramete paramete)
        {
            Log(Color.Black, "");
            Log(Color.Black, "消息来了");
            Log(Color.Black, $"ConnectionId:{connectionId}");
            Log(Color.Black, $"MachineCode:{paramete.MachineCode}");
            Log(Color.Black, $"ProcessPath:{paramete.ProcessPath}");
            Log(Color.Black, $"ExecType:{paramete.ExecType}");
            Log(Color.Black, $"ViewType:{paramete.ViewType}");
            Log(Color.Black, $"StartDate:{paramete.StartDate}");
            Log(Color.Black, $"EndDate:{paramete.EndDate}");

            await _connection.InvokeAsync("Result", connectionId, true, "客户端执行成功！");
        }

        private void Log(Color color, string message)
        {
            Action callback = () =>
            {
                messagesList.Items.Add(new LogMessage(color, message));
            };

            Invoke(callback);
        }

        private class LogMessage
        {
            public Color MessageColor { get; }

            public string Content { get; }

            public LogMessage(Color messageColor, string content)
            {
                MessageColor = messageColor;
                Content = content;
            }
        }

        private void messagesList_DrawItem(object sender, DrawItemEventArgs e)
        {
            var message = (LogMessage)messagesList.Items[e.Index];
            e.Graphics.DrawString(
                message.Content,
                messagesList.Font,
                new SolidBrush(message.MessageColor),
                e.Bounds);
        }
    }
    public class Paramete
    {
        public string MachineCode { get; set; }
        public string ProcessPath { get; set; }
        public string ExecType { get; set; }
        public string ViewType { get; set; }
        public DateTime? StartDate { get; set; }
        public DateTime? EndDate { get; set; }
    }
}

using Core.Parameters;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace XXXX.SignalR
{
    public class DcListService
    {
        private static List<OnlineDcCode> DcList = new List<OnlineDcCode>();
        public OnlineDcCode FirstOrDefault(string dcCode)
        {
            return DcList.Where(p => p.DcCode == dcCode).FirstOrDefault();
        }

        public void Add(string dcCode, string connectionId)
        {
            if (FirstOrDefault(dcCode) == null)
            {
                DcList.Add(new OnlineDcCode()
                {
                    ConnectionId = connectionId,
                    DcCode = dcCode
                });
            }
            else
            {
                DcList.Where(p => p.DcCode == dcCode).FirstOrDefault().ConnectionId = connectionId;
            }
        }

        public void Remove(string connectionId)
        {
            var dc = DcList.FirstOrDefault(p => p.ConnectionId == connectionId);
            if (dc != null)
            {
                DcList.Remove(dc);
            }
        }
    }
}

参考：https://www.cnblogs.com/cgzl/p/9515516.html

参考：https://github.com/aspnet/SignalR-samples

SignalR in ASP.NET Core behind Nginx

在Nginx中转发，配置：

server {
    listen       80;
    server_name  localhost;

    #charset koi8-r;
    #access_log  /var/log/nginx/host.access.log  main;

    add_header Access-Control-Allow-Origin *;
    location / {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
        try_files $uri $uri/ /index.html =404;

        if ($request_method = 'OPTIONS') {
                add_header Access-Control-Allow-Origin *;
                add_header Access-Control-Allow-Methods GET,POST,PUT,DELETE,OPTIONS;
                return 204;
        }
    }

    location ^~ /api/signalR
    {
        if ($request_method = 'OPTIONS') {
                add_header Access-Control-Allow-Origin *;
                add_header Access-Control-Allow-Methods GET,POST,PUT,DELETE,OPTIONS;
                return 204;
        }
        proxy_pass http://192.168.1.231:8091;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }

    location ^~ /api/                                                                                                                                                    {
        if ($request_method = 'OPTIONS') {
                add_header Access-Control-Allow-Origin *;
                add_header Access-Control-Allow-Methods GET,POST,PUT,DELETE,OPTIONS;
                return 204;
        }
        proxy_pass http://192.168.1.231:8091;
    }
    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    # error_page   500 502 503 504  /50x.html;
    # location = /50x.html {
    #   root   /usr/share/nginx/html;
    # }

    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
    #
    #location ~ \.php$ {
    #    proxy_pass   http://127.0.0.1;
    #}

    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #    root           html;
    #    fastcgi_pass   127.0.0.1:9000;
    #    fastcgi_index  index.php;
    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
    #    include        fastcgi_params;
    #}

    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #    deny  all;
    #}
}

 参考：https://stackoverflow.com/questions/48300288/signalr-in-asp-net-core-behind-nginx

断开后自动重新连接：

//2、彻底断开 重新连接
_connection.Closed += async (error) =>
{
    Log(Color.Red, $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.ff")} 断开连接: " + error);
    await Task.Delay(new Random().Next(0, 5) * 1000);
    int count = 0;
    while (_connection.State == HubConnectionState.Disconnected)
    {
        try
        {
            //4、开启会话
            await _connection.StartAsync();
            //5、将 机器码 和 exe文件路径 与 当前连接关联上
            await _connection.InvokeAsync("AddMachineCode", this.dcCodeTextBox.Text);
            Log(Color.Green, $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.ff")} ----- 重新连接成功！ ------");
        }
        catch (Exception ex)
        {
            Log(Color.Red, ex.ToString());
        }
        Log(Color.Red, $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.ff")} ----- 第 {++count} 彻底断开 尝试重连 ------");
        await Task.Delay(new Random().Next(0, 5) * 1000);
    }
};

JWT认证：

#region Authentication
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
    .AddJwtBearer(options =>
    {
        options.TokenValidationParameters = new TokenValidationParameters
        {
            ValidateIssuer = true,
            ValidateAudience = true,
            ValidateLifetime = true,
            ValidateIssuerSigningKey = true,
            ValidIssuer = Configuration["Jwt:Issuer"],
            ValidAudience = Configuration["Jwt:Issuer"],
            IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(Configuration["Jwt:Key"]))
        };
        options.Events = new JwtBearerEvents()
        {
            OnMessageReceived = context =>
            {
                if (context.Request.Path.ToString().StartsWith("/api/signalR"))
                    context.Token = context.Request.Query["access_token"];
                return Task.CompletedTask;
            },
        };
    });
#endregion

主要是这一段：

options.Events = new JwtBearerEvents()
{
    OnMessageReceived = context =>
    {
        if (context.Request.Path.ToString().StartsWith("/api/signalR"))
            context.Token = context.Request.Query["access_token"];
        return Task.CompletedTask;
    },
};

客户端配置：

服务器端配置：

Logo
开放原子开发者工作坊

开放原子开发者工作坊旨在鼓励更多人参与开源活动，与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动，如meetup、训练营等，主打技术交流，干货满满，真诚地邀请各位开发者共同参与！

更多推荐

“小满”安全车控操作系统正式在AtomGit开源

10月24日，由中国汽车工业协会指导，普华基础软件股份有限公司主办的“小满”安全车控操作系统开源发布会暨共建计划说明会成功举行。普华基础软件宣布将安全车控操作系统“小满”（简称“小满”）V24.10源代码正式在开放原子开源基金会（简称“基金会”）旗下AtomGit开源协作平台开源，并在AtomGit平

avatar 开放原子开发者工作坊

开放原子大赛——CIKM 2024赛果揭晓，10强争霸，角逐第33届国际信息与知识管理大会

开放原子大赛——CIKM 2024赛果揭晓，10强争霸，角逐第33届国际信息与知识管理大会

avatar 开放原子开发者工作坊

50万奖金池！开放原子大赛——第二届OpenHarmony创新应用挑战赛正式启动

50万奖金池！开放原子大赛——第二届OpenHarmony创新应用挑战赛正式启动

avatar 开放原子开发者工作坊