HiLink 开源项目使用教程

HiLink 开源项目使用教程

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

hilink/
├── cmd/
│   └── hilink/
│       └── main.go
├── config/
│   └── config.yaml
├── docs/
│   └── README.md
├── internal/
│   ├── handler/
│   └── service/
├── pkg/
│   ├── api/
│   └── utils/
├── go.mod
├── go.sum
└── README.md

• cmd/: 包含应用程序的入口文件。
• config/: 包含项目的配置文件。
• docs/: 包含项目的文档文件。
• internal/: 包含内部包，通常用于处理业务逻辑。
• pkg/: 包含公共包，可以被其他项目引用。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/hilink/main.go。该文件主要负责初始化配置、启动服务等操作。以下是 main.go 的简要介绍：

package main

import (
    "hilink/config"
    "hilink/internal/handler"
    "hilink/internal/service"
    "log"
    "net/http"
)

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

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

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

    // 启动 HTTP 服务器
    log.Println("Starting server on :8080")
    log.Fatal(http.ListenAndServe(":8080", h))
}

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目运行所需的各种配置信息，例如数据库连接、日志级别等。以下是 config.yaml 的示例内容：

server:
  port: 8080

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

log:
  level: info

• server: 包含服务器相关的配置，如端口号。
• database: 包含数据库相关的配置，如主机、端口、用户名、密码和数据库名。
• log: 包含日志相关的配置，如日志级别。

以上是 HiLink 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。