SignalR 简单入门项目

概述
SignalR是通讯框架,前台Web页面与后台服务实现数据的交互。ASP.NET SignalR 是一个为 ASP.NET 开发人员的库,简化了将实时 web 功能添加到应用程序的过程。实时Web功能使服务端代码推送内容到链接可客服端并立即应用成为可能,而不需要服务端等待客户端去请求数据。

SignalR可用于任何你想添加实时Web功能到ASP.NET应用程序的情形,聊天室是一个常用的例子,用户可以刷新Web页面来获得新的数据,或者页面使用一个长轮询来取回数据,这都是SignalR可以应用的场景。比如说仪表盘和监视系统,实时游戏等。

SignalR支持以一种简单的API来创建服务器到客户端的远程调用客户端的Javascript方法,SignalR还包括用于用于连接管理的API和分组连接。

创建项目:
第一步:创建简单的Web Form项目,通过NuGet安装Microsoft.AspNet.SignalR组件。

 

 第二步:添加OWIN Startup类,并修改映射内容

 

 修改内容如下:

namespace AiShou.WebSite
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // 有关如何配置应用程序的详细信息,请访问 https://go.microsoft.com/fwlink/?LinkID=316888
            app.MapSignalR();
        }
    }
}

第三步:添加Hub类,并修改代码内容

 

 

修改内容如下:

 /// <summary>
    /// 聊天集线器
    /// </summary>
    public class ChatHub : Hub
    {
        /// <summary>
        /// (服务端)发送消息
        /// </summary>
        /// <param name="selfId">发送的用户Id</param>
        /// <param name="otherId">要接收的用户Id</param>
        /// <param name="content">消息内容</param>
        /// <param name="timestamp">时间戳</param>
        public void SendMessage(int selfId, int otherId, string content, long timestamp)
        {
            // (客户端)消费消息
            Clients.User(otherId.ToString()).consumerMessage(selfId, content, timestamp);
            // 存储消息
            IFriendManager friendManager = new FriendManager();
            friendManager.SendMessage(selfId, otherId, content);
        }
    }

第四步:修改WebForm JS内容。修改自己书写的前台代码

//下面是我自己的前台代码

<%@ Page Title="" Language="C#" MasterPageFile="~/Site.Master" AutoEventWireup="true" CodeBehind="Chat.aspx.cs" Inherits="AiShou.WebSite.Chat" %>

<asp:Content ID="HeadContent" ContentPlaceHolderID="HeadContent" runat="server">
    <style>
        .message-avatar { opacity: 1 !important; }
    </style>
</asp:Content>
<asp:Content ID="BodyContent" ContentPlaceHolderID="BodyContent" runat="server">
    <div class="page" data-page="chat">
        <!-- 对方昵称 -->
        <div class="navbar">
            <div class="navbar-inner">
                <div class="title"><%=friend.NickName??"用户"+friend.Id%></div>
            </div>
        </div>
        <!-- 输入框 -->
        <div class="toolbar messagebar">
            <div class="toolbar-inner">
                <div class="messagebar-area">
                    <textarea id="messageContent" class="resizable" rows="1"></textarea>
                </div>
                <a href="#" id="sendMessage" class="link send-link">发送</a>
            </div>
        </div>
        <!-- 下拉刷新 -->
        <div class="ptr-preloader">
            <div class="preloader"></div>
            <div class="ptr-arrow"></div>
        </div>
        <!-- 消息列表 -->
        <div class="page-content chat">
            <div class="messages" id="messageList"></div>
        </div>
    </div>
