Eagle开源项目教程

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

eagle/
├── cmd/                    # 命令行工具目录
│   └── eagle/              # 主命令行工具
├── config/                 # 配置文件目录
│   └── config.yaml         # 主配置文件
├── internal/               # 内部包目录
│   ├── api/                # API相关代码
│   ├── db/                 # 数据库相关代码
│   ├── logger/             # 日志相关代码
│   └── service/            # 业务逻辑代码
├── pkg/                    # 外部包目录
│   ├── util/               # 工具类代码
│   └── validator/          # 验证器代码
├── README.md               # 项目说明文档
├── go.mod                  # Go模块文件
└── main.go                 # 项目入口文件

目录结构详细说明

• cmd/: 包含项目的命令行工具代码，eagle子目录下是主命令行工具的实现。
• config/: 包含项目的配置文件，config.yaml是主配置文件。
• internal/: 包含项目的内部包，这些包不对外暴露。
  • api/: 包含API相关的代码，如路由定义、请求处理等。
  • db/: 包含数据库相关的代码，如数据库连接、模型定义等。
  • logger/: 包含日志相关的代码，如日志配置、日志记录等。
  • service/: 包含业务逻辑相关的代码。
• pkg/: 包含项目的对外包，这些包可以被其他项目引用。
  • util/: 包含一些通用的工具类代码。
  • validator/: 包含数据验证相关的代码。
• README.md: 项目的基本说明文档。
• go.mod: Go模块文件，用于管理项目的依赖。
• main.go: 项目的入口文件，包含了启动项目的main函数。

2. 项目的启动文件介绍

项目的启动文件是main.go，该文件位于项目的根目录下。以下是main.go的主要内容：

package main

import (
    "fmt"
    "log"
    "github.com/go-eagle/eagle/internal/app"
)

func main() {
    // 初始化应用
    if err := app.Init(); err != nil {
        log.Fatalf("应用初始化失败: %v", err)
    }

    // 启动应用
    if err := app.Run(); err != nil {
        log.Fatalf("应用启动失败: %v", err)
    }

    fmt.Println("Eagle应用已成功启动")
}

启动文件详细说明

• 导入包: 导入了fmt、log标准库以及github.com/go-eagle/eagle/internal/app包。
• main函数:
  • 初始化应用: 调用app.Init()函数进行应用的初始化，包括配置加载、数据库连接等。
  • 启动应用: 调用app.Run()函数启动应用，开始监听HTTP请求等。
  • 成功启动提示: 如果应用启动成功，打印启动成功的提示信息。

3. 项目的配置文件介绍

项目的配置文件是config.yaml，位于config/目录下。以下是config.yaml的主要内容：

server:
  addr: ":8080"  # 服务监听地址
  readTimeout: 10s  # 读取超时时间
  writeTimeout: 10s  # 写入超时时间

database:
  driver: "mysql"  # 数据库驱动
  dsn: "user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"  # 数据库连接字符串

logger:
  level: "info"  # 日志级别
  format: "json"  # 日志格式
  output: "stdout"  # 日志输出位置

配置文件详细说明

• server: 服务相关的配置
  • addr: 服务监听的地址和端口。
  • readTimeout: 请求读取的超时时间。
  • writeTimeout: 响应写入的超时时间。
• database: 数据库相关的配置
  • driver: 使用的数据库驱动，如mysql、postgres等。
  • dsn: 数据库连接字符串，包含了用户名、密码、地址、数据库名等信息。
• logger: 日志相关的配置
  • level: 日志级别，如info、warn、`error