Mayfly-Go 开源项目教程

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

Mayfly-Go 项目的目录结构如下：

mayfly-go/
├── api
│   ├── admin
│   ├── common
│   └── machine
├── cmd
│   └── mayfly
│       └── main.go
├── conf
│   └── app.yaml
├── internal
│   ├── app
│   ├── config
│   ├── constant
│   ├── controller
│   ├── dao
│   ├── entity
│   ├── form
│   ├── middleware
│   ├── model
│   ├── repository
│   ├── service
│   └── vo
├── pkg
│   ├── cache
│   ├── config
│   ├── cron
│   ├── db
│   ├── log
│   ├── middleware
│   ├── redis
│   ├── swagger
│   ├── template
│   ├── utils
│   └── websocket
├── scripts
└── web
    ├── public
    ├── src
    └── package.json

目录结构介绍

• api: 包含项目的API接口，分为admin、common和machine三个子目录。
• cmd: 包含项目的启动文件，其中main.go是主入口文件。
• conf: 包含项目的配置文件，如app.yaml。
• internal: 包含项目的内部逻辑，如应用配置、控制器、数据访问对象、实体、表单、中间件、模型、仓库、服务和视图对象等。
• pkg: 包含项目的公共包，如缓存、配置、定时任务、数据库、日志、中间件、Redis、Swagger、模板、工具和WebSocket等。
• scripts: 包含项目的脚本文件。
• web: 包含前端资源，如公共文件、源代码和包管理文件。

2. 项目的启动文件介绍

项目的启动文件位于cmd/mayfly/main.go。这个文件是整个项目的入口点，负责初始化配置、启动服务器等核心功能。

main.go 文件内容概览

package main

import (
    "mayfly-go/internal/app"
)

func main() {
    app.Run()
}

启动文件介绍

• main 函数: 项目的入口函数，调用app.Run()方法启动应用。
• app 包: 包含应用的核心逻辑，如初始化配置、启动服务器等。

3. 项目的配置文件介绍

项目的配置文件位于conf/app.yaml。这个文件包含了应用的各种配置项，如数据库连接、日志级别、端口等。

app.yaml 文件内容概览

app:
  name: mayfly-go
  version: 1.0.0
  port: 8080

database:
  driver: mysql
  host: localhost
  port: 3306
  username: root
  password: root
  name: mayfly

log:
  level: info
  path: ./logs

配置文件介绍

• app: 包含应用的基本信息，如名称、版本和端口。
• database: 包含数据库的连接信息，如驱动、主机、端口、用户名、密码和数据库名称。
• log: 包含日志的配置信息，如日志级别和日志路径。

以上是 Mayfly-Go 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。