GoCRUD 项目教程

GoCRUD 项目教程

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

GoCRUD 项目的目录结构如下：

gocrud/
├── examples/
├── pkg/
├── .gitignore
├── .remarkrc
├── .remarkrc.license
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum
├── main.go
└── package.json

• examples/: 包含示例代码。
• pkg/: 包含项目的包文件。
• .gitignore: Git 忽略文件。
• .remarkrc 和 .remarkrc.license: 代码格式化配置文件。
• LICENSE: 项目许可证。
• Makefile: 用于构建项目的 Makefile。
• README.md: 项目说明文档。
• go.mod 和 go.sum: Go 模块文件，用于依赖管理。
• main.go: 项目的启动文件。
• package.json: 项目的元数据文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go。该文件包含了项目的入口点，负责初始化配置、启动 HTTP 服务器以及连接 MongoDB 数据库。

package main

import (
    "flag"
    "log"
    "net/http"
    "github.com/manishrjain/gocrud/pkg"
)

func main() {
    bindAddress := flag.String("bind-address", "0.0.0.0:8080", "Address to serve")
    mongoURI := flag.String("mongo-uri", "mongodb://localhost:27017", "MongoDB URI to use")
    mongoDB := flag.String("mongo-db", "gocrud", "MongoDB database to use")

    flag.Parse()

    // 初始化 MongoDB 连接
    err := pkg.InitMongoDB(*mongoURI, *mongoDB)
    if err != nil {
        log.Fatalf("Failed to connect to MongoDB: %v", err)
    }

    // 设置 HTTP 路由
    http.HandleFunc("/v1/pet", pkg.HandlePet)

    // 启动 HTTP 服务器
    log.Printf("Starting server on %s", *bindAddress)
    log.Fatal(http.ListenAndServe(*bindAddress, nil))
}

3. 项目的配置文件介绍

GoCRUD 项目的配置主要通过命令行标志或环境变量进行。以下是主要的配置项：

• --bind-address: 服务器监听地址，默认值为 0.0.0.0:8080。
• --mongo-uri: MongoDB 连接 URI，默认值为 mongodb://localhost:27017。
• --mongo-db: 使用的 MongoDB 数据库名称，默认值为 gocrud。

这些配置项可以通过命令行参数传递，例如：

go run main.go --bind-address=0.0.0.0:8080 --mongo-uri=mongodb://admin:password@localhost:27017 --mongo-db=gocrud

或者通过环境变量设置：

export GOCRUD_BIND_ADDRESS=0.0.0.0:8080
export GOCRUD_MONGO_URI=mongodb://admin:password@localhost:27017
export GOCRUD_MONGO_DB=gocrud
go run main.go

通过这些配置，可以灵活地调整 GoCRUD 项目的运行参数。