golang使用socket-io

为了解决数据实时更新问题，常见的轮询会对服务端带来大量压力，导致资源浪费。

使用websocket可以代替http轮询，只有数据有变化的时候，服务端主动发送消息给客户端。

工作方式：

1. client和server通过3次握手建立TCP连接
2. client订阅server端指定事件
3. server端有数据变化，向指定的socket发送消息
4. client定期ping
5. 当有client断开连接时，server需要从监控中移除该socket

以下示例代码来源：https://gitee.com/zoujs/go-socketio

socket-io工作原理如下：

本文使用socket-io的golang包演示

依赖包："github.com/googollee/go-socket.io"

下载地址：GitHub - googollee/go-socket.io: socket.io library for golang, a realtime application framework.

可以参考代码里面的demo：go-socket.io/_examples at master · googollee/go-socket.io · GitHub

1、初始化一个server

server := socketio.NewServer(nil)

2、添加adapter

adapter(适配器)的作用是共享socket信息。简单解释就是多个实例间共享socket

    //redis 适配器
	ok, err := server.Adapter(&socketio.RedisAdapterOptions{
		Addr:    "127.0.0.1:6379",
		Prefix:  "socket.io",
		Network: "tcp",
	})
	if err != nil || !ok {
		log.Fatal("socket-io adapter error:", err)
	}

3、定义连接成功、失败、断开连接的事件

server.OnConnect("/", func(s socketio.Conn) error {
	fmt.Println("连接成功：", s.ID())
	return nil
})

server.OnError("/", func(s socketio.Conn, e error) {
	log.Println("连接错误:", e)
})

server.OnDisconnect("/", func(s socketio.Conn, reason string) {
	s.LeaveAll()
	log.Println("关闭连接：", reason)
})

4、如何向client发送数据

使用Emit函数

server.OnConnect("/", func(s socketio.Conn) error {
	s.Emit("message", gin.H{"status": 0, "data": data})
	return nil
})

5、如何传递参数

socket-io支持query参数传递，通过 s.URL().RawQuery获取

server.OnConnect("/", func(s socketio.Conn) error {
	fmt.Println("query参数：", s.URL().RawQuery)
	return nil
})

client端连接时通过url传递参数，如下：

io("ws://localhost:8000?sn=U12A343A0000AAA4&token=adswsdfsd");

6、每个socket连接支持设置Context，用来传递一些必要信息。

下面例子是连接建立时记录uid，断开连接时记录哪个用户断开连接

//建立连接，记录uid
server.OnConnect("/", func(s socketio.Conn) error {
	uid := ""
	s.SetContext(uid)
	return nil
})

//断开连接，从socket中获取uid
server.OnDisconnect("/", func(s socketio.Conn, reason string) {
	if uid := s.Context(); uid != nil {
		log.Println("someone leave ：", uid)
	}
	log.Println("关闭连接：", reason)
})

7、重点来了，socket-io支持namespace和room，可以把不同业务的socket服务加入到不同的namespace中，每个socket连接可以加入到一个或多个room中；同时支持向namespace或room广播消息。

加入room:

server.OnConnect("/", func(s socketio.Conn) error {
	// 加入一个房间
	s.Join("test")
	return nil
})

退出room:

s.Leave("test")  //退出指定room
s.LeaveAll()  //退出所有room

server端如何广播：

server.BroadcastToRoom("/", "test", "notice", "通知")

• 参数1：namespace
• 参数2：room名
• 参数3：事件名称
• 参数4：消息内容

client通过订阅事件来接收server端发送的消息内容：

var socket = io("*****")
socket.on('notice',function(data){
    console.log("receive server data",data);
})

反之client也使用emit向server端发送数据，server端同样订阅指定事件来接收消息

//client
var socket=io("***")
socket.emit("notice", "hello world")

//server
server := socketio.NewServer(nil)
server.OnEvent("/", "notice", func(s socketio.Conn, msg string) {
		
})

完整代码请前往：https://gitee.com/zoujs/go-socketio

下载后直接可运行