Golang实现Go与JavaScript强大Socket通信的插件库Glue的使用

Glue简介

Glue是一个实时双向Socket通信库，是socket.io的一个简洁、健壮和高效的替代方案。这个库旨在以简单的方式连接Web浏览器和Go后端。

主要特性

• 自动检测支持的Socket层并选择最合适的
• 处理断开连接时的自动重连
• 服务器实现是线程安全和稳定的
• API是固定的，不会有破坏性的API变更

支持的Socket层

目前支持两种Socket层：

1. WebSockets - 主要选项，如果浏览器支持RFC 6455定义的WebSocket则使用
2. AjaxSockets - 作为回退模式使用

安装

客户端

客户端JavaScript Glue库位于client/dist/glue.js。

可以使用bower安装客户端库：

bower install --save glue-socket

服务器端

获取源代码并开始使用：

go get github.com/desertbit/glue

导入：

import "github.com/desertbit/glue"

完整示例

客户端示例

<script>
    // 创建并连接到服务器
    // 可选传递主机字符串和选项
    var socket = glue();

    socket.onMessage(function(data) {
        console.log("onMessage: " + data);

        // 将消息回显给服务器
        socket.send("echo: " + data);
    });

    socket.on("connected", function() {
        console.log("connected");
    });

    socket.on("connecting", function() {
        console.log("connecting");
    });

    socket.on("disconnected", function() {
        console.log("disconnected");
    });

    socket.on("reconnecting", function() {
        console.log("reconnecting");
    });

    socket.on("error", function(e, msg) {
        console.log("error: " + msg);
    });

    socket.on("connect_timeout", function() {
        console.log("connect_timeout");
    });

    socket.on("timeout", function() {
        console.log("timeout");
    });

    socket.on("discard_send_buffer", function() {
        console.log("some data could not be send and was discarded.");
    });
</script>

服务器端示例

import (
    "log"
    "net/http"

    "github.com/desertbit/glue"
)

func main() {
    // 创建一个新的glue服务器
    server := glue.NewServer(glue.Options{
        HTTPListenAddress: ":8080",
    })

    // 在defer时释放glue服务器
    // 这将阻止新的传入连接
    // 并关闭所有当前活动的socket
    defer server.Release()

    // 设置glue事件函数来处理新的传入socket连接
    server.OnNewSocket(onNewSocket)

    // 运行glue服务器
    err := server.Run()
    if err != nil {
        log.Fatalf("Glue Run: %v", err)
    }
}

func onNewSocket(s *glue.Socket) {
    // 设置一个函数，在socket关闭时触发
    s.OnClose(func() {
        log.Printf("socket closed with remote address: %s", s.RemoteAddr())
    })

    // 设置一个函数，在每个接收到的消息时触发
    s.OnRead(func(data string) {
        // 将接收到的数据回显给客户端
        s.Write(data)
    })

    // 向客户端发送欢迎字符串
    s.Write("Hello Client")
}

通道(Channels)使用

通道是从客户端到服务器的单个socket连接的独立通信通道。可以创建多个独立的通信通道：

服务器端

// 创建一个通道
c := s.Channel("golang")

// 设置通道的读取事件函数
c.OnRead(func(data string) {
    // ...
})

// 写入通道
c.Write("Hello Gophers!")

客户端

var c = socket.channel("golang");

c.onMessage(function(data) {
    console.log(data);
});

c.send("Hello World");

广播消息

使用Glue可以轻松地向多个客户端广播消息。Glue服务器跟踪所有活动的客户端会话。您可以使用服务器的Sockets、GetSocket或OnNewSocket方法来实现广播。

自定义选项

客户端选项

var host = "https://foo.bar";

var opts = {
    // 基础URL附加到主机字符串。此值必须与服务器值匹配
    baseURL: "/glue/",

    // 强制使用特定的socket类型
    // 值: false, "WebSocket", "AjaxSocket"
    forceSocketType: false,

    // 在超时后终止连接尝试
    connectTimeout:  10000,

    // 如果连接空闲，ping服务器检查连接是否仍然存活
    pingInterval:           35000,
    // 如果服务器在超时内没有响应pong，则重新连接
    pingReconnectTimeout:   5000,

    // 是否在连接丢失时自动重新连接
    reconnect:          true,
    reconnectDelay:     1000,
    reconnectDelayMax:  5000,
    // 设置为0表示禁用(无限重试)
    reconnectAttempts:  10,

    // 在超时后重置发送缓冲区
    resetSendBufferTimeout: 10000
};

// 创建并连接到服务器
// 可选传递主机字符串和选项
var socket = glue(host, opts);

服务器端自定义HTTP多路复用器

// 创建一个新的glue服务器而不配置和启动HTTP服务器
server := glue.NewServer(glue.Options{
    HTTPSocketType: HTTPSocketTypeNone,
})

注意事项

• 必须从socket和每个通道读取数据。如果您不需要从socket或通道读取数据，则使用DiscardRead()方法丢弃接收到的数据
• 如果接收到的数据没有被丢弃，则当读取缓冲区满时会被阻塞，这也会阻塞socket的keep-alive机制，结果会导致socket关闭