YoyoGo 项目安装与使用教程

YoyoGo 项目安装与使用教程

1. 项目目录结构及介绍

YoyoGo 项目的目录结构如下：

yoyogo/
├── cmd/
│   └── yoyogo/
│       └── main.go
├── internal/
│   ├── config/
│   ├── middleware/
│   ├── router/
│   └── service/
├── pkg/
│   ├── abstractions/
│   ├── utils/
│   └── ...
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
└── README.md

目录结构介绍

• cmd/: 存放项目的启动文件，通常包含 main.go。
• internal/: 存放项目的内部逻辑代码，包括配置、中间件、路由和服务的实现。
  • config/: 配置文件和配置相关的代码。
  • middleware/: 中间件的实现。
  • router/: 路由的定义和处理。
  • service/: 业务逻辑服务的实现。
• pkg/: 存放项目的公共库和工具类。
  • abstractions/: 抽象接口和基础类。
  • utils/: 工具类和辅助函数。
• .gitignore: Git 忽略文件配置。
• go.mod: Go 模块依赖管理文件。
• go.sum: Go 模块依赖的校验文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。

2. 项目启动文件介绍

项目的启动文件位于 cmd/yoyogo/main.go。该文件是整个项目的入口，负责初始化配置、加载中间件、注册路由和启动服务。

package main

import (
    "github.com/yoyofx/yoyogo/internal/config"
    "github.com/yoyofx/yoyogo/internal/middleware"
    "github.com/yoyofx/yoyogo/internal/router"
    "github.com/yoyofx/yoyogo/internal/service"
)

func main() {
    // 初始化配置
    config.Init()

    // 加载中间件
    middleware.Load()

    // 注册路由
    router.Register()

    // 启动服务
    service.Start()
}

启动文件功能介绍

• config.Init(): 初始化项目的配置，包括从配置文件或环境变量中读取配置。
• middleware.Load(): 加载并注册中间件，如日志、认证、限流等。
• router.Register(): 注册路由，定义 URL 路径与处理函数的映射关系。
• service.Start(): 启动服务，监听端口并处理请求。

3. 项目配置文件介绍

YoyoGo 项目的配置文件通常位于 internal/config/ 目录下，常见的配置文件格式为 YAML 或 JSON。配置文件用于定义项目的各种参数，如数据库连接、服务端口、日志级别等。

示例配置文件 (config.yaml)

server:
  port: 8080
  mode: "debug"

database:
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  name: "yoyogo"

log:
  level: "info"
  output: "stdout"

配置文件字段介绍

• server: 服务配置
  • port: 服务监听的端口。
  • mode: 服务运行模式，如 debug 或 release。
• database: 数据库配置
  • host: 数据库主机地址。
  • port: 数据库端口。
  • username: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• log: 日志配置
  • level: 日志级别，如 info, debug, error。
  • output: 日志输出方式，如 stdout 或文件路径。

通过以上配置文件，YoyoGo 项目可以灵活地调整运行时的各种参数，以适应不同的环境和需求。