microSocket 开源项目使用教程

microSocket 开源项目使用教程

microSocket同时支持socket和websocket的框架项目地址:https://gitcode.com/gh_mirrors/mi/microSocket

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

microSocket 项目的目录结构如下：

microSocket/
├── README.md
├── main.go
├── config/
│   └── config.yaml
├── socket/
│   ├── server.go
│   └── client.go
└── utils/
    └── helper.go

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• main.go: 项目的启动文件。
• config/: 配置文件目录，包含项目的配置文件 config.yaml。
• socket/: 包含服务器和客户端的实现文件。
  • server.go: 服务器端实现。
  • client.go: 客户端实现。
• utils/: 工具函数目录，包含一些辅助函数。
  • helper.go: 辅助函数文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，其主要功能是初始化配置并启动服务器。

main.go 代码示例

package main

import (
    "log"
    "net/http"
    "github.com/mistaker/microSocket/config"
    "github.com/mistaker/microSocket/socket"
)

func main() {
    // 加载配置文件
    config.LoadConfig()

    // 启动服务器
    server := socket.NewServer()
    log.Println("服务器已启动，监听端口:", config.GetConfig().Port)
    log.Fatal(http.ListenAndServe(":"+config.GetConfig().Port, server))
}

启动文件功能介绍

• 加载配置文件: 通过 config.LoadConfig() 加载配置文件 config/config.yaml。
• 启动服务器: 创建服务器实例并监听指定端口，通过 http.ListenAndServe 启动 HTTP 服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml，包含服务器的基本配置信息。

config.yaml 示例

port: "8080"
maxConnections: 1000

配置文件字段介绍

• port: 服务器监听的端口号。
• maxConnections: 服务器允许的最大连接数。

通过以上内容，您可以了解 microSocket 项目的目录结构、启动文件和配置文件的基本信息，从而更好地理解和使用该项目。

microSocket同时支持socket和websocket的框架项目地址:https://gitcode.com/gh_mirrors/mi/microSocket