</asp:Content>
<asp:Content ID="ScriptContent" ContentPlaceHolderID="ScriptContent" runat="server">
    <script src="lib/template7/dist/template7.min.js"></script>
    <script id="sentMessage" type="text/template7">
        <div class="message message-sent">
            <div class="message-avatar" style="background-image: url('<%=user.Avatar??"/imgs/avatar.jpg"%>');"></div>
            <div class="message-content">
                <div class="message-bubble">
                    <div class="message-text">{{Content}}</div>
                </div>
            </div>
        </div>
    </script>
    <script id="receivedMessage" type="text/template7">
        <div class="message message-received">
            <div class="message-avatar" style="background-image: url('<%=friend.Avatar??"/imgs/avatar.jpg"%>');"></div>
            <div class="message-content">
                <div class="message-bubble">
                    <div class="message-text">{{Content}}</div>
                </div>
            </div>
        </div>
    </script>
    <script src="Scripts/jquery-1.6.4.min.js"></script>
    <script src="Scripts/jquery.signalR-2.4.1.min.js"></script>
    <script src="signalr/hubs"></script>
    <script>
        var selfId = '<%=user.Id%>';
        var otherId = '<%=friend.Id%>';
        // 下拉加载
        var allowLoad = true;
        var pageNumber = 1;
        var pageSize = 10;
        $$('.chat').on('ptr:refresh', function () {
            loadRecords();
        })
        // 异步加载聊天记录
        loadRecords();
        function loadRecords() {
            if (!allowLoad) {
                return;
            }
            allowLoad = false;
            var params = {
                selfId: selfId,
                otherId: otherId,
                pageNumber: pageNumber,
                pageSize: pageSize
            }
            app.request.get('ChatRecordHandler.ashx', params, function (data) {
                var res = JSON.parse(data);
                // 如果加载到数据,则显示
                if (res.length > 0) {
                    for (var i = res.length - 1; i >= 0; i--) {
                        addMessageToPage(res[i]);
                    }
                    pageNumber++;
                    allowLoad = true;
                }
                // 如果结果长度为0或者小于每页数量,则加载完成
                if (res.length == 0 || res.length < pageSize) {
                    allowLoad = false;
                    return;
                }
                // 重置下拉加载
                else {
                    app.ptr.done();
                }
            });
        }

        $(function () {
            // 获取集线器
            var chat = $.connection.chatHub;
            // 接收消息
            chat.client.consumerMessage = function (fromId, content, timestamp) {
                // 在页面显示内容
                var message = {
                    UserId: fromId,
                    Content: content,
                    AddTime: timestamp
                }
                addMessageToPage(message);
            }
            // 发送消息
            $.connection.hub.start().done(function () {
                $('#sendMessage').click(function () {
                    // 获取内容
                    var content = $('#messageContent').val();
                    if (!content)
                        return;
                    // 发送消息
                    var timestamp = parseInt(new Date().getTime() / 1000);
                    chat.server.sendMessage(selfId, otherId, content, timestamp);
                    $('#messageContent').val('').focus();
                    // 在页面显示内容
                    var message = {
                        UserId: selfId,
                        Content: content,
                        AddTime: timestamp
                    }
                    addMessageToPage(message);
                })
            })
        })

        // 添加消息到页面
        var timestampOrigin = 0;    // 显示时间的时间戳原点
        var timestampSpan = 500;    // 显示时间的时间戳跨度
        var sentTemplate = Template7.compile($$('#sentMessage').html());
        var receivedTemplate = Template7.compile($$('#receivedMessage').html());
        function addMessageToPage(message) {
            // 添加消息时间
            if (message.AddTime - timestampOrigin > timestampSpan) {
                var title = $$('<div class="messages-title"></div>');
                title.html(transformTimestampToString(message.AddTime))
                $$('#messageList').append(title);
                timestampOrigin = message.AddTime;
            }
            // 添加消息内容
            if (message.UserId == selfId) {
                // 本人消息
                $$('#messageList').append(sentTemplate(message));
            }
            else if (message.UserId == otherId) {
                // 对方消息
                $$('#messageList').append(receivedTemplate(message));
            }
        }
        function transformTimestampToString(timestamp) {
            var date = new Date(timestamp * 1000);
            return (date.getMonth() + 1) + '-' +
                (date.getDate()) + ' ' +
                (date.getHours()) + ':' +
                (date.getMinutes());
        }
    </script>
</asp:Content>

 

 

posted @ 2021-12-22 20:09  顾屿南歌  阅读(134)  评论(0编辑  收藏  举报