Skip to content

README.md

Latest commit

 

History

History
316 lines (241 loc) · 5.88 KB

README.md

File metadata and controls

316 lines (241 loc) · 5.88 KB

Gin App Start

基于 Gin 框架的现代化 Go Web 应用脚手架，遵循清晰的分层架构设计，支持 PostgreSQL 和 Redis。

⚡ 最新版本: v2.0.0 - 已升级到 Go 1.24 和最新依赖包

📚 完整文档

特性

  • ✅ 清晰的分层架构（Controller -> Service -> Repository）
  • ✅ PostgreSQL 数据库支持
  • ✅ Redis 缓存支持
  • ✅ 结构化日志（zap）
  • ✅ 统一错误处理
  • ✅ 统一响应格式
  • ✅ 中间件支持（日志、恢复、限流、CORS）
  • ✅ 优雅关闭
  • ✅ 环境配置管理
  • ✅ 自动数据库迁移

目录结构

gin-app-start/
├── cmd/                    # 应用程序入口
│   └── server/
│       └── main.go        # 主入口文件
├── internal/              # 私有应用程序代码
│   ├── config/           # 配置加载
│   ├── controller/       # HTTP 控制器层
│   ├── service/          # 业务逻辑层
│   ├── repository/       # 数据访问层
│   ├── model/            # 数据模型
│   ├── middleware/       # Gin 中间件
│   └── router/           # 路由配置
├── pkg/                  # 公共库代码
│   ├── database/         # 数据库连接
│   ├── logger/           # 日志处理
│   ├── errors/           # 错误处理
│   └── response/         # 统一响应格式
├── configs/              # 配置文件
│   ├── config.local.yaml
│   ├── config.dev.yaml
│   └── config.prod.yaml
├── go.mod
└── go.sum

快速开始

环境要求

  • Go >= 1.24
  • PostgreSQL >= 12
  • Redis >= 6.0

安装依赖

go mod download

配置数据库

  1. 创建 PostgreSQL 数据库：
CREATE DATABASE gin_app;
  1. 修改配置文件 configs/config.local.yaml：
database:
  host: localhost
  port: 5432
  user: postgres
  password: postgres
  dbname: gin_app
  sslmode: disable

运行应用

# 本地环境
SERVER_ENV=local go run cmd/server/main.go

# 开发环境
SERVER_ENV=dev go run cmd/server/main.go

# 生产环境
SERVER_ENV=prod go run cmd/server/main.go

健康检查

curl http://localhost:9060/health

API 文档

健康检查

GET /health

用户管理

创建用户

POST /api/v1/users
Content-Type: application/json

{
  "username": "testuser",
  "email": "test@example.com",
  "phone": "13800138000",
  "password": "password123"
}

获取用户

GET /api/v1/users/:id

更新用户

PUT /api/v1/users/:id
Content-Type: application/json

{
  "email": "newemail@example.com",
  "phone": "13900139000"
}

删除用户

DELETE /api/v1/users/:id

用户列表

GET /api/v1/users?page=1&page_size=10

响应格式

成功响应

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1,
    "username": "testuser",
    "email": "test@example.com"
  }
}

错误响应

{
  "code": 10001,
  "message": "参数错误",
  "data": null
}

分页响应

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [...],
    "total": 100,
    "page": 1,
    "page_size": 10
  }
}

配置说明

服务器配置

server:
  port: 9060              # 服务端口
  mode: debug             # 运行模式: debug/release/test
  read_timeout: 60        # 读超时（秒）
  write_timeout: 60       # 写超时（秒）
  limit_num: 100          # 限流数（每秒请求数）

数据库配置

database:
  host: localhost         # 数据库主机
  port: 5432             # 数据库端口
  user: postgres         # 数据库用户
  password: postgres     # 数据库密码
  dbname: gin_app        # 数据库名
  sslmode: disable       # SSL模式
  max_idle_conns: 10     # 最大空闲连接数
  max_open_conns: 100    # 最大打开连接数
  max_lifetime: 3600     # 连接最大生命周期（秒）
  log_level: info        # 日志级别
  auto_migrate: true     # 自动迁移

Redis配置

redis:
  addr: localhost:6379   # Redis地址
  password: ""           # Redis密码
  db: 0                  # Redis数据库
  pool_size: 10          # 连接池大小
  min_idle_conns: 5      # 最小空闲连接数
  max_retries: 3         # 最大重试次数

Docker 部署

构建镜像

docker build -t gin-app-start .

运行容器

docker run -d \
  -p 9060:9060 \
  -e SERVER_ENV=prod \
  -e DB_HOST=postgres \
  -e DB_USER=postgres \
  -e DB_PASSWORD=postgres \
  -e DB_NAME=gin_app \
  -e REDIS_ADDR=redis:6379 \
  -e REDIS_PASSWORD="" \
  gin-app-start

开发指南

添加新的 API

  1. 在 internal/model 中定义数据模型
  2. 在 internal/repository 中实现数据访问层
  3. 在 internal/service 中实现业务逻辑
  4. 在 internal/controller 中实现控制器
  5. 在 internal/router 中注册路由

错误处理

使用 pkg/errors 包定义和处理业务错误：

import "gin-app-start/pkg/errors"

// 使用预定义错误
return errors.ErrUserNotFound

// 创建新错误
return errors.NewBusinessError(10001, "自定义错误消息")

// 包装错误
return errors.WrapBusinessError(10001, "操作失败", err)

日志记录

使用 pkg/logger 包记录日志：

import (
    "gin-app-start/pkg/logger"
    "go.uber.org/zap"
)

logger.Info("操作成功", 
    zap.String("username", username),
    zap.Uint("user_id", userID),
)

logger.Error("操作失败", 
    zap.Error(err),
)

许可证

MIT License