开源项目 Cyber 使用教程

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

Cyber 项目的目录结构如下：

cyber/
├── cmd/
│   ├── cyber/
│   │   └── main.go
├── config/
│   └── config.go
├── docs/
├── internal/
│   ├── app/
│   │   └── app.go
│   ├── server/
│   │   └── server.go
├── pkg/
│   ├── logger/
│   │   └── logger.go
│   ├── utils/
│   │   └── utils.go
├── go.mod
├── go.sum
└── README.md

目录介绍

• cmd/: 包含项目的入口文件。
  • cyber/: 主程序目录。
    • main.go: 项目的启动文件。
• config/: 包含项目的配置文件。
  • config.go: 配置文件的定义和加载。
• docs/: 包含项目的文档。
• internal/: 包含项目的内部逻辑。
  • app/: 应用逻辑。
    • app.go: 应用的主要逻辑。
  • server/: 服务器逻辑。
    • server.go: 服务器的启动和运行逻辑。
• pkg/: 包含项目的公共包。
  • logger/: 日志包。
    • logger.go: 日志的定义和使用。
  • utils/: 工具包。
    • utils.go: 工具函数的定义和使用。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖的校验文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/cyber/main.go。该文件主要负责初始化配置、启动服务器等操作。以下是 main.go 的主要内容：

package main

import (
    "cyber/config"
    "cyber/internal/app"
    "cyber/internal/server"
    "cyber/pkg/logger"
)

func main() {
    // 初始化配置
    cfg := config.LoadConfig()

    // 初始化日志
    logger.Init(cfg.Log)

    // 初始化应用
    app := app.NewApp(cfg)

    // 启动服务器
    server.Start(app)
}

启动文件功能

• 加载配置：通过 config.LoadConfig() 函数加载配置文件。
• 初始化日志：通过 logger.Init(cfg.Log) 初始化日志系统。
• 初始化应用：通过 app.NewApp(cfg) 初始化应用实例。
• 启动服务器：通过 server.Start(app) 启动服务器。

3. 项目的配置文件介绍

项目的配置文件定义在 config/config.go 中。该文件主要负责定义配置结构体和加载配置文件。以下是 config.go 的主要内容：

package config

import (
    "encoding/json"
    "os"
)

type Config struct {
    Server struct {
        Host string `json:"host"`
        Port int    `json:"port"`
    } `json:"server"`
    Log struct {
        Level string `json:"level"`
    } `json:"log"`
}

func LoadConfig() *Config {
    file, err := os.Open("config/config.json")
    if err != nil {
        panic(err)
    }
    defer file.Close()

    var cfg Config
    decoder := json.NewDecoder(file)
    err = decoder.Decode(&cfg)
    if err != nil {
        panic(err)
    }

    return &cfg
}

配置文件功能

• 定义配置结构体：Config 结构体包含服务器和日志的配置。
• 加载配置文件：通过 os.Open("config/config.json") 打开配置文件，并使用 json.NewDecoder 解析配置文件内容。

以上是 Cyber 项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你