Harmony 开源项目使用教程

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

Harmony 项目的目录结构如下：

harmony/
├── cmd/
│   └── harmony/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── handler/
│   ├── model/
│   └── service/
├── pkg/
│   ├── logger/
│   └── utils/
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件。
  • harmony/: 主程序目录。
    • main.go: 项目的入口文件。
• config/: 包含项目的配置文件。
  • config.yaml: 配置文件，用于存储项目的配置信息。
• internal/: 包含项目的内部逻辑。
  • handler/: 处理HTTP请求的逻辑。
  • model/: 数据模型定义。
  • service/: 业务逻辑层。
• pkg/: 包含可重用的包。
  • logger/: 日志处理包。
  • utils/: 工具函数包。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/harmony/main.go。该文件是整个项目的入口点，负责初始化配置、启动服务等操作。

main.go 文件内容概览

package main

import (
    "log"
    "harmony/config"
    "harmony/internal/handler"
    "harmony/internal/service"
    "harmony/pkg/logger"
)

func main() {
    // 初始化配置
    cfg, err := config.LoadConfig("config/config.yaml")
    if err != nil {
        log.Fatalf("Failed to load config: %v", err)
    }

    // 初始化日志
    logger.Init(cfg.Log)

    // 初始化服务
    svc := service.NewService(cfg)

    // 初始化处理程序
    h := handler.NewHandler(svc)

    // 启动HTTP服务器
    h.StartServer(cfg.Server.Port)
}

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目的各种配置信息，如服务器端口、日志级别等。

config.yaml 文件内容示例

server:
  port: 8080

log:
  level: info
  output: stdout

database:
  host: localhost
  port: 5432
  user: postgres
  password: postgres
  name: harmony

配置文件字段说明

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

以上是 Harmony 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！