websocket是一种协议，用于在web应用程序中建立实时、双向通信的通道。通过websocket可以实现server主动向client端推送消息，这个相较于传统的轮询和长轮询，可以显著的减少对应的网络流量和延迟。

这边我主要介绍的是如何在golang中建立这样的一个通道，以下是简单的demo

一、环境依赖

1、采用gin框架搭建一个简单的工程
2、下载github.com/gorilla/websocket依赖包

二、目录结构

目录结构如下

image.png

以下是每个文件对应的代码

服务端代码

1、main.go

package main

import (
    "github.com/gin-gonic/gin"
    "pay/app"
)

func main() {
    r := gin.Default() //创建gin
    app.RegistRoute(r) //绑定路由
    r.Run(":8001")     //运行绑定端口
}

2、route.go

package app

import (
    "github.com/gin-gonic/gin"
    "pay/app/controller"
)

func RegistRoute(engine *gin.Engine) {
    group := engine.Group("/index")
    {
        group.GET("/regist", controller.Index.Regist)
        group.GET("/index", controller.Index.Index)
    }
    engine.LoadHTMLGlob("templates/*")
}

3、index.go

package controller

import (
    "fmt"
    "github.com/gin-gonic/gin"
    "github.com/gorilla/websocket"
    "net"
    "net/http"
)

var Index = new(index)

type index struct {
}

var upGrader = websocket.Upgrader{
    CheckOrigin: func(r *http.Request) bool {
        return true
    },
}

func (i *index) Index(ctx *gin.Context) {
    ctx.HTML(http.StatusOK, "index.html", map[string]interface{}{
        "title": "首页",
    })
}

func (i *index) Regist(ctx *gin.Context) {
    conn, err := upGrader.Upgrade(ctx.Writer, ctx.Request, nil)
    if err != nil {
        fmt.Println("websocket error:", err)
        return
    }
    //得到客户的连接ip和端口
    fmt.Println("client connect:", conn.RemoteAddr())
    go i.Do(conn)

}

func (i *index) Do(conn *websocket.Conn) {
    for {

        //获取到前端发送过来的websocket消息
        contentType, message, err := conn.ReadMessage()
        if err != nil {
            //判断是不是超时
            if netErr, ok := err.(net.Error); ok {
                if netErr.Timeout() {
                    fmt.Printf("ReadMessage timeout remote:%v\n", conn.RemoteAddr())

                }
            }
            // 其他错误，如果是 1001 和  1000，就不打印日志
            if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseNormalClosure) {

            }

            conn.Close()
            //这边必须return，因为前端的链接可能某个时间段就断开链接了，要是没有return，会导致产生 repeated read on failed websocket connection报错,而且也可以防止内存泄露
            return
        }

        fmt.Println(contentType)
        fmt.Println(string(message))
        //写入ws
        msg := []byte("我是server")
        err = conn.WriteMessage(1, msg)
        if err != nil {
            fmt.Println("发生错误了")
            fmt.Println(err.Error())
        }
    }
}

前端代码

index.html

hello
<button onclick="sendMsg()">发送消息给服务端</button>
<script>
    var ws = new WebSocket("http://localhost:8001/index/regist")
    ws.onopen = function (event){
        console.log(event)
        console.log("打开成功")
    }
    ws.onmessage = function (event){
        console.log(event)
        console.log("接收到消息："+event.data)
    }
    ws.onclose = function (event){
        console.log(event)
        console.log("关闭")
    }
   function sendMsg(){
        ws.send("hello server,I am client")
    }

</script>

三、测试

浏览器访问http://localhost:8001/index/index
1、如下显示打开成功，代表前端和后端的websocket通信通道正式建立

image.png

image.png

image.png