Goex 开源项目使用教程

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

Goex 项目的目录结构如下：

goex/
├── README.md
├── go.mod
├── go.sum
├── cmd/
│   └── goex/
│       └── main.go
├── config/
│   └── config.go
├── pkg/
│   ├── api/
│   │   └── api.go
│   ├── exchange/
│   │   └── exchange.go
│   └── utils/
│       └── utils.go
└── test/
    └── test.go

目录结构介绍

• README.md: 项目说明文件。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• cmd/: 包含项目的启动文件。
• config/: 包含项目的配置文件。
• pkg/: 包含项目的核心功能代码，如 API 接口、平台接口和工具函数。
• test/: 包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/goex/main.go。该文件是整个项目的入口点，负责初始化配置和启动服务。

package main

import (
    "goex/config"
    "goex/pkg/api"
)

func main() {
    // 初始化配置
    config.Init()
    
    // 启动 API 服务
    api.Start()
}

启动文件介绍

• main.go: 项目的入口文件，负责初始化配置和启动 API 服务。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.go。该文件定义了项目的配置结构和初始化方法。

package config

import (
    "log"
    "os"
)

type Config struct {
    APIKey    string
    APISecret string
}

var Cfg Config

func Init() {
    Cfg.APIKey = os.Getenv("API_KEY")
    Cfg.APISecret = os.Getenv("API_SECRET")
    
    if Cfg.APIKey == "" || Cfg.APISecret == "" {
        log.Fatal("API key or secret not set")
    }
}

配置文件介绍

• config.go: 定义了项目的配置结构和初始化方法，从环境变量中读取 API Key 和 API Secret。

以上是 Goex 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！