gowebsocket 项目教程

gowebsocket 项目教程

gowebsocket golang基于websocket单台机器支持百万连接分布式聊天(IM)系统 项目地址: https://gitcode.com/gh_mirrors/go/gowebsocket

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

gowebsocket/
├── common/
│   └── ...
├── config/
│   └── ...
├── controllers/
│   └── ...
├── helper/
│   └── ...
├── img/
│   └── ...
├── lib/
│   └── ...
├── log/
│   └── ...
├── models/
│   └── ...
├── protobuf/
│   └── ...
├── routers/
│   └── ...
├── servers/
│   └── ...
├── views/
│   └── home/
│       └── ...
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum
├── main.go
└── 目录.md

目录结构介绍

• common/: 存放项目通用工具和函数。
• config/: 存放项目的配置文件和配置相关的代码。
• controllers/: 存放处理HTTP请求的控制器代码。
• helper/: 存放辅助函数和工具类。
• img/: 存放项目中使用的图片资源。
• lib/: 存放第三方库或自定义库。
• log/: 存放日志相关的代码和配置。
• models/: 存放数据模型和数据库相关的代码。
• protobuf/: 存放Protobuf协议文件。
• routers/: 存放路由配置和处理代码。
• servers/: 存放WebSocket服务器的实现代码。
• views/home/: 存放前端视图文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和编译的Makefile文件。
• README.md: 项目说明文档。
• go.mod: Go模块依赖管理文件。
• go.sum: Go模块依赖的校验文件。
• main.go: 项目的主入口文件。
• 目录.md: 项目的目录结构说明文档。

2、项目的启动文件介绍

main.go

main.go 是项目的启动文件，负责初始化并启动WebSocket服务器。以下是 main.go 的主要内容：

package main

import (
    "net/http"
    "github.com/link1st/gowebsocket/servers"
)

func main() {
    // 启动WebSocket服务器
    go servers.StartWebSocket()

    // 启动HTTP服务器
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello, WebSocket!"))
    })
    http.ListenAndServe(":8080", nil)
}

启动流程

1. 导入依赖: 导入项目所需的包和库。
2. 启动WebSocket服务器: 调用 servers.StartWebSocket() 启动WebSocket服务器。
3. 启动HTTP服务器: 启动一个简单的HTTP服务器，监听8080端口，返回 "Hello, WebSocket!"。

3、项目的配置文件介绍

config/config.go

config/config.go 文件负责加载和管理项目的配置。以下是 config.go 的主要内容：

package config

import (
    "os"
    "github.com/spf13/viper"
)

type Config struct {
    WebSocketPort string
    LogLevel      string
}

var Cfg *Config

func init() {
    viper.SetConfigName("config")
    viper.AddConfigPath(".")
    viper.SetConfigType("yaml")

    if err := viper.ReadInConfig(); err != nil {
        panic(err)
    }

    Cfg = &Config{
        WebSocketPort: viper.GetString("websocket.port"),
        LogLevel:      viper.GetString("log.level"),
    }
}

配置文件示例

websocket:
  port: "8089"
log:
  level: "info"

配置项说明

• WebSocketPort: WebSocket服务器的监听端口。
• LogLevel: 日志级别，控制日志输出的详细程度。

通过以上配置文件，项目可以根据不同的环境加载不同的配置，实现灵活的部署和管理。

gowebsocket golang基于websocket单台机器支持百万连接分布式聊天(IM)系统 项目地址: https://gitcode.com/gh_mirrors/go/gowebsocket