实现：websocket判断用户是否在线

实现：websocket判断用户是否在线

根据我们之前的介绍，websocket是HTML5中新增的一个协议， 该协议可以实现服务器与客户端之间全双工通信。 websocket在实时通信领域运用的比较多，比如社交聊天、弹幕、多玩家游戏、协同编辑、股票基金实时报价、体育实况更新、视频会议/聊天、基于位置的应用、在线教育、智能家居等需要高实时的场景。

在这些领域，我们大多需要通过websocket判断用户是否在线，好方便我们进行下一步的操作。

那么websocket如何判断用户是否在线，如何实时获取用户在线列表？

接下来就以GoEasy提供的websocket服务为例为大家讲解一下websocket判断用户是否在线是如何实现的。

一、初始化客户端在线状态

要监听一个的客户端在线状态，必须为该客户端指定userId，否则无法获取客户端在线状态。

    var goEasy = new GoEasy({
        host:'hangzhou.goeasy.io',//应用所在的区域地址: 【hangzhou.goeasy.io |singapore.goeasy.io】
        appkey: "my_appkey",
        userId: "用户唯一标识，如 user-001", //必须指定，否则无法实现客户端上下线监听功能
        userData: "用户的附加信息，比如性别，年龄" //更多的用户信息，其它已监听上下线信息的用户，收到该用户上线信息里会包含此部分内容
    });

二、监听客户端上下线状态变化

客户端上下线有四种actions：
online: 上线，客户端已经订阅了channel，因为网络的原因，断网重连
offline: 下线或断网，客户端已经订阅了 channel，手动关闭或网络断开
join: 订阅 channel， 客户端第一次订阅channel
leave: 取消 channel 的订阅，客户端主动取消某个 channel 的订阅

    goEasy.subscribePresence({
        channel: "my_channel",
        onPresence: function(presenceEvents){
            console.log("Presence events: ", JSON.stringify(presenceEvents));
        }        
    });

三、取消监听客户端上下线

    goEasy.unsubscribePresence({
        channel: "my_channel"
    });

四、客户端获取当前在线客户端列表

    goEasy.hereNow({
        channels: ["my_channel", "my_channel2"],
        includeUsers: true, //可选项，是否返回用户列表，默认false
        distinct: true //可选项，相同userId的客户端，列表中只保留一个，默认false
    },function(response) {
        alert("hereNow response: " + response);//json格式的response           
        /**
        response示例:
        {
           "code": 200,
           "content": {
              "channels": {
                 "channel_A": {      //channel
                    "channel": "channel_A",
                    "clientAmount": 2,    //在线客户端数量
                    "userAmount": 2,      //在线用户数量
                    "users": [    //在线用户id列表
                       {"id":"Jack","data":"18 years old"}, //在线用户
                       {"id":"Ted","data":""}                                    
                    ]
                 },
                 "channel_B": {       //channel
                    "channel": "channel_B",
                    "clientAmount": 1,     
                    "userAmount": 1,       
                    "users": [     
                       {"id":"Tom","data":"18 years old"}
                    ]
                 }
              }
           }
        }
        **/
    });

五、服务器端通过Rest API获取在线客户端列表

    Request: 
        URL: http(s)://<Rest Host>/herenow?appkey={appkey}&channel={channel}&includeUsers={includeUsers}&distinct={distinct}
        Method: GET
        参数：
        channel         //必须项，可以包含一个或多个channel
        includeUsers    //可选项，是否返回用户列表，默认false
        distinct        //可选项，相同userId的客户端，列表中只保留一个，默认false    

    Response JSON：
        //response示例    
        {
           "code": 200,
           "content": {
              "channels": {
                 "channel_A": {      //channel name
                    "channel": "channel_A",
                    "clientAmount": 3,    //在线客户端数量
                    "userAmount": 2,      //在线用户数量
                    "users": [    //在线用户id列表
                       {"id":"Jack2","data":"18 years old"}, //在线用户id
                       {"id":"Ted2","data":""}
                    ]
                 },
                 "channel_B": {       //channel name
                    "channel": "channel_B",
                    "clientAmount": 1,     //在线客户端数量
                    "userAmount": 1,       //在线用户数量
                    "users": [     //在线用户id列表
                       {"id":"Tom","data":"18 years old"}, //在线用户id 
                    ]
                 }
              }
           }
        }

以上便是通过GoEasy提供的websocket服务实现了判断用户是否在线的功能。

目前GoEasy提供完整的websocket前后端解决方案，简单的几行代码集成，即可快速搭建您的专属websocket服务。

另外GoEasy还支持更多的前端技术框架比如小程序、react、vue、uniapp等。同时还是支持php、java、python等服务端语言。 有websocket使用需求的开发者可以来注册GoEasy账号进行测试使用。【立即注册】

目前GoEasy提供了基于websocket的单聊、群聊Demo，在这些Demo中使用到了websocket用户上下线提醒等功能，结合Demo源码将更好的理解这些功能。Demo源码地址：
https://www.goeasy.io/cn/doc/best-practices/opensource-demos.html

Comments are closed.