CellNet 开源项目教程

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

CellNet 是一个组件化、高扩展性、高性能的开源服务器网络库。以下是其主要目录结构及介绍：

cellnet/
├── codec/          # 编码器相关代码
├── example/        # 示例代码
├── proto/          # 协议定义
├── rpc/            # RPC 相关代码
├── socket/         # 套接字相关代码
├── util/           # 工具类代码
├── vendor/         # 第三方依赖
├── README.md       # 项目说明文档
├── LICENSE         # 许可证文件
└── main.go         # 项目启动文件

目录详细介绍

• codec/：包含各种编码器的实现，如 Google Protobuf、JSON 等。
• example/：提供多个示例代码，展示如何使用 CellNet 构建不同类型的服务器。
• proto/：存放协议定义文件，通常使用 Protobuf 格式。
• rpc/：实现 RPC 调用的相关代码。
• socket/：处理套接字连接和通信的代码。
• util/：包含一些工具类和辅助函数。
• vendor/：存放项目依赖的第三方库。
• README.md：项目的说明文档，包含基本介绍和使用指南。
• LICENSE：项目的许可证文件，说明使用和分发的条款。
• main.go：项目的启动文件，负责初始化和启动服务器。

2. 项目的启动文件介绍

CellNet 的启动文件是 main.go，它负责初始化和启动服务器。以下是 main.go 的主要内容：

package main

import (
    "github.com/davyxu/cellnet"
    "github.com/davyxu/cellnet/peer"
    "github.com/davyxu/cellnet/proc"
)

func main() {
    // 创建一个事件队列
    queue := cellnet.NewEventQueue()

    // 创建一个 TCP 侦听器
    p := peer.NewGenericPeer("tcp.Acceptor", "server", "127.0.0.1:8801", queue)

    // 绑定消息处理器
    proc.BindProcessorHandler(p, "tcp.ltv", func(ev cellnet.Event) {
        switch msg := ev.Message().(type) {
        case *cellnet.SessionAccepted:
            log.Debugln("server accepted")
        case *cellnet.SessionClosed:
            log.Debugln("session closed: ", ev.Session().ID())
        }
    })

    // 启动侦听器
    p.Start()

    // 开启事件队列
    queue.StartLoop()

    // 等待退出信号
    queue.Wait()
}

启动文件详细介绍

• cellnet.NewEventQueue()：创建一个事件队列，用于处理异步事件。
• peer.NewGenericPeer("tcp.Acceptor", "server", "127.0.0.1:8801", queue)：创建一个 TCP 侦听器，监听指定的地址和端口。
• proc.BindProcessorHandler(p, "tcp.ltv", func(ev cellnet.Event) {...})：绑定消息处理器，处理连接建立和关闭等事件。
• p.Start()：启动侦听器，开始接受客户端连接。
• queue.StartLoop()：开启事件队列，开始处理事件。
• queue.Wait()：等待退出信号，保持程序运行。

3. 项目的配置文件介绍

CellNet 的配置文件通常是一个 JSON 或 YAML 文件，用于配置服务器的各种参数。以下是一个示例配置文件 config.json：

{
    "server": {
        "address": "127.0.0.1:8801",
        "max_connections": 1000,
        "timeout": 30
    },
    "log": {
        "level": "debug",
        "output": "stdout"
    }
}

配置文件详细介绍

• server：服务器配置部分。
  • address：服务器监听的地址和端口。
  • `max_connections