Goldi 开源项目教程

Goldi 开源项目教程

goldiGoldi: lazy dependency injection framework for go.项目地址:https://gitcode.com/gh_mirrors/go/goldi

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

Goldi 项目的目录结构如下：

goldi/
├── cmd/
│   └── goldi/
│       └── main.go
├── configs/
│   └── config.yaml
├── internal/
│   ├── services/
│   └── types/
├── pkg/
│   ├── util/
│   └── config/
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含应用程序的入口点。goldi/ 目录下的 main.go 是项目的启动文件。
• configs/: 包含项目的配置文件，如 config.yaml。
• internal/: 包含项目的内部包，通常用于存放不对外公开的代码。services/ 和 types/ 目录分别存放服务和类型定义。
• pkg/: 包含项目的公共包，如工具类 util/ 和配置处理 config/。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/goldi/main.go。该文件是应用程序的入口点，负责初始化配置、依赖注入和服务启动。

package main

import (
    "log"
    "os"

    "github.com/fgrosse/goldi"
    "github.com/fgrosse/goldi/configs"
)

func main() {
    config, err := configs.LoadConfig("configs/config.yaml")
    if err != nil {
        log.Fatalf("Failed to load config: %v", err)
    }

    registry := goldi.NewTypeRegistry()
    registry.RegisterType("logger", goldi.NewStdoutLogger)

    container := goldi.NewContainer(registry, config)

    app := container.Get("app").(App)
    if err := app.Run(); err != nil {
        log.Fatalf("Application failed to run: %v", err)
    }
}

启动文件介绍

• 加载配置: 使用 configs.LoadConfig 函数从 configs/config.yaml 加载配置。
• 类型注册: 使用 goldi.NewTypeRegistry 创建类型注册表，并注册日志器。
• 容器创建: 使用 goldi.NewContainer 创建依赖注入容器，并将配置和注册表传递给它。
• 应用启动: 从容器中获取应用实例并运行。

3. 项目的配置文件介绍

项目的配置文件位于 configs/config.yaml。该文件包含了应用程序的配置信息，如数据库连接、日志级别等。

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

logging:
  level: "info"
  output: "stdout"

配置文件介绍

• database: 数据库配置，包括主机、端口、用户、密码和数据库名。
• logging: 日志配置，包括日志级别和输出目标。

通过以上介绍，您应该对 Goldi 项目的目录结构、启动文件和配置文件有了基本的了解。希望这份教程能帮助您更好地理解和使用该项目。

goldiGoldi: lazy dependency injection framework for go.项目地址:https://gitcode.com/gh_mirrors/go/goldi