准备工作
在开始之前,我们需要确保已经安装了 Golang 和 gorilla/websocket
包。可以通过以下命令来安装 gorilla/websocket
包:
go get github.com/gorilla/websocket
创建 WebSocket 连接
首先,我们需要设置一个 HTTP 服务器,以便客户端可以通过 HTTP 请求来建立 WebSocket 连接。以下是一个简单的示例:
package main
import (
"fmt"
"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(err)
return
}
// 在此处处理 WebSocket 连接
}
上面的代码创建了一个简单的 HTTP 服务器,并通过 /ws
路径处理 WebSocket 连接。在 handleWebSocket
函数中,我们使用 upgrader.Upgrade
方法来升级 HTTP 连接为 WebSocket 连接。
消息传递
一旦建立了 WebSocket 连接,我们就可以开始进行消息的传递。WebSocket 提供了 conn.ReadMessage
和 conn.WriteMessage
方法,用于从连接中读取和写入消息。以下是一个简单的示例:
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
for {
// 读取消息
\_, message, err := conn.ReadMessage()
if err != nil {
log.Println(err)
break
}
// 处理消息
fmt.Println("Received message: ", string(message))
// 发送消息
err = conn.WriteMessage(websocket.TextMessage, []byte("Hello from server"))
if err != nil {
log.Println(err)
break
}
}
}
在上面的示例中,我们使用一个无限循环来读取消息和发送消息。conn.ReadMessage
方法用于读取客户端发送的消息,conn.WriteMessage
方法用于向客户端发送消息。在实际应用中,我们可以根据业务需求来处理接收到的消息,并发送相应的响应。
关闭连接
当我们完成了与客户端的通信后,需要正确地关闭 WebSocket 连接。为此,我们可以使用 conn.Close
方法关闭连接。以下是一个示例:
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
defer conn.Close()
// 处理连接
}
在上面的示例中,我们使用 defer
关键字来确保在函数返回之前关闭连接。这样可以确保无论何时退出 handleWebSocket
函数,连接都会被正确地关闭。
单独会话管理
有时,我们可能需要为每个连接创建单独的会话,以便跟踪和管理每个用户的状态。可以通过将连接和会话关联起来来实现这一点。以下是一个示例:
type Session struct {
Conn \*websocket.Conn
IsAlive bool
}
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
session := &Session{
Conn: conn,
IsAlive: true,
}
defer session.Conn.Close()
// 处理连接和会话
}
在上面的示例中,我们定义了一个名为 Session
的结构体,其中包含一个 websocket.Conn
类型的连接和一个 bool
类型的 IsAlive
字段。在 handleWebSocket
函数中,我们为每个连接创建一个单独的会话,并将连接和会话关联起来。
为了管理会话,我们可以使用一个单独的管理器,它可以存储和跟踪所有会话。以下是一个简单的示例:
type SessionManager struct {
sessions map[string]\*Session
lock sync.RWMutex
}
func (sm \*SessionManager) AddSession(id string, session \*Session) {
sm.lock.Lock()
defer sm.lock.Unlock()
sm.sessions[id] = session
}
func (sm \*SessionManager) RemoveSession(id string) {
sm.lock.Lock()
defer sm.lock.Unlock()
delete(sm.sessions, id)
}
func (sm \*SessionManager) GetSession(id string) \*Session {
sm.lock.RLock()
defer sm.lock.RUnlock()
return sm.sessions[id]
}
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
session := &Session{
Conn: conn,
IsAlive: true,
}
// 将连接和会话关联起来
sessionManager.AddSession(sessionID, session)
defer func() {
// 从会话管理器中移除会话
sessionManager.RemoveSession(sessionID)
// 关闭连接
session.Conn.Close()
}()
// 处理连接和会话
}
在上面的示例中,我们定义了一个名为 SessionManager
的结构体,其中包含一个 map
类型的 sessions
字段。SessionManager
结构体还包含了 AddSession
、RemoveSession
和 GetSession
等方法,用于添加、移除和获取会话。在 handleWebSocket
函数中,我们将会话添加到会话管理器中,并在函数返回之前从会话管理器中移除它。
通过会话管理器,我们可以轻松地跟踪和管理每个连接的会话,并根据业务需求对其进行进一步处理。
案例
案例1: 实时聊天应用
我们可以使用 WebSocket 创建一个实时聊天应用,允许用户之间进行实时的文本交流。以下是一个简单的示例:
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
session := &Session{
Conn: conn,
IsAlive: true,
}
// 将连接和会话关联起来
sessionManager.AddSession(sessionID, session)
defer func() {
// 从会话管理器中移除会话
sessionManager.RemoveSession(sessionID)
// 关闭连接
session.Conn.Close()
}()
for {
// 读取消息
\_, message, err := conn.ReadMessage()
if err != nil {
log.Println(err)
break
}
// 处理消息
fmt.Println("Received message: ", string(message))
// 广播消息给所有连接
sessionManager.BroadcastMessage([]byte("User says: " + string(message)))
}
}
在上面的示例中,我们使用了之前提到的会话管理器,将每个连接和会话关联起来。当一个连接接收到消息时,它会将消息广播给所有连接,以实现实时聊天的效果。
案例2: 实时数据更新
我们可以使用 WebSocket 在浏览器中实时更新数据,以便用户可以立即看到最新的信息。以下是一个简单的示例:
func handleWebSocket(w http.ResponseWriter, r \*http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println(err)
return
}
session := &Session{
Conn: conn,
IsAlive: true,
}
// 将连接和会话关联起来
sessionManager.AddSession(sessionID, session)
defer func() {
// 从会话管理器中移除会话
sessionManager.RemoveSession(sessionID)
// 关闭连接
session.Conn.Close()
}()
for {
// 模拟获取最新数据
data := fetchData()
// 发送最新数据给连接
err := conn.WriteJSON(data)
if err != nil {
log.Println(err)
break
}
// 等待一段时间后继续发送最新数据
time.Sleep(time.Second \* 5)