当前位置：首页 > article >正文

Golang WebSocket 创建单独会话

article 2024/9/21 20:34:30

引言

在互联网应用程序中，实时通信是一种非常重要的功能。WebSocket 是一种基于 TCP 的协议，它允许客户端和服务器之间进行双向通信。Golang 是一种高性能的编程语言，它提供了对 WebSocket 的原生支持，使得在 Golang 中创建 WebSocket 会话变得非常简单。本文将介绍如何使用 Golang 创建单独的 WebSocket 会话，以实现实时通信功能。

WebSocket 简介

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议。它与传统的 HTTP 协议不同，HTTP 是一种无状态的协议，每个请求都需要建立一个新的连接。而 WebSocket 在客户端和服务器之间建立一条持久的连接，可以实现实时的双向通信。

WebSocket 协议的握手是通过 HTTP 请求完成的，握手后，客户端和服务器之间的连接将保持打开状态，可以发送和接收任意数据。WebSocket 使用一种类似于事件的机制，当有新消息到达时，服务器可以主动推送给客户端，而不需要客户端主动发送请求。

Golang 中的 WebSocket 支持

Golang 提供了 net/http 包来处理 HTTP 请求和响应，同时也提供了 gorilla/websocket 库来实现 WebSocket 协议的支持。gorilla/websocket 是一个非常流行的第三方库，它提供了对 WebSocket 协议的高级封装，使得在 Golang 中创建 WebSocket 会话变得更加简单。

在开始之前，我们首先需要安装 gorilla/websocket 库。可以使用以下命令来安装：

go get github.com/gorilla/websocket

安装完成后，我们就可以开始创建 WebSocket 会话了。

创建 WebSocket 服务器

首先，我们需要创建一个 WebSocket 服务器，用于接收来自客户端的连接请求，并处理 WebSocket 会话。以下是一个简单的 WebSocket 服务器示例：

package main

import (
    "log"
    "net/http"

    "github.com/gorilla/websocket"
)

// 创建一个 upgrader 对象，用于升级 HTTP 连接为 WebSocket 连接
var upgrader = websocket.Upgrader{
    ReadBufferSize:  1024,
    WriteBufferSize: 1024,
}

func main() {
    http.HandleFunc("/ws", handleWebSocket)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleWebSocket(w http.ResponseWriter, r *http.Request) {
    // 将 HTTP 连接升级为 WebSocket 连接
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println("Upgrade failed:", err)
        return
    }

    defer conn.Close()

    // 处理 WebSocket 会话
    for {
        // 读取客户端发送的消息
        messageType, message, err := conn.ReadMessage()
        if err != nil {
            log.Println("Read message failed:", err)
            break
        }

        // 处理客户端发送的消息
        log.Printf("Received message: %s", message)

        // 回复客户端消息
        err = conn.WriteMessage(messageType, message)
        if err != nil {
            log.Println("Write message failed:", err)
            break
        }
    }
}

在上面的示例中，我们首先创建了一个 upgrader 对象，它用于将 HTTP 连接升级为 WebSocket 连接。然后，我们定义了一个 handleWebSocket 函数，用于处理 WebSocket 会话。在该函数中，我们首先将 HTTP 连接升级为 WebSocket 连接，然后进入一个无限循环，不断读取客户端发送的消息，并给客户端回复相同的消息。

最后，我们使用 http.HandleFunc 函数将 /ws 路径映射到 handleWebSocket 函数，然后调用 http.ListenAndServe 函数来启动 WebSocket 服务器。

创建 WebSocket 客户端

接下来，我们需要创建一个 WebSocket 客户端，用于向服务器发送 WebSocket 请求，并处理服务器推送的消息。以下是一个简单的 WebSocket 客户端示例：

package main

import (
    "log"
    "os"
    "os/signal"
    "time"

    "github.com/gorilla/websocket"
)

func main() {
    // 创建一个 dialer 对象，用于建立 WebSocket 连接
    dialer := websocket.Dialer{
        HandshakeTimeout: 10 * time.Second,
    }

    // 建立 WebSocket 连接
    conn, _, err := dialer.Dial("ws://localhost:8080/ws", nil)
    if err != nil {
        log.Fatal("Dial failed:", err)
    }
    defer conn.Close()

    // 启动一个 goroutine 来接收服务器推送的消息
    go func() {
        for {
            _, message, err := conn.ReadMessage()
            if err != nil {
                log.Println("Read message failed:", err)
                break
            }

            log.Printf("Received message: %s", message)
        }
    }()

    // 向服务器发送消息
    message := []byte("Hello, WebSocket!")
    err = conn.WriteMessage(websocket.TextMessage, message)
    if err != nil {
        log.Println("Write message failed:", err)
        return
    }

    // 等待用户按下 Ctrl+C 终止程序
    interrupt := make(chan os.Signal, 1)
    signal.Notify(interrupt, os.Interrupt)
    <-interrupt
}

在上面的示例中，我们首先创建了一个 dialer 对象，它用于建立 WebSocket 连接。然后，我们使用 dialer.Dial 函数建立 WebSocket 连接，并指定服务器的地址为 ws://localhost:8080/ws。然后，我们使用 conn.WriteMessage 函数向服务器发送消息，并使用一个 goroutine 来接收服务器推送的消息。

最后，我们使用 signal.Notify 函数来注册一个信号监听器，当用户按下 Ctrl+C 时，程序会接收到一个中断信号，然后程序退出。

创建单独会话

在实际应用中，我们可能需要为每个客户端创建一个单独的会话，以便管理和跟踪客户端的状态。在 Golang 中，可以通过为每个 WebSocket 连接创建一个独立的 goroutine 来实现这一点。以下是一个示例：

package main

import (
    "log"
    "net/http"

    "github.com/gorilla/websocket"
)

var upgrader = websocket.Upgrader{
    ReadBufferSize:  1024,
    WriteBufferSize: 1024,
}

func main() {
    http.HandleFunc("/ws", handleWebSocket)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleWebSocket(w http.ResponseWriter, r *http.Request) {
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println("Upgrade failed:", err)
        return
    }

    defer conn.Close()

    // 创建一个独立的会话
    session := NewSession()

    // 处理会话
    session.Handle(conn)
}

type Session struct {
    conn *websocket.Conn
}

func NewSession() *Session {
    return &Session{}
}

func (s *Session) Handle(conn *websocket.Conn) {
    s.conn = conn

    go s.readLoop()
    go s.writeLoop()
}

func (s *Session) readLoop() {
    for {
        messageType, message, err := s.conn.ReadMessage()
        if err != nil {
            log.Println("Read message failed:", err)
            break
        }

        log.Printf("Received message: %s", message)
    }
}

func (s *Session) writeLoop() {
    for {
        select {
        // 从消息队列中获取消息并发送给客户端
        case message := <-s.messageQueue:
            err := s.conn.WriteMessage(websocket.TextMessage, message)
            if err != nil {
                log.Println("Write message failed:", err)
            }
        }
    }
}