Golang Socket.IO 开源项目教程

Golang Socket.IO 开源项目教程

golang-socketiogolang socket.io client and server项目地址:https://gitcode.com/gh_mirrors/go/golang-socketio

1. 项目的目录结构及介绍

golang-socketio/
├── LICENSE
├── README.md
├── client.go
├── client_test.go
├── connection.go
├── connection_test.go
├── doc.go
├── example/
│   ├── chat/
│   │   ├── main.go
│   │   └── static/
│   │       ├── index.html
│   │       └── style.css
│   ├── echo/
│   │   └── main.go
│   └── namespace/
│       └── main.go
├── go.mod
├── go.sum
├── json.go
├── json_test.go
├── message.go
├── message_test.go
├── namespace.go
├── namespace_test.go
├── server.go
└── server_test.go

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• client.go: 客户端实现文件。
• client_test.go: 客户端测试文件。
• connection.go: 连接管理文件。
• connection_test.go: 连接管理测试文件。
• doc.go: 项目文档文件。
• example/: 示例代码目录。
  • chat/: 聊天示例。
  • echo/: 回显示例。
  • namespace/: 命名空间示例。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖校验文件。
• json.go: JSON 处理文件。
• json_test.go: JSON 处理测试文件。
• message.go: 消息处理文件。
• message_test.go: 消息处理测试文件。
• namespace.go: 命名空间处理文件。
• namespace_test.go: 命名空间处理测试文件。
• server.go: 服务器实现文件。
• server_test.go: 服务器测试文件。

2. 项目的启动文件介绍

项目的启动文件位于 example/ 目录下，每个示例都有自己的 main.go 文件。

示例启动文件

• example/chat/main.go: 聊天示例的启动文件。
• example/echo/main.go: 回显示例的启动文件。
• example/namespace/main.go: 命名空间示例的启动文件。

启动示例

以 chat 示例为例，启动文件 main.go 内容如下：

package main

import (
	"log"
	"net/http"

	"github.com/graarh/golang-socketio"
	"github.com/graarh/golang-socketio/transport"
)

type Message struct {
	Author string `json:"author"`
	Message string `json:"message"`
}

func main() {
	server := gosocketio.NewServer(transport.GetDefaultWebsocketTransport())

	server.On(gosocketio.OnConnection, func(c *gosocketio.Channel) {
		log.Println("New client connected")
		c.Join("chat")
	})

	server.On(gosocketio.OnDisconnection, func(c *gosocketio.Channel) {
		log.Println("Client disconnected")
	})

	server.On("message", func(c *gosocketio.Channel, msg Message) string {
		log.Println("Message from client: ", msg.Message)
		c.BroadcastTo("chat", "message", msg)
		return "OK"
	})

	serveMux := http.NewServeMux()
	serveMux.Handle("/socket.io/", server)
	serveMux.Handle("/", http.FileServer(http.Dir("./example/chat/static")))

	log.Println("Serving at localhost:8000...")
	log.Fatal(http.ListenAndServe(":8000", serveMux))
}

3. 项目的配置文件介绍

该项目没有显式的配置文件，所有配置均通过代码进行设置。例如，服务器端口和传输方式在 main.go 文件中进行配置：

server := gosocketio.NewServer(transport

golang-socketiogolang socket.io client and server项目地址:https://gitcode.com/gh_mirrors/go/golang-socketio