Crabby 项目教程

1. 项目目录结构及介绍

Crabby 项目的目录结构如下：

crabby/
├── cmd/
│   └── crabby/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── handlers/
│   │   └── handler.go
│   ├── models/
│   │   └── model.go
│   └── utils/
│       └── util.go
├── pkg/
│   └── somepackage/
│       └── somepackage.go
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的入口文件，通常是 main.go 文件所在的位置。
• config/: 存放项目的配置文件，如 config.yaml。
• internal/: 包含项目的内部逻辑代码，通常分为 handlers、models 和 utils 等子目录。
  • handlers/: 处理请求的逻辑代码。
  • models/: 定义数据模型的代码。
  • utils/: 包含一些通用的工具函数。
• pkg/: 存放项目的公共包，可以被其他项目引用。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

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

main.go 文件内容概览

package main

import (
    "crabby/config"
    "crabby/internal/handlers"
    "log"
    "net/http"
)

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

    // 初始化路由
    router := handlers.NewRouter(cfg)

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

启动文件功能介绍

• 加载配置: 通过 config.LoadConfig 函数加载配置文件 config/config.yaml。
• 初始化路由: 使用 handlers.NewRouter 函数初始化 HTTP 路由。
• 启动服务: 使用 http.ListenAndServe 启动 HTTP 服务，监听端口 8080。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。该文件包含了项目的各种配置参数，如数据库连接信息、服务端口等。

config.yaml 文件内容示例

server:
  port: 8080

database:
  host: "localhost"
  port: 5432
  user: "user"
  password: "password"
  name: "dbname"

logging:
  level: "info"

配置文件参数介绍

• server: 服务配置
  • port: 服务监听的端口，默认为 8080。
• database: 数据库配置
  • host: 数据库主机地址，默认为 localhost。
  • port: 数据库端口，默认为 5432。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• logging: 日志配置
  • level: 日志级别，默认为 info。

通过以上配置文件，可以灵活地调整项目的运行参数，满足不同的部署需求。