Go实现Websocket消息推送

1.websocket 简介

以往浏览器要获取服务端数据,都是通过发送 HTTP 请求,然后等待服务端回应的。也就是说浏览器端一直是整个请求的发起者,只有它主动,才能获取到数据。而要让浏览器一侧能够获取到服务端的实时数据,就需要不停地向服务端发起请求。虽然大多数情况下并没有获取到实际数据,但这大大增加了网络压力,对于服务端来说压力也直线上升。


image.png

由于 WebSocket 是全双工通信,所以当建立了 WebSocket 连接之后,接下来的通信就类似于传统的 TCP 通信了。客户端和服务端可以相互发送数据,不再有实时性的问题。


image.png
image.png

2.开发包的选择

在 Go 官方的 SDK 中,并不包含对 WebSocket 的支持,所以必须使用第三方库。
要使用 Golang 开发 WebSocket,选择基本就在 x/net/websocketgorilla/websocket 之间。《Go Web 编程》一书中的例子使用了 x/net/websocket 作为开发包,而且貌似它也更加官方且正式。而实际根据我在网上查询得到的反馈看来,并非如此。x/net/websocket 貌似 Bug 较多,且较为不稳定,问题解决也并不及时。相比之下,gorilla/websocket 则更加优秀。
下载链接及手册

3.推送服务实现

server 启动以后会注册两个 Handler。
websocketHandler 用于提供浏览器端发送 Upgrade 请求并升级为 WebSocket 连接。 pushHandler 用于提供外部推送端发送推送数据的请求。

3-1.go代码的简单实现
package main

import (
    "net/http"
    "log"
    "github.com/gorilla/websocket"
)

var (
    upgrader = websocket.Upgrader {
        // 读取存储空间大小
        ReadBufferSize:1024,
        // 写入存储空间大小
        WriteBufferSize:1024,
        // 允许跨域
        CheckOrigin: func(r *http.Request) bool {
            return true
        },
    }
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    var (
        wbsCon *websocket.Conn
        err error
        data []byte
    )
    // 完成http应答,在httpheader中放下如下参数
    if wbsCon, err = upgrader.Upgrade(w, r, nil);err != nil {
        return // 获取连接失败直接返回
    }

    for {
        // 只能发送Text, Binary 类型的数据,下划线意思是忽略这个变量.
        if _, data, err = wbsCon.ReadMessage();err != nil {
            goto ERR // 跳转到关闭连接
        }
        if err = wbsCon.WriteMessage(websocket.TextMessage, data); err != nil {
            goto ERR // 发送消息失败,关闭连接
        }
    }

    ERR:
        // 关闭连接
        wbsCon.Close()
}

func main()  {
    // 当有请求访问ws时,执行此回调方法
    http.HandleFunc("/ws",wsHandler)
    // 监听127.0.0.1:7777
    err := http.ListenAndServe("0.0.0.0:7777", nil)
    if err != nil {
        log.Fatal("ListenAndServe", err.Error())
    }
}
3-2.前端代码
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <style>
        *{
            margin:0px;
            padding:0px;
        }
    </style>
</head>

<body>
<div style="margin-left:400px">
    <h3>群聊天室</h3>
    <div style="border:1px solid;width: 600px;height: 300px;">
        <div id="msgArea" style="width:100%;height: 100%;text-align:start;resize: none;font-family: 微软雅黑;font-size: 20px;overflow-y: scroll"></div>
    </div>
    <div style="border:1px solid;width: 600px;height: 100px;">
        <div style="width:100%;height: 100%;">
            <textarea id="userMsg" style="width:100%;height: 100%;text-align:start;resize: none;font-family: 微软雅黑;font-size: 20px;"></textarea>
        </div>
    </div>
    <div style="border:1px solid;width: 600px;height: 25px;">
        <button style="float: right;" onclick="sendMsg()">发送</button>
    </div>
</div>
</body>

</html>
<script src="http://libs.baidu.com/jquery/2.1.4/jquery.min.js"></script>
<script>
    var ws;
    $(function(){
        link();
    })
    function link () {
        ws = new WebSocket("ws://127.0.0.1:7777/ws");//连接服务器
        ws.onopen = function(event){
            console.log(event);
            alert('连接了');
        };
        ws.onmessage = function (event) {
            var date = new Date();
            var msg = "<p>"+date.toLocaleString()+"</p>"+"<p>"+event.data+"</p>";
            $("#msgArea").append(msg);
        }
        ws.onclose = function(event){alert("已经与服务器断开连接\r\n当前连接状态:"+this.readyState);};
        ws.onerror = function(event){alert("WebSocket异常!");};
    }
    function sendMsg(){
        var msg = $("#userMsg").val();
        ws.send(msg);
    }
</script>
3-3. 结果分析

运行的结果


image.png

交互的过程
1.request请求时,要求将协议升级为websocket 参数
2.response返回时,如果成功则返回websocket 参数


