Gorm-Zero 开源项目教程

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

Gorm-Zero 项目的目录结构如下：

gorm-zero/
├── api/
│   ├── internal/
│   │   ├── handler/
│   │   ├── logic/
│   │   ├── svc/
│   │   └── types/
│   └── xxx.go
├── cmd/
│   └── gorm-zero/
│       └── main.go
├── config/
│   └── config.go
├── db/
│   ├── model/
│   └── query/
├── docs/
├── go.mod
├── go.sum
├── internal/
│   ├── config/
│   ├── handler/
│   ├── logic/
│   ├── middleware/
│   ├── svc/
│   └── types/
├── pkg/
├── README.md
└── script/

目录结构介绍

• api/: 存放API接口相关的文件。
  • internal/: 包含API接口的内部实现。
    • handler/: 处理HTTP请求的处理器。
    • logic/: 业务逻辑处理。
    • svc/: 服务上下文。
    • types/: 定义请求和响应的数据类型。
• cmd/: 存放项目的启动文件。
  • gorm-zero/: 项目的主目录。
    • main.go: 项目的入口文件。
• config/: 存放项目的配置文件。
  • config.go: 配置文件的定义和加载。
• db/: 存放数据库相关的文件。
  • model/: 数据库模型定义。
  • query/: 数据库查询逻辑。
• docs/: 存放项目的文档。
• internal/: 项目的内部实现。
  • config/: 内部配置文件。
  • handler/: 内部处理器。
  • logic/: 内部业务逻辑。
  • middleware/: 中间件。
  • svc/: 内部服务上下文。
  • types/: 内部数据类型定义。
• pkg/: 存放可复用的包。
• script/: 存放脚本文件。

2. 项目的启动文件介绍

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

package main

import (
    "gorm-zero/internal/config"
    "gorm-zero/internal/handler"
    "gorm-zero/internal/svc"
    "gorm-zero/pkg/middleware"
    "github.com/zeromicro/go-zero/core/conf"
    "github.com/zeromicro/go-zero/rest"
)

var configFile = flag.String("f", "etc/gorm-zero-api.yaml", "the config file")

func main() {
    var c config.Config
    conf.MustLoad(*configFile, &c)

    ctx := svc.NewServiceContext(c)
    server := rest.MustNewServer(c.RestConf)
    defer server.Stop()

    handler.RegisterHandlers(server, ctx)

    fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
    server.Start()
}

启动文件介绍

• main.go: 项目的入口文件。
  • 加载配置文件。
  • 初始化服务上下文。
  • 创建并启动HTTP服务器。
  • 注册路由处理器。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.go。该文件定义了项目的配置结构，并提供了加载配置的方法。

package config

import (
    "github.com/zeromicro/go-zero/rest"
    "github.com/zeromicro/go-zero/core/stores/sqlx"
)

type Config struct {
    rest.RestConf
    Database sqlx.SqlConnConf
}

配置文件介绍

• config.go: 定义了项目的配置结构。
  • RestConf: HTTP服务配置。
  • Database: 数据库连接配置。