Simple Bank 项目教程

1. 项目目录结构及介绍

Simple Bank 项目的目录结构如下：

simplebank/
├── api/
│   ├── account.go
│   ├── auth.go
│   ├── ...
├── db/
│   ├── migration/
│   │   ├── 000001_init_schema.up.sql
│   │   ├── 000001_init_schema.down.sql
│   │   ├── ...
│   ├── query/
│   │   ├── account.sql.go
│   │   ├── ...
├── doc/
│   ├── db_schema.dbml
│   ├── ...
├── util/
│   ├── config.go
│   ├── logger.go
│   ├── ...
├── main.go
├── Makefile
├── README.md
├── docker-compose.yaml
├── go.mod
├── go.sum
└── ...

目录结构介绍

• api/: 包含处理 HTTP 请求的 API 文件，如 account.go 和 auth.go。
• db/: 数据库相关文件，包括数据库迁移文件和生成的 SQL 查询代码。
  • migration/: 数据库迁移文件，包含 .up.sql 和 .down.sql 文件。
  • query/: 生成的 SQL 查询代码文件。
• doc/: 项目文档文件，如数据库模式文件 db_schema.dbml。
• util/: 工具类文件，如配置文件 config.go 和日志文件 logger.go。
• main.go: 项目的启动文件。
• Makefile: 包含项目的构建和运行命令。
• README.md: 项目的基本介绍和使用说明。
• docker-compose.yaml: Docker 配置文件，用于本地开发环境的启动。
• go.mod 和 go.sum: Go 模块依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它负责初始化配置、启动 HTTP 服务器并监听端口。以下是 main.go 的主要内容：

package main

import (
    "log"
    "net/http"
    "simplebank/api"
    "simplebank/util"
)

func main() {
    config, err := util.LoadConfig(".")
    if err != nil {
        log.Fatal("cannot load config:", err)
    }

    server := api.NewServer(config)
    err = server.Start(config.ServerAddress)
    if err != nil {
        log.Fatal("cannot start server:", err)
    }
}

启动文件介绍

• 加载配置: 使用 util.LoadConfig 函数加载项目的配置文件。
• 创建服务器: 使用 api.NewServer 函数创建一个新的 HTTP 服务器实例。
• 启动服务器: 调用 server.Start 方法启动服务器并监听指定的端口。

3. 项目的配置文件介绍

项目的配置文件是通过 util.LoadConfig 函数加载的，配置文件通常是一个 .env 文件或 JSON 文件。以下是一个示例配置文件的内容：

SERVER_ADDRESS=0.0.0.0:8080
DB_SOURCE=postgres://user:password@localhost:5432/simple_bank?sslmode=disable
TOKEN_SYMMETRIC_KEY=your-secret-key
ACCESS_TOKEN_DURATION=15m

配置文件介绍

• SERVER_ADDRESS: 服务器监听的地址和端口。
• DB_SOURCE: 数据库连接字符串，包含用户名、密码、主机地址、端口和数据库名称。
• TOKEN_SYMMETRIC_KEY: 用于加密和解密 JWT 或 PASETO 令牌的对称密钥。
• ACCESS_TOKEN_DURATION: 访问令牌的有效期。

通过以上配置，项目可以正确地启动并连接到数据库，同时配置了安全相关的参数。