GoEngine 开源项目使用教程

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

GoEngine 项目的目录结构如下：

goengine/
├── cmd/
│   └── goengine/
│       └── main.go
├── internal/
│   ├── domain/
│   ├── infrastructure/
│   └── application/
├── pkg/
│   ├── event/
│   ├── projection/
│   └── message/
├── config/
│   └── config.yaml
├── docs/
│   ├── quickstart.md
│   └── roadmap.md
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件。
  • goengine/: 主程序入口目录。
    • main.go: 项目的启动文件。
• internal/: 包含项目的内部逻辑代码。
  • domain/: 存放领域模型相关代码。
  • infrastructure/: 存放基础设施相关代码。
  • application/: 存放应用层相关代码。
• pkg/: 包含项目的公共包。
  • event/: 事件相关代码。
  • projection/: 投影相关代码。
  • message/: 消息相关代码。
• config/: 包含项目的配置文件。
  • config.yaml: 项目的配置文件。
• docs/: 包含项目的文档。
  • quickstart.md: 快速入门指南。
  • roadmap.md: 项目路线图。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块的校验文件。
• README.md: 项目介绍文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/goengine/main.go。该文件是 GoEngine 项目的入口点，负责初始化配置、加载依赖并启动应用程序。

main.go 文件内容概述

package main

import (
    "github.com/hellofresh/goengine/internal/application"
    "github.com/hellofresh/goengine/config"
)

func main() {
    // 加载配置文件
    config.LoadConfig()
    
    // 初始化应用
    app := application.NewApp()
    
    // 启动应用
    app.Run()
}

启动文件功能

• 加载配置文件: 通过 config.LoadConfig() 函数加载项目的配置文件。
• 初始化应用: 通过 application.NewApp() 函数初始化应用程序。
• 启动应用: 通过 app.Run() 函数启动应用程序。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目的各种配置参数，如数据库连接、日志级别等。

config.yaml 文件内容示例

database:
  host: "localhost"
  port: 5432
  user: "user"
  password: "password"
  name: "goengine"

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

server:
  port: 8080

配置文件参数说明

• database: 数据库配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• log: 日志配置。
  • level: 日志级别（如 info, debug 等）。
  • output: 日志输出方式（如 stdout, file 等）。
• server: 服务器配置。
  • port: 服务器监听端口。

通过以上配置文件，可以灵活地调整 GoEngine 项目的运行环境。