Golang 微服务 Demo 项目启动与配置教程

1. 项目目录结构及介绍

本项目是基于 Golang 开发的微服务 Demo，目录结构如下：

go-microservice-demo/
├── cmd/             # 项目启动命令和主要应用逻辑
├── deploy/          # 部署相关的配置文件和脚本
├── docs/            # 项目文档
├── pkg/             # 业务逻辑和工具包
├── .dockerignore    # Docker 构建时排除的文件
├── .gitignore       # Git 忽略的文件
├── Dockerfile       # Docker 镜像构建文件
├── LICENSE          # 项目许可证文件
├── Makefile         # 构建和部署的 Makefile 脚本
├── client.Dockerfile # 客户端 Docker 镜像构建文件
├── go.mod           # Go 依赖管理文件
├── go.sum           # Go 依赖校验文件
└── README.md        # 项目说明文件

• cmd/: 包含 main 函数和应用程序的主要入口点，通常每个服务会有一个对应的子目录。
• deploy/: 包含项目部署所需的配置文件、Docker Compose 文件或 Kubernetes 配置文件。
• docs/: 存放项目文档，如 API 文档、设计文档等。
• pkg/: 包含项目的主要逻辑和工具库，按照业务模块组织。
• .dockerignore: 列出不应该被包含在 Docker 镜像中的文件。
• .gitignore: 列出不应该被 Git 跟踪的文件。
• Dockerfile: 定义如何构建项目服务的 Docker 镜像。
• LICENSE: 项目所使用的许可证信息。
• Makefile: 提供了构建和部署项目的一系列命令。
• client.Dockerfile: 客户端服务的 Docker 镜像构建文件。
• go.mod 和 go.sum: Go 依赖管理的文件，用于管理和校验项目的依赖。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/<service>/main.go，其中 <service> 是服务的名称。以下是一个典型的启动文件结构：

package main

import (
    "log"
    "net/http"
    "go-microservice-demo/pkg/service"
)

func main() {
    // 初始化服务配置
    config := service.NewConfig()

    // 初始化服务
    svc := service.New(config)

    // 设置HTTP服务路由
    http.HandleFunc("/", svc.Handler)

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

该文件主要做了以下几件事：

• 导入必要的包。
• 创建服务配置。
• 初始化服务实例。
• 设置 HTTP 路由。
• 启动 HTTP 服务。

3. 项目的配置文件介绍

项目的配置文件通常位于 deploy/config.yaml，以下是一个配置文件的示例：

server:
  port: 8080
  timeout: 30s
database:
  driver: mysql
  source: user:password@tcp(localhost:3306)/dbname?parseTime=true
feature_flags:
  enable_feature_x: true
logging:
  level: info
  format: json

配置文件包含以下部分：

• server: 服务器配置，如端口和超时时间。
• database: 数据库配置，如数据库驱动、连接字符串等。
• feature_flags: 功能标志，用于开启或关闭特定功能。
• logging: 日志配置，如日志级别和格式。

确保在启动服务前正确配置这些文件，以便服务能够按预期运行。