image.png

数据传送形式是把数据拆成多个frame进行发送和接收,这个不用我们关心。


image.png

image.png

4.封装Websocket

image.png

image.png

image.png

image.png
1.目录结构
image.png
2.server.go
package main

import (
    "net/http"
    "log"
    "github.com/gorilla/websocket"
    "github.com/go-websocket/impl"
    "time"
)

var (
    upgrader = websocket.Upgrader {
        // 读取存储空间大小
        ReadBufferSize:1024,
        // 写入存储空间大小
        WriteBufferSize:1024,
        // 允许跨域
        CheckOrigin: func(r *http.Request) bool {
            return true
        },
    }
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    var (
        wsConn *websocket.Conn
        err error
        // data []byte
        conn *impl.Connection
        data []byte
    )
    // 完成http应答,在httpheader中放下如下参数
    if wsConn, err = upgrader.Upgrade(w, r, nil);err != nil {
        return // 获取连接失败直接返回
    }

    if conn, err = impl.InitConnection(wsConn); err != nil {
        goto ERR
    }

    go func() {
        var (
            err error
        )
        for {
            // 每隔一秒发送一次心跳
            if err = conn.WriteMessage([]byte("heartbeat")); err != nil {
                return
            }
            time.Sleep(1 * time.Second)
        }

    }()

    for {
        if data, err = conn.ReadMessage(); err != nil {
            goto ERR
        }
        if err = conn.WriteMessage(data); err != nil {
            goto ERR
        }
    }

    ERR:
        // 关闭当前连接

}

func main()  {
    // 当有请求访问ws时,执行此回调方法
    http.HandleFunc("/ws",wsHandler)
    // 监听127.0.0.1:7777
    err := http.ListenAndServe("0.0.0.0:7777", nil)
    if err != nil {
        log.Fatal("ListenAndServe", err.Error())
    }
}
3.connection.go
package impl

import (
    "github.com/gorilla/websocket"
    "sync"
    "errors"
)

type Connection struct {
    // 存放websocket连接
    wsConn *websocket.Conn
    // 用于存放数据
    inChan chan []byte
    // 用于读取数据
    outChan chan []byte
    closeChan chan byte
    mutex sync.Mutex
    // chan是否被关闭
    isClosed bool
}

// 读取Api
func (conn *Connection) ReadMessage() (data []byte, err error) {
    //select是Go中的一个控制结构,类似于用于通信的switch语句。每个case必须是一个通信操作,要么是发送要么是接收。 select随机执行一个可运行的case。如果没有case可运行,它将阻塞,直到有case可运行。一个默认的子句应该总是可运行的。
    select {
        case data = <- conn.inChan:
        case <- conn.closeChan:
            err = errors.New("connection is closed")
    }
    return
}

// 发送Api
func (conn *Connection) WriteMessage(data []byte) (err error)  {
    select {
        case conn.outChan <- data:
        case <- conn.closeChan:
            err = errors.New("connection is closed")
    }
    return
}

// 关闭连接的Api
func (conn *Connection) Close()  {
    // 线程安全的Close,可以并发多次调用也叫做可重入的Close
    conn.wsConn.Close()
    conn.mutex.Lock()
    if !conn.isClosed {
        // 关闭chan,但是chan只能关闭一次
        close(conn.closeChan)
        conn.isClosed = true
    }
    conn.mutex.Unlock()

}

// 初始化长连接
func InitConnection(wsConn *websocket.Conn) (conn *Connection, err error)  {
    conn = &Connection{
        wsConn: wsConn,
        inChan: make(chan []byte, 1000),
        outChan: make(chan []byte, 1000),
        closeChan: make(chan byte, 1),
    }

    // 启动读协程
    go conn.readLoop()

    // 启动写协程
    go conn.writeLoop()

    return
}

// 内部实现
func (conn *Connection) readLoop()  {
    var (
        data []byte
        err error
    )
    for {
        if _, data, err = conn.wsConn.ReadMessage(); err != nil {
            goto ERR
        }
        // 容易阻塞到这里,等待inChan有空闲的位置
        select {
            case conn.inChan <- data:
            case <- conn.closeChan: // closeChan关闭的时候执行
                goto ERR
        }
    }

    ERR:
        conn.Close()
}

func (conn *Connection) writeLoop()  {
    var (
        data []byte
        err error
    )
    for {
        select {
            case data = <- conn.outChan:
            case <- conn.closeChan:
                goto ERR
        }
        data = <- conn.outChan
        if err = conn.wsConn.WriteMessage(websocket.TextMessage, data); err != nil {
            goto ERR
        }
    }
    ERR:
        conn.Close()
}


5.第三方资源

https://www.imooc.com/video/17599
https://www.cnblogs.com/snowInPluto/p/8688453.html

6.PHP前沿学习群: 257948349 go也收

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容