Asp.Net SignalR 使用記錄

工作上遇到一個推送消息的功能的實現。本着面向百度編程的思想。網上百度了一大堆。主要的實現方式是原生的WebSocket,和SignalR,再次寫一個關於Asp.Net SignalR 的demo 

這里簡單的介紹一下Signalr,SignalR 封裝了WebSocket、ForeverFrame、ServerSentEvents、LongPolling四種主要的傳輸協議。兼容性比較好,WebSocket 是有要求的,IIS服務需要系統是Win8或者 Server 2012 以上。下面開始擼代碼。

1.首先建立一個項目。

2.通過包管理工具,引入SignalR 

3.引入之后,需要手動添加兩個類。

PushHub 集線器類,Singlarl類的主要操作都由這個類實現。

    public class PushHub : Hub
    {
        /// <summary>
        /// 第一次連接
        /// </summary>
        /// <returns></returns>
        public override Task OnConnected()
        {
            return base.OnConnected();
        }

        /// <summary>
        /// 斷開連接
        /// </summary>
        /// <param name="stopCalled"></param>
        /// <returns></returns>
        public override Task OnDisconnected(bool stopCalled)
        {
            string user = ConnectManager.GetUserName(Context.ConnectionId);
            ConnectManager.RemoveUser(user);
            Show(string.Format("{0}退出", user));

            return base.OnDisconnected(stopCalled);
        }

        /// <summary>
        /// 獲取當前的用戶標識
        /// </summary>
        /// <returns></returns>
        private string GetUserId()
        {
            return Context.QueryString["userId"];
        }

        /// <summary>
        /// 發送消息
        /// </summary>
        /// <param name="content"></param>
        /// <param name="receiveUser"></param>
        public void Show(string content,string receiveUser="")
        {
            string user = ConnectManager.GetUserName(Context.ConnectionId);
            if (string.IsNullOrEmpty(receiveUser))
            {
                Clients.All.show(content);
            }
            else {
                Clients.Client(ConnectManager.GetUserConnect(receiveUser)).show(string.Format("{0}發消息:{1}",user, content));
            }
            
        }

        /// <summary>
        /// 登錄操作
        /// </summary>
        /// <param name="user"></param>
        public void Login(string user)
        {

            ConnectManager.OnlineInit(user, Context.ConnectionId);
            Show(string.Format("{0}:登錄成功", user));
        }

    }

 

4.Startup類

 

 

    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            app.MapSignalR(); //聲明注冊集線器映射
        }
    }

 

 

5.連接管理類

    /// <summary>
    /// 連接管理類
    /// </summary>
    public class ConnectManager
    {
        /// <summary>
        /// 連接記錄池
        /// </summary>
        private readonly static ConcurrentDictionary<string, string> _connectPool = new ConcurrentDictionary<string, string>();

        /// <summary>
        /// 添加用戶
        /// </summary>
        /// <param name="userKey"></param>
        /// <param name="connection"></param>
        public static void AddUser(string userKey, string connection)
        {
            _connectPool[userKey] = connection;
        }

        /// <summary>
        /// 刪除用戶
        /// </summary>
        /// <param name="userKey"></param>
        public static void RemoveUser(string userKey)
        {
            string connection = null;
            _connectPool.TryRemove(userKey, out connection);
        }

        /// <summary>
        /// 是否存在連接(是否在線)
        /// </summary>
        /// <param name="receiverId"></param>
        /// <returns></returns>
        public static bool IsOnline(string receiverId)
        {
            return _connectPool.Keys.Contains(receiverId);
        }

        /// <summary>
        /// 推送消息給個人
        /// </summary>
        /// <param name="receiveId"></param>
        /// <param name="msg"></param>
        public static void PushSingleMessage(string receiveId, string msg)
        {
            try
            {
                GetHubContext().Clients.Client(_connectPool[receiveId]).show(msg);
            }
            catch (Exception ex)
            {
                var errMsg = ex.Message;
            }
        }

        /// <summary>
        /// 獲取推送上下文
        /// </summary>
        /// <returns></returns>
        public static IHubContext GetHubContext()
        {
            return GlobalHost.ConnectionManager.GetHubContext<PushHub>();
        }

        /// <summary>
        /// 上線初始化
        /// </summary>
        /// <param name="userId">用戶ID</param>
        /// <param name="connectionId">連接ID</param>
        public static void OnlineInit(string userId, string connectionId)
        {
            AddUser(userId, connectionId);
        }

        public static string GetUserName(string value)
        {
            return _connectPool.Where(a => a.Value == value).FirstOrDefault().Key;
        }

        public static string GetUserConnect(string userName)
        {
            return _connectPool[userName];
        }
    }

 

6.前台代碼

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title></title>
</head>
<body>
    <div>
        用戶名稱:<input type="text" id="user" placeholder="輸入用戶名" class="input" /><input type="button" id="login" value="登錄" class="btn btn-sm btn-info" /><br />
        接收人：<input type="text" id="receiveUser" placeholder="接收人(不填默認群發)" class="input" /><br />
        <input type="text" id="content" placeholder="發送內容" class="input" /> &nbsp;&nbsp;<input type="button" value="發送" class="btn btn-sm btn-info" id="send" />
        <div>
            <h4>接收到的信息：</h4>
            <ul id="dataContainer"></ul>
        </div>
    </div>
    <script src="Scripts/jquery-3.3.1.min.js"></script>
    <script src="Scripts/jquery.signalR-2.4.1.min.js"></script>
    <script src="signalr/hubs"></script>  ///這個要注意默認就是這樣寫,不要問為什么。哈哈
    <script language="javascript">
        $(function () {
            var chat = $.connection.pushHub;
            
            console.log(chat);
            //連接服務端集線器，demoHub為服務端集線器名稱，js上首字母須改為小寫（系統默認）
            //定義客戶端方法，此客戶端方法必須與服務端集線器中的方法名稱、參數均一致。
            //實際上是服務端調用了前端的js方法（訂閱）
            //若多個參數，服務端也需要一致

            chat.client.show = function (content) {
                var html = '<li>' + htmlEncode(content) + "</li>";
                $("#dataContainer").append(html);
            }

            //定義推送
            $.connection.hub.start()
                .done(function () {
                    $("#login").click(function () {
                        chat.server.login($("#user").val());  //將客戶端的content內容發送到服務端
                        $("#user").val("");
                    });
                    $("#send").click(function () {
                        chat.server.show($("#content").val(), $("#receiveUser").val());  //將客戶端的content內容發送到服務端
                        $("#content").val("");
                    });
                });


        });
        //編碼
        function htmlEncode(value) {
            var encodedValue = $('<div />').text(value).html();
            return encodedValue;
        }
    </script>
</body>

</html>

 

這就是所有的demo的代碼

demo代碼：https://github.com/chaorending/Demo.SignalR.git