一步一步学习SignalR进行实时通信_5_Hub

一步一步学习SignalR进行实时通信\_5_Hub

SignalR

一步一步学习SignalR进行实时通信_5_Hub

前言

上一讲,我们简单的介绍了下Hub的配置以及实现方法,这一将我希望把更多的细节梳理清楚,不至于让大家在细节上面摸不着头脑,理解深了,那么做项目自然就会相对轻松一些。

Hub命名规则

Hub与PersistentConnection很大的区别就是我们可以自己定义我们自己的方法,取我们想取得名字。

Hub的前台调用后台方法的命名规则遵循骆驼命名法,如果不遵循该约定,那么在程序中很有可能报错,在.net中约定大于配置已经是被人们普遍接受的了,它的好处是免去了大量的配置文件,而用一个公用的约定来完成,每个人只要遵循这个约定就不会出篓子。

比如在后台有这么一个方法


public void SendMessageByUserName(string userName)
{
    ...
}

那么在前台通过hub.server.sendMessageByUserName("name")调用

如果后台方法改为


public void sendMessageByUserName(string userName)
{
    ...
}

在前台则用hub.server.sendmessageByUserName("name")调用以此类推

在后台调用前台方法则无此约定,不区分大小写。因此假设后台你通过Clients.Caller.testHtmlClient();调用前台的方法前台你可以写为hub.client.testHtmlClient(),也可以写为hub.client.testhtmlclient()甚至可以写为hub.client.teStHtMlClIENT()

Hub封装好的常用方法

假如我希望给指定姓名的人发送信息,Hub可以通过唯一的ConnectionId号发送给指定客户端,但是我们一般都是根据数据库中保存用户名或者数据库每条记录的Id进行数据操作。我们希望根据用户名来发送,那么我假设有一个字典保存了ConnectionId和UserName的对应关系


public class MySecondHub : Hub
{
    private IDictionary<string, string> _userNames;
    public MySecondHub()
    {
        //TODO:初始化UserNames
    }
    public void SendMessageByUserName(string userName)
    {
        //取到所有名字为那么的用户
        IList<string> users = _userNames.Where(u => u.Value == userName).Select(u => u.Key).ToList();
        Clients.Clients(users).sendMessage("Hi!");
    } 
}

那么在html页面我们可以通过 hub.server.sendMessageByUserName()调用


    <script type="text/javascript">
        $(function () {
            //创建一个hub服务
            var hub = $.connection.myFirstHub;
            $.connection.hub.start()
                .done(function () {
                    alert("连接成功!");
                })
            $("#sayHello").click(function () {
                hub.server.sendMessageByUserName("Jake");
            });
            hub.client.sendMessageByUserName = function(){
                ...
            };
        });
    </script>

我们也可以修改前台调用方法的名字


...
//在前台可以通过sendMessageToGroup()调用
[HubMethodName("SendMessageToGroup")]
public void SendMessageByGroupName(string groupName)
{
    Clients.Group(groupName);
}

这样在客户端我们就可以通过sendMessageToGroup()调用SendMessageByGroupName()方法了。

同时,我们传递的参数但可以是字符串也可以是复杂的类型,如:


public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}


public void SayHi(string name,string message)
{
    var person = new Person(){Name = name,Message = message};
    Clients.Others.sayHi(person);
}

前台代码,点击id为sayHello的按钮触发


...
$("#sayHello").click(function () {
    hub.server.sayHi("jake","hah~");
});
hub.client.sayHi = function(person) {
    $('#chat').append('<li><strong>' + person.Message + '</strong>:' + person.Name + '</li>');
};
...

之前我们讲到Client.Others.doSomething();可以调用给报包括自己的所有其他客户端doSomething()方法,Hub还有许多其他的方法供我们调用

一步一步学习SignalR进行实时通信_5_Hub

Hub常用方法解释

Clients.Caller：可以与调用者进行通信
Clients.Others：可以与除了自己以外所有连接上此Hub的客户端的通信
Clients.All：可以与所有连接上此Hub的客户端通信
Clients.OthersInGroup：可以与指定组以外的其他连接到Hub的客户端通信
Clients.Client：可以与给指定ConnectionId的客户端进行通信
Clients.AllExcept：可以与所有连接上此Hub但是除去指定ConnectionId以外的客户端通信
Clients.Group：可以与在指定组的客户端通信
Clients.User:可以与指定的userId进行通信

当然他们还有一些重载方法,这里就不一一介绍了,自己去试验下就能明白了。

PS:这里补充一个小知识,在MVC中已经实现了获取默认的UserId方法


public class PrincipalUserIdProvider : IUserIdProvider
{
    public string GetUserId(IRequest request) 
    {
        if (request == null) 
            throw new ArgumentNullException("request");
        if (request.User != null && request.User.Identity != null) 
            return request.User.Identity.Name; 
        else return (string) null; 
    }
}

很多时候我们可能需要自己实现自己的方法,比如userId为登陆的userName,那么我们可以实现IUserIdProvider接口


public class CookiesUserIdProvider : IUserIdProvider 
{
    public string GetUserId(IRequest request) 
    {
        if (request == null) 
            throw new ArgumentNullException("request");
        Cookie cookie; 
        if (request.Cookies.TryGetValue("UserName", out cookie)) 
        {
            return cookie.Value; 
        }
        else
        {
            return null; 
        }    
    }
}

当然我们还要告诉我们的项目使用我们自定义的提供器,而不是默认的,我们只需要在程序一开始,也就是Global中注册代码保证程序启动时调用即可。



    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            ...
            //注册我们自己的Id提供器
            GlobalHost.DependencyResolver.Register(typeof (IUserIdProvider), () => new CookiesUserIdProvider());
        }
    }
}

保持状态

在hub中可以通过hub.state保存用户的状态

一步一步学习SignalR进行实时通信_5_Hub

后台通过Client.Caller 获取前台传递来的参数运行项目断点,可以看到接收到的数据

参数名可以任意写,它是dynamic类型

前后台交互

难道保存状态只有这个用处吗?当然不止,这个状态还可以在某些情况下起到前后台交互的作用。

后台我们让Age++

一步一步学习SignalR进行实时通信_5_Hub

然后前台在回调方法中我们在控制台中打印age,如果打印的是24,那么证明前后台数据能进行很好的交互而不仅仅是保存一个状态那么简单。

点击按钮后通过firebug在控制台中可以看到打印出的是24

一步一步学习SignalR进行实时通信_5_Hub