Vulcain 项目教程

1. 项目目录结构及介绍

Vulcain 项目的目录结构如下：

vulcain/
├── cmd/
│   ├── vulcain/
│   │   └── main.go
├── internal/
│   ├── engine/
│   │   └── engine.go
│   ├── handler/
│   │   └── handler.go
│   ├── middleware/
│   │   └── middleware.go
│   ├── server/
│   │   └── server.go
├── pkg/
│   ├── config/
│   │   └── config.go
│   ├── logger/
│   │   └── logger.go
├── .env
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
└── README.md

目录结构介绍

• cmd/: 包含项目的入口文件，通常是 main.go 文件所在的位置。
• internal/: 包含项目的内部逻辑代码，通常不对外暴露。
  • engine/: 处理核心逻辑的代码。
  • handler/: 处理 HTTP 请求的代码。
  • middleware/: 包含中间件相关的代码。
  • server/: 包含服务器启动和配置的代码。
• pkg/: 包含项目的公共包，可以被其他项目引用。
  • config/: 处理配置文件的代码。
  • logger/: 处理日志记录的代码。
• .env: 项目的配置文件，通常包含环境变量。
• .gitignore: Git 忽略文件列表。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块依赖的校验文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。

2. 项目启动文件介绍

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

main.go 文件内容概述

package main

import (
    "log"
    "os"

    "github.com/dunglas/vulcain/internal/server"
    "github.com/dunglas/vulcain/pkg/config"
)

func main() {
    // 加载配置
    cfg := config.LoadConfig()

    // 初始化服务器
    srv := server.NewServer(cfg)

    // 启动服务器
    if err := srv.Start(); err != nil {
        log.Fatalf("Server failed to start: %v", err)
    }
}

启动文件功能

• 加载配置: 通过 config.LoadConfig() 加载项目的配置文件。
• 初始化服务器: 通过 server.NewServer(cfg) 初始化服务器实例。
• 启动服务器: 通过 srv.Start() 启动服务器，如果启动失败则记录错误并退出程序。

3. 项目配置文件介绍

项目的配置文件通常是 .env 文件，用于存储环境变量和配置信息。

.env 文件示例

# 服务器配置
SERVER_PORT=8080
SERVER_HOST=localhost

# 日志配置
LOG_LEVEL=info
LOG_FILE=vulcain.log

# 数据库配置
DB_HOST=localhost
DB_PORT=5432
DB_USER=vulcain
DB_PASSWORD=secret
DB_NAME=vulcain_db

配置文件内容介绍

• SERVER_PORT: 服务器监听的端口。
• SERVER_HOST: 服务器监听的主机地址。
• LOG_LEVEL: 日志记录的级别，如 info, debug, error 等。
• LOG_FILE: 日志文件的存储路径。
• DB_HOST: 数据库主机地址。
• DB_PORT: 数据库端口。
• DB_USER: 数据库用户名。
• DB_PASSWORD: 数据库密码。
• DB_NAME: 数据库名称。

通过这些配置，项目可以在不同的环境中灵活运行，并且可以根据需要进行调整。