REST Go 项目教程

1. 项目目录结构及介绍

REST Go 项目的目录结构如下：

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

目录结构介绍

• cmd/: 包含项目的启动文件 main.go。
• config/: 包含项目的配置文件 config.yaml。
• internal/: 包含项目的内部逻辑代码，通常分为 handler（处理HTTP请求）、model（数据模型）和 service（业务逻辑）。
• pkg/: 包含项目的公共库代码，如 logger（日志记录）和 utils（工具函数）。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

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

main.go 文件内容概览

package main

import (
    "rest-go/config"
    "rest-go/internal/handler"
    "rest-go/pkg/logger"
    "net/http"
)

func main() {
    // 初始化配置
    config.Init()

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

    // 注册HTTP处理函数
    http.HandleFunc("/", handler.HomeHandler)

    // 启动HTTP服务器
    http.ListenAndServe(":8080", nil)
}

主要功能

• 初始化配置: 调用 config.Init() 函数加载配置文件。
• 初始化日志: 调用 logger.Init() 函数初始化日志记录器。
• 注册HTTP处理函数: 使用 http.HandleFunc 注册处理HTTP请求的函数。
• 启动HTTP服务器: 使用 http.ListenAndServe 启动HTTP服务器，监听端口 8080。

3. 项目的配置文件介绍

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

config.yaml 文件内容示例

server:
  port: 8080

database:
  host: localhost
  port: 5432
  user: postgres
  password: secret
  name: mydb

logging:
  level: info

配置项说明

• server: 服务器配置，包括监听端口 port。
• database: 数据库配置，包括主机 host、端口 port、用户 user、密码 password 和数据库名称 name。
• logging: 日志配置，包括日志级别 level。

通过以上配置文件，项目可以在不同的环境中灵活配置，满足不同的需求。

---

以上是 REST Go 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你快速上手该项目。