Gobwas/ws 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00534/article/details/141411023

Gobwas/ws 开源项目教程

wsTiny WebSocket library for Go.项目地址:https://gitcode.com/gh_mirrors/ws2/ws

项目介绍

gobwas/ws 是一个用于 Go 语言的高性能 WebSocket 库。它提供了简洁的 API，旨在帮助开发者快速实现 WebSocket 服务器和客户端。该库的特点包括低内存占用、零拷贝升级以及对标准库的兼容性。

项目快速启动

安装

首先，确保你已经安装了 Go 语言环境。然后，通过以下命令安装 gobwas/ws 库：

go get github.com/gobwas/ws

示例代码

以下是一个简单的 WebSocket 服务器示例：

package main

import (
	"log"
	"net/http"

	"github.com/gobwas/ws"
	"github.com/gobwas/ws/wsutil"
)

func main() {
	http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
		conn, _, _, err := ws.UpgradeHTTP(r, w)
		if err != nil {
			log.Printf("Upgrade error: %s", err)
			return
		}

		go func() {
			defer conn.Close()

			for {
				msg, op, err := wsutil.ReadClientData(conn)
				if err != nil {
					log.Printf("Read error: %s", err)
					break
				}

				log.Printf("Received: %s", msg)

				err = wsutil.WriteServerMessage(conn, op, msg)
				if err != nil {
					log.Printf("Write error: %s", err)
					break
				}
			}
		}()
	})

	log.Println("Starting server on :8080")
	if err := http.ListenAndServe(":8080", nil); err != nil {
		log.Fatalf("Server error: %s", err)
	}
}

应用案例和最佳实践

应用案例

gobwas/ws 可以用于构建实时通信应用，如聊天室、实时数据展示和在线游戏等。以下是一个简单的聊天室示例：

package main

import (
	"log"
	"net/http"
	"sync"

	"github.com/gobwas/ws"
	"github.com/gobwas/ws/wsutil"
)

type ChatRoom struct {
	mu    sync.Mutex
	conns []ws.Conn
}

func (cr *ChatRoom) Add(conn ws.Conn) {
	cr.mu.Lock()
	defer cr.mu.Unlock()
	cr.conns = append(cr.conns, conn)
}

func (cr *ChatRoom) Broadcast(msg []byte, op ws.OpCode) {
	cr.mu.Lock()
	defer cr.mu.Unlock()
	for _, conn := range cr.conns {
		err := wsutil.WriteServerMessage(conn, op, msg)
		if err != nil {
			log.Printf("Write error: %s", err)
		}
	}
}

func main() {
	chatRoom := &ChatRoom{}

	http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
		conn, _, _, err := ws.UpgradeHTTP(r, w)
		if err != nil {
			log.Printf("Upgrade error: %s", err)
			return
		}

		chatRoom.Add(conn)

		go func() {
			defer conn.Close()

			for {
				msg, op, err := wsutil.ReadClientData(conn)
				if err != nil {
					log.Printf("Read error: %s", err)
					break
				}

				log.Printf("Received: %s", msg)
				chatRoom.Broadcast(msg, op)
			}
		}()
	})

	log.Println("Starting server on :8080")
	if err := http.ListenAndServe(":8080", nil); err != nil {
		log.Fatalf("Server error: %s", err)
	}
}