ERD-Go 项目启动与配置教程

1. 项目目录结构及介绍

ERD-Go 是一个开源项目，其目录结构如下：

erd-go/
├── cmd/
│   └── erd-go/         # 项目的主执行文件所在的目录
├── configs/            # 配置文件存放目录
├── docs/               # 项目文档存放目录
├── internal/           # 项目内部模块和库
│   ├── domain/         # 领域模型相关代码
│   ├── repository/     # 数据存储相关代码
│   ├── service/        # 业务逻辑相关代码
│   └── api/            # API 接口相关代码
├── pkg/                # 外部可以使用的库和模块
├── scripts/            # 项目构建和部署的脚本
├── test/               # 测试代码存放目录
├── go.mod              # go 模块定义文件
├── go.sum              # go 模块校验文件
└── README.md           # 项目说明文件

• cmd/erd-go/: 存放项目的入口文件和主函数，是项目的启动点。
• configs/: 存放项目的配置文件，如数据库连接信息、服务端口等。
• docs/: 存放项目的文档资料，便于用户和开发者查阅。
• internal/: 包含项目的核心业务逻辑，不允许外部引用。
  • domain/: 定义项目的业务模型和数据结构。
  • repository/: 定义数据访问层，负责数据的持久化操作。
  • service/: 包含项目的业务逻辑。
  • api/: 定义了项目提供的 API 接口。
• pkg/: 存放可以对外提供的库和模块。
• scripts/: 包含项目构建、测试和部署的脚本文件。
• test/: 存放项目的测试代码。
• go.mod: 定义了项目依赖的 go 模块。
• go.sum: 用于确保项目依赖的完整性。
• README.md: 项目的介绍和说明。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/erd-go/main.go。以下是启动文件的基本结构：

package main

import (
    "log"
    "net/http"
    "erd-go/internal/api"
)

func main() {
    // 初始化配置
    // 初始化数据库连接
    // 初始化服务

    // 设置路由
    router := api.SetupRouter()

    // 启动 HTTP 服务
    log.Fatal(http.ListenAndServe(":8080", router))
}

启动文件的主要功能是：

• 初始化配置和数据库连接。
• 设置路由，将 HTTP 请求映射到对应的处理函数。
• 启动 HTTP 服务，默认监听 8080 端口。

3. 项目的配置文件介绍

项目的配置文件通常存放在 configs/ 目录下，例如 app.conf。配置文件可能包含以下内容：

# app.conf

[server]
port = 8080

[database]
host = "localhost"
port = 3306
user = "root"
password = "password"
dbname = "erd_go"

配置文件中定义了服务端口和数据库连接信息。在实际的项目中，配置文件可以更加复杂，包含更多的配置项，例如日志级别、外部服务连接信息等。

在项目启动时，会加载这些配置文件，并根据配置文件中的信息初始化项目。通常情况下，会有一个专门的配置管理模块来读取和处理这些配置信息。