使用Gin框架實現Websocket通訊功能

王林

發布： 2023-06-23 09:34:37

原創

2914 人瀏覽過

隨著網路的不斷發展，Web應用程式的需求也越來越多。隨之而來的是對即時通訊的需求，Websocket由此應運而生。 Gin是基於Golang的一個高效的Web框架，透過Gin框架可以輕鬆實現Websocket通訊功能。

本文將介紹如何使用Gin框架實作Websocket通訊功能。

安裝Gin框架

在開始使用Gin框架前，需要先安裝Gin框架。可以透過以下指令安裝：

go get -u github.com/gin-gonic/gin

登入後複製

建立一個Gin應用程式

在安裝完Gin框架後，我們可以開始建立一個Gin應用程式。建立一個app.go文件，按照以下程式碼實作：

package main

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

func main() {
    router := gin.Default()

    router.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })

    router.Run(":8080")
}

登入後複製

以上程式碼建立了一個Gin應用，監聽埠為8080，在瀏覽器中存取http:// localhost:8080/ping會回傳一個JSON回應。

使用Gin框架實作Websocket

接下來，我們將使用Gin框架實作Websocket通訊功能。我們將創建一個websocket.go文件，並按照以下步驟實現：

導入依賴

在開始之前，需要導入以下依賴：

import (
    "log"
    "net/http"

    "github.com/gorilla/websocket"
    "github.com/gin-gonic/gin"
)

登入後複製

這裡我們導入了Gin框架、Gorilla websocket庫以及Go標準庫中的log和net/http。

定義Gin路由

我們透過Gin框架定義一個Websocket路由：

router.GET("/ws", func(c *gin.Context) {
    wsHandler(c.Writer, c.Request)
})

登入後複製

定義Websocket處理函數

我們定義了一個wsHandler函數，用於處理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) {
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println(err)
        return
    }

    defer conn.Close()

    for {
        // 读取消息
        _, msg, err := conn.ReadMessage()
        if err != nil {
            log.Println(err)
            return
        }

        // 处理消息
        log.Printf("收到消息: %s
", msg)

        // 回复消息
        err = conn.WriteMessage(websocket.TextMessage, []byte("已收到消息！"))
        if err != nil {
            log.Println(err)
            return
        }
    }
}

登入後複製

以上函數透過呼叫websocket.Upgrader方法將HTTP連接升級為Websocket連接，並處理Websocket連接中的讀寫操作。在程式碼中，我們首先使用upgrader.Upgrade方法將HTTP連線升級為Websocket連線。接著，在一個無限循環中，使用conn.ReadMessage方法讀取客戶端的消息數據，將讀取到的消息打印輸出，然後使用conn.WriteMessage方法將一個回复訊息返回給客戶端。

Websocket的讀寫操作是一個阻塞的過程，因此需要在一個無限循環中進行。當客戶端中斷與Websocket的連線時，循環將會退出。

測試Websocket連線

編寫好以上程式碼後，我們可以透過以下步驟測試Websocket連線：

啟動Gin應用程式：go run app. go
在瀏覽器中開啟http://localhost:8080/ws頁面
#開啟瀏覽器的開發者工具，在控制台中執行以下程式碼：

var websocket = new WebSocket("ws://localhost:8080/ws");

websocket.onopen = function(evt) {
    console.log("连接成功！");
    websocket.send("Hello WebSocket！");
};

websocket.onmessage = function(evt) {
    console.log("收到消息：" + evt.data);
};

websocket.onclose = function(evt) {
    console.log("连接已关闭！");
};

登入後複製

以上程式碼中，我們使用了WebSocket API來建立與Websocket的連接，並發送了一則訊息。當與Websocket的連線成功建立時，控制台會輸出「連線成功！」；當接收到Websocket的回覆訊息時，控制台會輸出「收到訊息：已收到訊息！」；當連線關閉時，控制台會輸出「連線已關閉！」。