调整工具类的方法,优化方法调用及增加迁移工具及其用法
This commit is contained in:
39
templates/Dockerfile.example
Normal file
39
templates/Dockerfile.example
Normal file
@@ -0,0 +1,39 @@
|
||||
# Dockerfile 示例
|
||||
# 展示如何构建包含迁移工具的 Go 应用
|
||||
|
||||
# ===== 构建阶段 =====
|
||||
FROM golang:1.21 as builder
|
||||
|
||||
WORKDIR /app
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
|
||||
COPY . .
|
||||
|
||||
# 编译应用和迁移工具
|
||||
RUN go build -o bin/server cmd/server/main.go
|
||||
RUN go build -o bin/migrate cmd/migrate/main.go
|
||||
|
||||
# ===== 运行阶段 =====
|
||||
FROM debian:bookworm-slim
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# 安装运行时依赖
|
||||
RUN apt-get update && apt-get install -y ca-certificates && rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# 复制二进制文件和迁移文件
|
||||
COPY --from=builder /app/bin/server .
|
||||
COPY --from=builder /app/bin/migrate .
|
||||
COPY --from=builder /app/migrations ./migrations
|
||||
|
||||
EXPOSE 8080
|
||||
|
||||
# 启动:先执行迁移,再启动应用
|
||||
CMD ["sh", "-c", "./migrate up && ./server"]
|
||||
|
||||
# 注意:
|
||||
# 1. 配置文件通过 docker-compose volumes 挂载,不打包进镜像
|
||||
# 2. 镜像只包含二进制文件和迁移SQL文件
|
||||
# 3. 配置文件在运行时提供,更安全、更灵活
|
||||
|
||||
78
templates/Makefile.example
Normal file
78
templates/Makefile.example
Normal file
@@ -0,0 +1,78 @@
|
||||
# 示例 Makefile
|
||||
# 提供常用的开发和部署命令
|
||||
|
||||
.PHONY: help build run migrate-up migrate-down migrate-status docker-build docker-up clean
|
||||
|
||||
# 默认目标:显示帮助
|
||||
help:
|
||||
@echo "可用命令:"
|
||||
@echo " make build - 编译应用和迁移工具"
|
||||
@echo " make run - 运行应用(先执行迁移)"
|
||||
@echo " make migrate-up - 执行数据库迁移"
|
||||
@echo " make migrate-down - 回滚数据库迁移"
|
||||
@echo " make migrate-status - 查看迁移状态"
|
||||
@echo " make docker-build - 构建 Docker 镜像"
|
||||
@echo " make docker-up - 启动 Docker 服务"
|
||||
@echo " make clean - 清理编译文件"
|
||||
|
||||
# 编译
|
||||
build:
|
||||
@echo "编译应用..."
|
||||
@mkdir -p bin
|
||||
@go build -o bin/server cmd/server/main.go
|
||||
@go build -o bin/migrate cmd/migrate/main.go
|
||||
@echo "✓ 编译完成"
|
||||
|
||||
# 运行应用
|
||||
run: migrate-up
|
||||
@echo "启动应用..."
|
||||
@./bin/server
|
||||
|
||||
# 执行迁移
|
||||
migrate-up: build
|
||||
@echo "执行数据库迁移..."
|
||||
@./bin/migrate up
|
||||
|
||||
# 回滚迁移
|
||||
migrate-down: build
|
||||
@echo "回滚数据库迁移..."
|
||||
@./bin/migrate down
|
||||
|
||||
# 查看迁移状态
|
||||
migrate-status: build
|
||||
@./bin/migrate status
|
||||
|
||||
# 构建 Docker 镜像
|
||||
docker-build:
|
||||
@echo "构建 Docker 镜像..."
|
||||
@docker build -t myapp:latest .
|
||||
|
||||
# 启动 Docker 服务
|
||||
docker-up:
|
||||
@echo "启动 Docker 服务..."
|
||||
@docker-compose up --build
|
||||
|
||||
# 清理
|
||||
clean:
|
||||
@echo "清理编译文件..."
|
||||
@rm -rf bin
|
||||
@echo "✓ 清理完成"
|
||||
|
||||
# 开发环境:直接运行(不编译)
|
||||
dev-migrate-up:
|
||||
@go run cmd/migrate/main.go up
|
||||
|
||||
dev-migrate-down:
|
||||
@go run cmd/migrate/main.go down
|
||||
|
||||
dev-migrate-status:
|
||||
@go run cmd/migrate/main.go status
|
||||
|
||||
# 交叉编译(Linux)
|
||||
build-linux:
|
||||
@echo "交叉编译 Linux 版本..."
|
||||
@mkdir -p bin
|
||||
@GOOS=linux GOARCH=amd64 go build -o bin/server-linux cmd/server/main.go
|
||||
@GOOS=linux GOARCH=amd64 go build -o bin/migrate-linux cmd/migrate/main.go
|
||||
@echo "✓ Linux 版本编译完成"
|
||||
|
||||
40
templates/README.md
Normal file
40
templates/README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# 模板文件
|
||||
|
||||
这个目录包含了可以直接复制到你项目中使用的模板文件。
|
||||
|
||||
## 包含的模板
|
||||
|
||||
- `migrate/main.go` - 数据库迁移工具模板 ⭐
|
||||
- `Dockerfile.example` - Docker 构建示例
|
||||
- `docker-compose.example.yml` - Docker Compose 示例
|
||||
- `Makefile.example` - Makefile 常用命令示例
|
||||
|
||||
## 快速使用
|
||||
|
||||
### 迁移工具模板
|
||||
|
||||
```bash
|
||||
# 1. 复制到你的项目
|
||||
mkdir -p cmd/migrate
|
||||
cp templates/migrate/main.go cmd/migrate/
|
||||
|
||||
# 2. 编译
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
|
||||
# 3. 使用
|
||||
./bin/migrate up
|
||||
./bin/migrate -help
|
||||
```
|
||||
|
||||
### Docker 模板
|
||||
|
||||
```bash
|
||||
# 复制到你的项目根目录
|
||||
cp templates/Dockerfile.example Dockerfile
|
||||
cp templates/docker-compose.example.yml docker-compose.yml
|
||||
cp templates/Makefile.example Makefile
|
||||
```
|
||||
|
||||
## 完整文档
|
||||
|
||||
详细使用说明请查看:[MIGRATION.md](../MIGRATION.md)
|
||||
22
templates/docker-compose.example.yml
Normal file
22
templates/docker-compose.example.yml
Normal file
@@ -0,0 +1,22 @@
|
||||
# docker-compose.yml 示例
|
||||
# 展示如何在 docker-compose 中使用迁移工具
|
||||
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
app:
|
||||
build: .
|
||||
ports:
|
||||
- "8080:8080"
|
||||
volumes:
|
||||
# 挂载配置文件(推荐:修改配置无需重启容器)
|
||||
- ./config.json:/app/config.json:ro
|
||||
# 启动时先执行迁移,再启动应用
|
||||
command: sh -c "./migrate up && ./server"
|
||||
|
||||
# 使用说明:
|
||||
# 1. 将此配置添加到你的 docker-compose.yml 中
|
||||
# 2. 确保你的配置文件(config.json)包含数据库连接信息
|
||||
# 3. 修改配置后,手动执行迁移:docker-compose exec app ./migrate up
|
||||
# 4. 无需重启容器!
|
||||
|
||||
147
templates/migrate/main.go
Normal file
147
templates/migrate/main.go
Normal file
@@ -0,0 +1,147 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/migration"
|
||||
)
|
||||
|
||||
// 数据库迁移工具(黑盒模式)
|
||||
//
|
||||
// 工作原理:
|
||||
// 此工具调用 migration.RunMigrationsFromConfigWithCommand() 方法,
|
||||
// 内部自动处理配置加载、数据库连接、迁移执行等所有细节。
|
||||
// 你只需要提供配置文件和SQL迁移文件即可。
|
||||
//
|
||||
// 使用方式:
|
||||
// 基本用法:
|
||||
// ./migrate up # 使用默认配置
|
||||
// ./migrate up -config /path/to/config.json # 指定配置文件
|
||||
// ./migrate up -config config.json -dir db/migrations # 指定配置和迁移目录
|
||||
// ./migrate status # 查看迁移状态
|
||||
// ./migrate down # 回滚最后一个迁移
|
||||
//
|
||||
// Docker 中使用:
|
||||
// # 方式1:挂载配置文件
|
||||
// docker run -v /host/config.json:/app/config.json myapp ./migrate up
|
||||
//
|
||||
// # 方式2:使用环境变量
|
||||
// docker run -e DATABASE_URL="mysql://..." myapp ./migrate up
|
||||
//
|
||||
// # 方式3:指定容器内的配置文件路径
|
||||
// docker run myapp ./migrate up -config /etc/app/config.json
|
||||
//
|
||||
// 支持的命令:
|
||||
// up - 执行所有待执行的迁移
|
||||
// down - 回滚最后一个迁移
|
||||
// status - 查看迁移状态
|
||||
//
|
||||
// 配置优先级(从高到低):
|
||||
// 1. 命令行参数 -config 和 -dir
|
||||
// 2. 环境变量 CONFIG_FILE 和 MIGRATIONS_DIR
|
||||
// 3. 环境变量 DATABASE_URL(直接连接,无需配置文件)
|
||||
// 4. 默认值(config.json 和 migrations)
|
||||
|
||||
var (
|
||||
configFile string
|
||||
migrationsDir string
|
||||
showHelp bool
|
||||
)
|
||||
|
||||
func init() {
|
||||
flag.StringVar(&configFile, "config", "", "配置文件路径(默认:config.json 或环境变量 CONFIG_FILE)")
|
||||
flag.StringVar(&configFile, "c", "", "配置文件路径(简写)")
|
||||
flag.StringVar(&migrationsDir, "dir", "", "迁移文件目录(默认:migrations 或环境变量 MIGRATIONS_DIR)")
|
||||
flag.StringVar(&migrationsDir, "d", "", "迁移文件目录(简写)")
|
||||
flag.BoolVar(&showHelp, "help", false, "显示帮助信息")
|
||||
flag.BoolVar(&showHelp, "h", false, "显示帮助信息(简写)")
|
||||
}
|
||||
|
||||
func main() {
|
||||
flag.Parse()
|
||||
|
||||
// 显示帮助
|
||||
if showHelp {
|
||||
printHelp()
|
||||
os.Exit(0)
|
||||
}
|
||||
|
||||
// 获取命令(默认up)
|
||||
command := "up"
|
||||
args := flag.Args()
|
||||
if len(args) > 0 {
|
||||
command = args[0]
|
||||
}
|
||||
|
||||
// 验证命令
|
||||
if command != "up" && command != "down" && command != "status" {
|
||||
fmt.Fprintf(os.Stderr, "错误:未知命令 '%s'\n\n", command)
|
||||
printHelp()
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// 获取配置文件路径(优先级:命令行 > 环境变量 > 默认值)
|
||||
if configFile == "" {
|
||||
configFile = getEnv("CONFIG_FILE", "config.json")
|
||||
}
|
||||
|
||||
// 获取迁移目录(优先级:命令行 > 环境变量 > 默认值)
|
||||
if migrationsDir == "" {
|
||||
migrationsDir = getEnv("MIGRATIONS_DIR", "migrations")
|
||||
}
|
||||
|
||||
// 执行迁移
|
||||
if err := migration.RunMigrationsFromConfigWithCommand(configFile, migrationsDir, command); err != nil {
|
||||
fmt.Fprintf(os.Stderr, "错误: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
func getEnv(key, defaultValue string) string {
|
||||
if value := os.Getenv(key); value != "" {
|
||||
return value
|
||||
}
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
func printHelp() {
|
||||
fmt.Println("数据库迁移工具")
|
||||
fmt.Println()
|
||||
fmt.Println("用法:")
|
||||
fmt.Println(" migrate [命令] [选项]")
|
||||
fmt.Println()
|
||||
fmt.Println("命令:")
|
||||
fmt.Println(" up 执行所有待执行的迁移(默认)")
|
||||
fmt.Println(" down 回滚最后一个迁移")
|
||||
fmt.Println(" status 查看迁移状态")
|
||||
fmt.Println()
|
||||
fmt.Println("选项:")
|
||||
fmt.Println(" -config, -c 配置文件路径(默认: config.json)")
|
||||
fmt.Println(" -dir, -d 迁移文件目录(默认: migrations)")
|
||||
fmt.Println(" -help, -h 显示帮助信息")
|
||||
fmt.Println()
|
||||
fmt.Println("示例:")
|
||||
fmt.Println(" # 使用默认配置")
|
||||
fmt.Println(" migrate up")
|
||||
fmt.Println()
|
||||
fmt.Println(" # 指定配置文件")
|
||||
fmt.Println(" migrate up -config /etc/app/config.json")
|
||||
fmt.Println()
|
||||
fmt.Println(" # 指定配置和迁移目录")
|
||||
fmt.Println(" migrate up -c config.json -d db/migrations")
|
||||
fmt.Println()
|
||||
fmt.Println(" # 使用环境变量")
|
||||
fmt.Println(" DATABASE_URL='mysql://...' migrate up")
|
||||
fmt.Println()
|
||||
fmt.Println(" # Docker 中使用")
|
||||
fmt.Println(" docker run -v /host/config.json:/app/config.json myapp migrate up")
|
||||
fmt.Println()
|
||||
fmt.Println("配置优先级(从高到低):")
|
||||
fmt.Println(" 1. 命令行参数 -config 和 -dir")
|
||||
fmt.Println(" 2. 环境变量 CONFIG_FILE 和 MIGRATIONS_DIR")
|
||||
fmt.Println(" 3. 环境变量 DATABASE_URL")
|
||||
fmt.Println(" 4. 默认值(config.json 和 migrations)")
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user