Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 545c6ef6a4 | |||
| 5cfa0d7ce5 | |||
| f62e8ecebf | |||
| 339920a940 | |||
| b66f345281 | |||
| 6547e7bca8 | |||
| 6146178111 |
35
MIGRATION.md
35
MIGRATION.md
@@ -105,14 +105,10 @@ go build -o bin/migrate cmd/migrate/main.go
|
||||
}
|
||||
```
|
||||
|
||||
#### 方式2：环境变量（推荐生产环境）
|
||||
#### 方式2：环境变量指定配置文件路径（推荐生产环境）
|
||||
|
||||
```bash
|
||||
# 使用 DATABASE_URL（最简单）
|
||||
export DATABASE_URL="mysql://root:password@localhost:3306/mydb"
|
||||
./bin/migrate up
|
||||
|
||||
# 覆盖配置路径
|
||||
# 使用环境变量指定配置文件路径
|
||||
export CONFIG_FILE="/etc/app/config.json"
|
||||
export MIGRATIONS_DIR="/opt/app/migrations"
|
||||
./bin/migrate up
|
||||
@@ -122,8 +118,7 @@ export MIGRATIONS_DIR="/opt/app/migrations"
|
||||
|
||||
1. 命令行参数 `-config` 和 `-dir`（最高）
|
||||
2. 环境变量 `CONFIG_FILE` 和 `MIGRATIONS_DIR`
|
||||
3. 环境变量 `DATABASE_URL`
|
||||
4. 默认值 `config.json` 和 `migrations`
|
||||
3. 默认值 `config.json` 和 `migrations`
|
||||
|
||||
---
|
||||
|
||||
@@ -185,20 +180,20 @@ services:
|
||||
docker-compose exec app ./migrate up
|
||||
```
|
||||
|
||||
### 方式3：使用环境变量
|
||||
### 方式3：使用环境变量指定配置文件路径
|
||||
|
||||
无需配置文件（适用于简单场景）：
|
||||
适用于多环境部署，通过环境变量指定不同环境的配置文件：
|
||||
|
||||
```yaml
|
||||
services:
|
||||
app:
|
||||
build: .
|
||||
environment:
|
||||
DATABASE_URL: mysql://root:password@db:3306/mydb
|
||||
CONFIG_FILE: /app/config.prod.json
|
||||
MIGRATIONS_DIR: /app/migrations
|
||||
volumes:
|
||||
- ./config.prod.json:/app/config.prod.json:ro
|
||||
command: sh -c "./migrate up && ./server"
|
||||
|
||||
# 注意：DATABASE_URL 的值应该指向你的数据库服务
|
||||
# 例如：mysql://user:pass@your-db-host:3306/dbname
|
||||
```
|
||||
|
||||
### Dockerfile
|
||||
@@ -336,10 +331,12 @@ jobs:
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
go build -o bin/server cmd/server/main.go
|
||||
|
||||
- name: Create Config File
|
||||
run: |
|
||||
echo '${{ secrets.CONFIG_JSON }}' > config.json
|
||||
|
||||
- name: Run Migrations
|
||||
env:
|
||||
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
||||
run: ./bin/migrate up
|
||||
run: ./bin/migrate up -config config.json
|
||||
|
||||
- name: Deploy
|
||||
run: ./bin/server
|
||||
@@ -500,11 +497,11 @@ go build -o bin/migrate cmd/migrate/main.go
|
||||
### 3. 生产环境
|
||||
|
||||
- 编译后部署，先执行迁移再启动应用
|
||||
- 使用环境变量管理敏感信息
|
||||
- 使用配置文件管理敏感信息
|
||||
|
||||
```bash
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
DATABASE_URL="mysql://..." ./bin/migrate up
|
||||
./bin/migrate up -config config.json
|
||||
./bin/server
|
||||
```
|
||||
|
||||
|
||||
@@ -34,6 +34,12 @@ go get git.toowon.com/jimmy/go-common@latest
|
||||
"level": "info",
|
||||
"output": "stdout",
|
||||
"async": true
|
||||
},
|
||||
"rateLimit": {
|
||||
"enable": true,
|
||||
"rate": 100,
|
||||
"period": 60,
|
||||
"byIP": true
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -61,18 +67,12 @@ func main() {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// 获取logger
|
||||
logger, _ := fac.GetLogger()
|
||||
defer logger.Close()
|
||||
// 使用factory的黑盒方法获取中间件链
|
||||
// 自动从配置文件读取并配置所有中间件
|
||||
chain := fac.GetMiddlewareChain()
|
||||
|
||||
// 配置中间件链
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(&middleware.RecoveryConfig{Logger: logger}),
|
||||
middleware.Logging(&middleware.LoggingConfig{Logger: logger}),
|
||||
middleware.RateLimitByIP(100, time.Minute),
|
||||
middleware.CORS(nil),
|
||||
middleware.Timezone,
|
||||
)
|
||||
// （可选）如果项目需要额外的中间件，可以继续添加
|
||||
// chain.Append(yourAuthMiddleware, yourMetricsMiddleware)
|
||||
|
||||
// 注册路由
|
||||
http.Handle("/api/hello", chain.ThenFunc(handleHello))
|
||||
@@ -284,21 +284,57 @@ loggerConfig := &config.LoggerConfig{
|
||||
}
|
||||
```
|
||||
|
||||
### Q: 如何按用户ID限流？
|
||||
### Q: 如何添加自定义中间件？
|
||||
|
||||
```go
|
||||
limiter := middleware.NewTokenBucketLimiter(100, time.Minute)
|
||||
rateLimitConfig := &middleware.RateLimitConfig{
|
||||
Limiter: limiter,
|
||||
KeyFunc: func(r *http.Request) string {
|
||||
return r.Header.Get("X-User-ID")
|
||||
},
|
||||
}
|
||||
chain := middleware.NewChain(
|
||||
middleware.RateLimit(rateLimitConfig),
|
||||
// 获取基础中间件链
|
||||
chain := fac.GetMiddlewareChain()
|
||||
|
||||
// 添加自定义中间件
|
||||
chain.Append(
|
||||
yourAuthMiddleware, // 认证中间件
|
||||
yourMetricsMiddleware, // 指标中间件
|
||||
// 更多自定义中间件...
|
||||
)
|
||||
|
||||
// 使用扩展后的中间件链
|
||||
http.Handle("/api/secure", chain.ThenFunc(yourHandler))
|
||||
```
|
||||
|
||||
自定义中间件示例：
|
||||
|
||||
```go
|
||||
func authMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
token := r.Header.Get("Authorization")
|
||||
if token == "" {
|
||||
http.Error(w, "Unauthorized", 401)
|
||||
return
|
||||
}
|
||||
// 验证token...
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
### Q: 如何按用户ID限流？
|
||||
|
||||
在配置文件中设置：
|
||||
|
||||
```json
|
||||
{
|
||||
"rateLimit": {
|
||||
"enable": true,
|
||||
"rate": 100,
|
||||
"period": 60,
|
||||
"byUserID": true,
|
||||
"byIP": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
中间件会自动从 `X-User-ID` header 中获取用户ID进行限流。
|
||||
|
||||
## 下一步
|
||||
|
||||
恭喜！你已经掌握了 GoCommon 的基本使用。
|
||||
|
||||
500
README.md
500
README.md
@@ -73,6 +73,50 @@
|
||||
### 10. 日志工具 (logger)
|
||||
提供统一的日志记录功能，支持多种日志级别和输出方式，使用Go标准库实现。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Factory 黑盒模式（核心设计）
|
||||
|
||||
**理念**：外部项目只需传递一个配置文件路径，直接使用黑盒方法，无需获取内部对象。
|
||||
|
||||
### 方法分类
|
||||
|
||||
| 类型 | 方法 | 使用方式 | 推荐度 |
|
||||
|------|------|----------|--------|
|
||||
| **黑盒方法（推荐）** | | | |
|
||||
| 中间件 | `GetMiddlewareChain()` | 直接使用，可Append自定义中间件 | ⭐⭐⭐ |
|
||||
| 日志 | `LogInfo()`, `LogError()` 等 | 直接调用，无需获取logger对象 | ⭐⭐⭐ |
|
||||
| Redis | `RedisSet()`, `RedisGet()` 等 | 直接调用，覆盖常用操作 | ⭐⭐⭐ |
|
||||
| 邮件 | `SendEmail()` | 直接调用 | ⭐⭐⭐ |
|
||||
| 短信 | `SendSMS()` | 直接调用 | ⭐⭐⭐ |
|
||||
| 存储 | `UploadFile()`, `GetFileURL()` | 直接调用 | ⭐⭐⭐ |
|
||||
| **Get方法（高级功能）** | | | |
|
||||
| 数据库 | `GetDatabase()` | 返回GORM对象，用于复杂查询 | ⭐⭐ |
|
||||
| Redis高级 | `GetRedisClient()` | 返回Redis客户端，用于Hash/List/Set等 | ⭐ |
|
||||
| Logger高级 | `GetLogger()` | 返回Logger对象，用于Close等 | ⭐ |
|
||||
|
||||
### 使用示例
|
||||
|
||||
```go
|
||||
// 创建工厂（只需配置文件路径）
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// ====== 推荐使用黑盒方法 ======
|
||||
fac.LogInfo("用户登录")
|
||||
fac.RedisSet(ctx, "key", "value", time.Hour)
|
||||
fac.SendEmail([]string{"user@example.com"}, "主题", "内容")
|
||||
chain := fac.GetMiddlewareChain()
|
||||
|
||||
// ====== 仅在需要高级功能时获取对象 ======
|
||||
db, _ := fac.GetDatabase() // 数据库操作复杂，使用GORM
|
||||
db.Find(&users)
|
||||
|
||||
client, _ := fac.GetRedisClient() // Redis高级操作
|
||||
client.HSet(ctx, "user:1", "name", "Alice")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
### 1. 配置私有仓库（重要）
|
||||
@@ -141,53 +185,46 @@ go get git.toowon.com/jimmy/go-common@v1.0.0
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 使用工厂模式（最简单，推荐）
|
||||
### 2. 使用工厂黑盒模式（最简单，推荐）⭐
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 从配置文件创建工厂
|
||||
fac, _ := factory.NewFactoryFromFile("./config.json")
|
||||
// 只需传入配置文件路径
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取logger
|
||||
logger, _ := fac.GetLogger()
|
||||
defer logger.Close()
|
||||
// 获取配置好的中间件链（黑盒）
|
||||
chain := fac.GetMiddlewareChain()
|
||||
|
||||
// 配置中间件
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(&middleware.RecoveryConfig{Logger: logger}),
|
||||
middleware.Logging(&middleware.LoggingConfig{Logger: logger}),
|
||||
middleware.RateLimitByIP(100, time.Minute),
|
||||
middleware.CORS(nil),
|
||||
middleware.Timezone,
|
||||
)
|
||||
// （可选）添加自定义中间件
|
||||
chain.Append(yourAuthMiddleware)
|
||||
|
||||
// 注册API路由
|
||||
// 注册路由
|
||||
http.Handle("/api/hello", chain.ThenFunc(handleHello))
|
||||
|
||||
// 启动服务
|
||||
http.ListenAndServe(":8080", nil)
|
||||
}
|
||||
|
||||
func handleHello(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 使用工厂记录日志
|
||||
// fac.LogInfo("Hello API called")
|
||||
// 使用黑盒方法（无需获取对象）
|
||||
fac.LogInfo("处理请求: /api/hello")
|
||||
fac.RedisSet(ctx, "last_visit", time.Now().String(), time.Hour)
|
||||
|
||||
// 返回响应
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Hello, World!",
|
||||
"message": "Hello!",
|
||||
"timezone": h.GetTimezone(),
|
||||
})
|
||||
}
|
||||
@@ -200,229 +237,85 @@ go run main.go
|
||||
# 访问 http://localhost:8080/api/hello
|
||||
```
|
||||
|
||||
## 使用示例
|
||||
## 核心功能示例
|
||||
|
||||
详细的使用说明请参考各模块的文档：
|
||||
- **[数据库迁移完整指南](./MIGRATION.md)** ⭐ - 独立工具，零耦合
|
||||
- [数据库迁移工具文档](./docs/migration.md)
|
||||
- [日期转换工具文档](./docs/datetime.md)
|
||||
- [HTTP Restful工具文档](./docs/http.md)
|
||||
- [中间件工具文档](./docs/middleware.md)
|
||||
- [配置工具文档](./docs/config.md)
|
||||
- [存储工具文档](./docs/storage.md)
|
||||
- [邮件工具文档](./docs/email.md)
|
||||
- [短信工具文档](./docs/sms.md)
|
||||
- [工厂工具文档](./docs/factory.md)
|
||||
- [日志工具文档](./docs/logger.md)
|
||||
详细文档请参考：[完整文档](./docs/README.md) | [快速开始](./QUICKSTART.md)
|
||||
|
||||
### 快速示例
|
||||
|
||||
#### 数据库迁移（独立工具，零耦合）⭐
|
||||
### 数据库迁移
|
||||
```bash
|
||||
# 1. 复制模板：templates/migrate/main.go -> cmd/migrate/main.go
|
||||
# 2. 编译（生产环境推荐）
|
||||
# 编译独立工具
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
|
||||
# 3. 使用
|
||||
./bin/migrate up # 使用默认配置
|
||||
# 执行迁移
|
||||
./bin/migrate up # 默认配置
|
||||
./bin/migrate up -config /path/to/config.json # 指定配置
|
||||
./bin/migrate status # 查看状态
|
||||
|
||||
# 迁移文件：migrations/20240101000001_create_users.sql
|
||||
# CREATE TABLE users (id BIGINT PRIMARY KEY AUTO_INCREMENT, ...);
|
||||
|
||||
# Docker 中使用（挂载配置，修改无需重启）
|
||||
# volumes:
|
||||
# - ./config.json:/app/config.json:ro
|
||||
# command: sh -c "./migrate up && ./server"
|
||||
```
|
||||
|
||||
**详细说明**：[数据库迁移完整指南](./MIGRATION.md) 📖
|
||||
**详细说明**：[数据库迁移指南](./MIGRATION.md) ⭐
|
||||
|
||||
#### 日期转换
|
||||
### 工厂黑盒模式（推荐）
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/datetime"
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
now := datetime.Now()
|
||||
str := datetime.FormatDateTime(now)
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 中间件
|
||||
chain := fac.GetMiddlewareChain()
|
||||
chain.Append(yourAuthMiddleware) // 添加自定义中间件
|
||||
|
||||
// 日志
|
||||
fac.LogInfo("用户登录成功")
|
||||
|
||||
// Redis
|
||||
fac.RedisSet(ctx, "key", "value", time.Hour)
|
||||
|
||||
// 邮件/短信
|
||||
fac.SendEmail([]string{"user@example.com"}, "主题", "内容")
|
||||
fac.SendSMS([]string{"13800138000"}, map[string]string{"code": "123456"})
|
||||
|
||||
// 文件上传
|
||||
url, _ := fac.UploadFile(ctx, "images/test.jpg", file, "image/jpeg")
|
||||
|
||||
// 数据库（高级功能）
|
||||
db, _ := fac.GetDatabase()
|
||||
db.Find(&users)
|
||||
```
|
||||
|
||||
#### HTTP响应（Handler黑盒模式）
|
||||
### HTTP处理器
|
||||
```go
|
||||
import (
|
||||
"net/http"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
import commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
|
||||
// 使用Handler（黑盒模式）
|
||||
func GetUser(h *commonhttp.Handler) {
|
||||
id := h.GetQueryInt64("id", 0) // 无需传递r
|
||||
h.Success(data) // 无需传递w
|
||||
id := h.GetQueryInt64("id", 0)
|
||||
h.Success(data)
|
||||
}
|
||||
|
||||
http.HandleFunc("/user", commonhttp.HandleFunc(GetUser))
|
||||
```
|
||||
|
||||
#### 中间件（完整的生产级配置）
|
||||
```go
|
||||
import (
|
||||
"time"
|
||||
"git.toowon.com/jimmy/go-common/config"
|
||||
"git.toowon.com/jimmy/go-common/logger"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
### 日期时间
|
||||
**推荐方式：通过 factory 使用（黑盒模式）**
|
||||
|
||||
// 方式1：简单配置（使用默认设置）
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(nil), // Panic恢复
|
||||
middleware.Logging(nil), // 请求日志
|
||||
middleware.RateLimit(nil), // 限流（100请求/分钟）
|
||||
middleware.CORS(nil), // CORS（允许所有源）
|
||||
middleware.Timezone, // 时区处理
|
||||
)
|
||||
http.Handle("/api", chain.ThenFunc(yourHandler))
|
||||
|
||||
// 方式2：生产级配置（推荐）
|
||||
// 创建异步logger
|
||||
myLogger, _ := logger.NewLogger(&config.LoggerConfig{
|
||||
Level: "info",
|
||||
Output: "both",
|
||||
FilePath: "./logs/app.log",
|
||||
Async: true, // 异步模式，不阻塞请求
|
||||
})
|
||||
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(&middleware.RecoveryConfig{
|
||||
Logger: myLogger,
|
||||
EnableStackTrace: true,
|
||||
}),
|
||||
middleware.Logging(&middleware.LoggingConfig{
|
||||
Logger: myLogger,
|
||||
SkipPaths: []string{"/health"},
|
||||
}),
|
||||
middleware.RateLimitByIP(100, time.Minute), // 100请求/分钟
|
||||
middleware.CORS(nil),
|
||||
middleware.Timezone,
|
||||
)
|
||||
|
||||
// 在Handler中使用
|
||||
func handler(h *commonhttp.Handler) {
|
||||
timezone := h.GetTimezone() // 获取时区
|
||||
h.Success(data)
|
||||
}
|
||||
```
|
||||
|
||||
#### 配置管理
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/config"
|
||||
|
||||
// 从文件加载配置
|
||||
cfg, err := config.LoadFromFile("./config.json")
|
||||
|
||||
// 获取各种配置
|
||||
dsn, _ := cfg.GetDatabaseDSN()
|
||||
redisAddr := cfg.GetRedisAddr()
|
||||
corsConfig := cfg.GetCORS()
|
||||
```
|
||||
|
||||
#### 文件上传和查看（推荐使用工厂黑盒模式）
|
||||
```go
|
||||
import (
|
||||
"context"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
fac, _ := factory.NewFactoryFromFile("./config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 黑盒模式（推荐，自动选择OSS或MinIO）
|
||||
file, _ := os.Open("test.jpg")
|
||||
url, _ := fac.UploadFile(ctx, "images/test.jpg", file, "image/jpeg")
|
||||
|
||||
// 获取文件URL
|
||||
url, _ := fac.GetFileURL("images/test.jpg", 0) // 永久有效
|
||||
url, _ := fac.GetFileURL("images/test.jpg", 3600) // 1小时后过期
|
||||
|
||||
// 或使用存储处理器（需要HTTP处理器时）
|
||||
storage, _ := storage.NewStorage(storage.StorageTypeOSS, cfg)
|
||||
uploadHandler := storage.NewUploadHandler(...)
|
||||
```
|
||||
|
||||
#### 邮件发送（推荐使用工厂黑盒模式）
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
fac, _ := factory.NewFactoryFromFile("./config.json")
|
||||
|
||||
// 黑盒模式（推荐）
|
||||
fac.SendEmail([]string{"user@example.com"}, "主题", "正文")
|
||||
fac.SendEmail([]string{"user@example.com"}, "主题", "纯文本", "<h1>HTML内容</h1>")
|
||||
|
||||
// 或获取客户端对象（需要高级功能时）
|
||||
emailClient, _ := fac.GetEmailClient()
|
||||
emailClient.SendSimple(...)
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
str := fac.FormatDateTime(now)
|
||||
```
|
||||
|
||||
#### 短信发送（推荐使用工厂黑盒模式）
|
||||
**或者直接使用 tools 包：**
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
import "git.toowon.com/jimmy/go-common/tools"
|
||||
|
||||
fac, _ := factory.NewFactoryFromFile("./config.json")
|
||||
|
||||
// 黑盒模式（推荐）
|
||||
fac.SendSMS([]string{"13800138000"}, map[string]string{"code": "123456"})
|
||||
|
||||
// 或获取客户端对象（需要高级功能时）
|
||||
smsClient, _ := fac.GetSMSClient()
|
||||
smsClient.SendSimple(...)
|
||||
tools.SetDefaultTimeZone(tools.AsiaShanghai)
|
||||
now := tools.Now()
|
||||
str := tools.FormatDateTime(now)
|
||||
```
|
||||
|
||||
#### 使用工厂（黑盒模式，推荐）
|
||||
```go
|
||||
import (
|
||||
"context"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
// 从配置文件创建工厂（最推荐）
|
||||
fac, _ := factory.NewFactoryFromFile("./config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 日志（黑盒模式，直接调用）
|
||||
fac.LogInfo("用户登录成功")
|
||||
fac.LogError("登录失败: %v", err)
|
||||
|
||||
// 邮件发送（黑盒模式，直接调用）
|
||||
fac.SendEmail([]string{"user@example.com"}, "验证码", "您的验证码是：123456")
|
||||
|
||||
// 短信发送（黑盒模式，直接调用）
|
||||
fac.SendSMS([]string{"13800138000"}, map[string]string{"code": "123456"})
|
||||
|
||||
// 文件上传（黑盒模式，自动选择OSS或MinIO）
|
||||
file, _ := os.Open("test.jpg")
|
||||
url, _ := fac.UploadFile(ctx, "images/test.jpg", file, "image/jpeg")
|
||||
|
||||
// 获取文件URL
|
||||
url, _ := fac.GetFileURL("images/test.jpg", 0) // 永久有效
|
||||
url, _ := fac.GetFileURL("images/test.jpg", 3600) // 1小时后过期
|
||||
|
||||
// Redis操作（黑盒模式，直接调用）
|
||||
fac.RedisSet(ctx, "key", "value", time.Hour)
|
||||
value, _ := fac.RedisGet(ctx, "key")
|
||||
fac.RedisDelete(ctx, "key")
|
||||
|
||||
// 数据库（黑盒模式，获取已初始化对象）
|
||||
db, _ := fac.GetDatabase()
|
||||
db.Find(&users)
|
||||
|
||||
// Redis客户端（黑盒模式，获取已初始化对象）
|
||||
redisClient, _ := fac.GetRedisClient()
|
||||
redisClient.HGet(ctx, "key", "field").Result()
|
||||
```
|
||||
|
||||
更多示例请查看 [examples](./examples/) 目录。
|
||||
更多示例：[examples目录](./examples/)
|
||||
|
||||
## 版本管理
|
||||
|
||||
@@ -450,175 +343,40 @@ go get git.toowon.com/jimmy/go-common@v1.0.0
|
||||
|
||||
**详细版本管理说明请参考 [VERSION.md](./VERSION.md)**
|
||||
|
||||
## 设计理念
|
||||
|
||||
### 1. 黑盒模式 - 减少重复代码
|
||||
|
||||
**问题**：传统方式需要在每个项目中重复编写初始化代码
|
||||
|
||||
```go
|
||||
// ❌ 传统方式 - 需要在每个项目中重复
|
||||
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxOpenConns(100)
|
||||
sqlDB.SetMaxIdleConns(10)
|
||||
// ... 更多配置
|
||||
```
|
||||
|
||||
**解决**：工厂黑盒模式 - 配置文件搞定一切
|
||||
|
||||
```go
|
||||
// ✅ 黑盒模式 - 一行代码搞定
|
||||
db, _ := factory.NewFactoryFromFile("config.json").GetDatabase()
|
||||
```
|
||||
|
||||
### 2. Handler模式 - 统一请求处理
|
||||
|
||||
**问题**：每个处理器都要传递 `w` 和 `r`
|
||||
|
||||
```go
|
||||
// ❌ 传统方式
|
||||
func GetUser(w http.ResponseWriter, r *http.Request) {
|
||||
id := r.URL.Query().Get("id")
|
||||
json.NewEncoder(w).Encode(data)
|
||||
}
|
||||
```
|
||||
|
||||
**解决**：Handler封装 - 简洁优雅
|
||||
|
||||
```go
|
||||
// ✅ Handler模式
|
||||
func GetUser(h *commonhttp.Handler) {
|
||||
id := h.GetQueryInt64("id", 0)
|
||||
h.Success(data)
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 中间件链 - 灵活组合
|
||||
|
||||
**问题**：中间件嵌套难以维护
|
||||
|
||||
```go
|
||||
// ❌ 传统方式 - 嵌套地狱
|
||||
handler := corsMiddleware(
|
||||
timezoneMiddleware(
|
||||
loggingMiddleware(
|
||||
yourHandler
|
||||
)
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
**解决**：链式调用 - 清晰明了
|
||||
|
||||
```go
|
||||
// ✅ 链式组合
|
||||
chain := middleware.NewChain(
|
||||
middleware.CORS(),
|
||||
middleware.Timezone,
|
||||
middleware.Logging(nil),
|
||||
)
|
||||
handler := chain.ThenFunc(yourHandler)
|
||||
```
|
||||
|
||||
## 最佳实践
|
||||
|
||||
### ✅ 推荐做法
|
||||
|
||||
1. **使用工厂模式**：通过配置文件统一管理所有服务
|
||||
2. **使用异步日志**：生产环境开启 `Async: true`
|
||||
3. **配置Recovery中间件**：防止panic导致服务崩溃
|
||||
4. **合理设置限流**：根据实际业务设置限流阈值
|
||||
5. **使用时区中间件**：统一管理时区，避免时间错乱
|
||||
|
||||
### ❌ 避免做法
|
||||
|
||||
1. **不要在循环中创建logger**：使用全局logger或工厂模式
|
||||
2. **不要跳过健康检查日志**：高频接口应该配置 `SkipPaths`
|
||||
3. **不要使用同步日志记录大量日志**：高并发场景使用异步模式
|
||||
4. **不要在生产环境使用 `CORS: *`**：明确指定允许的源
|
||||
|
||||
## 性能优化建议
|
||||
|
||||
### 日志优化
|
||||
|
||||
```go
|
||||
// ✅ 异步模式 - 高并发场景
|
||||
loggerConfig := &config.LoggerConfig{
|
||||
Async: true, // 异步写入
|
||||
BufferSize: 1000, // 缓冲区大小
|
||||
}
|
||||
|
||||
// ✅ 跳过高频接口
|
||||
loggingConfig := &middleware.LoggingConfig{
|
||||
SkipPaths: []string{"/health", "/metrics", "/ping"},
|
||||
}
|
||||
```
|
||||
|
||||
### 中间件顺序优化
|
||||
|
||||
```go
|
||||
// ✅ 推荐顺序（从外到内）
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(cfg), // 1. 最外层捕获panic
|
||||
middleware.Logging(cfg), // 2. 记录所有请求
|
||||
middleware.RateLimit(cfg), // 3. 限流保护
|
||||
middleware.CORS(cfg), // 4. CORS处理
|
||||
middleware.Timezone, // 5. 时区处理
|
||||
)
|
||||
```
|
||||
|
||||
### 数据库连接池优化
|
||||
|
||||
### 生产环境配置
|
||||
```json
|
||||
{
|
||||
"logger": {
|
||||
"async": true, // 开启异步日志
|
||||
"bufferSize": 1000
|
||||
},
|
||||
"database": {
|
||||
"maxOpenConns": 100, // 最大连接数
|
||||
"maxIdleConns": 10, // 最大空闲连接
|
||||
"connMaxLifetime": 3600 // 连接最大生存时间（秒）
|
||||
"maxOpenConns": 100, // 连接池配置
|
||||
"maxIdleConns": 10,
|
||||
"connMaxLifetime": 3600
|
||||
},
|
||||
"rateLimit": {
|
||||
"enable": true, // 开启限流
|
||||
"rate": 100,
|
||||
"period": 60,
|
||||
"byIP": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 使用建议
|
||||
- ✅ 使用工厂黑盒模式，减少重复代码
|
||||
- ✅ 生产环境开启异步日志和限流
|
||||
- ✅ 配置Recovery中间件防止panic
|
||||
- ✅ 明确指定CORS允许的源
|
||||
- ❌ 避免在循环中创建logger
|
||||
- ❌ 避免使用同步日志记录大量日志
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 问题1：循环导入错误
|
||||
|
||||
**错误**：`import cycle not allowed`
|
||||
|
||||
**解决**：使用 `middleware.NewCORSConfig()` 转换配置
|
||||
|
||||
```go
|
||||
configCORS := cfg.GetCORS()
|
||||
middlewareCORS := middleware.NewCORSConfig(
|
||||
configCORS.AllowedOrigins,
|
||||
configCORS.AllowedMethods,
|
||||
configCORS.AllowedHeaders,
|
||||
configCORS.ExposedHeaders,
|
||||
configCORS.AllowCredentials,
|
||||
configCORS.MaxAge,
|
||||
)
|
||||
```
|
||||
|
||||
### 问题2：IDE显示导入错误
|
||||
|
||||
**错误**：`could not import git.toowon.com/jimmy/go-common/logger`
|
||||
|
||||
**解决**：重置Go模块缓存
|
||||
|
||||
```bash
|
||||
go clean -modcache
|
||||
go mod download
|
||||
# 重启IDE的Language Server
|
||||
```
|
||||
|
||||
### 问题3：限流不生效
|
||||
|
||||
**原因**：分布式部署下，内存存储只在单机生效
|
||||
|
||||
**解决**：分布式场景建议使用Redis实现限流
|
||||
|
||||
更多问题请查看 [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
|
||||
常见问题请查看 [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
|
||||
|
||||
## 贡献指南
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@ type Config struct {
|
||||
Email *EmailConfig `json:"email"`
|
||||
SMS *SMSConfig `json:"sms"`
|
||||
Logger *LoggerConfig `json:"logger"`
|
||||
RateLimit *RateLimitConfig `json:"rateLimit"`
|
||||
}
|
||||
|
||||
// DatabaseConfig 数据库配置
|
||||
@@ -244,6 +245,24 @@ type LoggerConfig struct {
|
||||
BufferSize int `json:"bufferSize"`
|
||||
}
|
||||
|
||||
// RateLimitConfig 限流配置
|
||||
type RateLimitConfig struct {
|
||||
// Enable 是否启用限流
|
||||
Enable bool `json:"enable"`
|
||||
|
||||
// Rate 每个时间窗口允许的请求数量
|
||||
Rate int `json:"rate"`
|
||||
|
||||
// Period 时间窗口（秒）
|
||||
Period int `json:"period"`
|
||||
|
||||
// ByIP 按IP限流
|
||||
ByIP bool `json:"byIP"`
|
||||
|
||||
// ByUserID 按用户ID限流（从X-User-ID header获取）
|
||||
ByUserID bool `json:"byUserID"`
|
||||
}
|
||||
|
||||
// LoadFromFile 从文件加载配置
|
||||
// filePath: 配置文件路径（支持绝对路径和相对路径）
|
||||
func LoadFromFile(filePath string) (*Config, error) {
|
||||
@@ -378,6 +397,19 @@ func (c *Config) setDefaults() {
|
||||
c.Logger.Output = "stdout"
|
||||
}
|
||||
}
|
||||
|
||||
// 限流默认值
|
||||
if c.RateLimit != nil {
|
||||
if c.RateLimit.Rate == 0 {
|
||||
c.RateLimit.Rate = 100 // 默认每个窗口100个请求
|
||||
}
|
||||
if c.RateLimit.Period == 0 {
|
||||
c.RateLimit.Period = 60 // 默认时间窗口60秒
|
||||
}
|
||||
if !c.RateLimit.ByIP && !c.RateLimit.ByUserID {
|
||||
c.RateLimit.ByIP = true // 默认按IP限流
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// GetDatabase 获取数据库配置
|
||||
|
||||
@@ -78,6 +78,13 @@
|
||||
"disableTimestamp": false,
|
||||
"async": false,
|
||||
"bufferSize": 1000
|
||||
},
|
||||
"rateLimit": {
|
||||
"enable": true,
|
||||
"rate": 100,
|
||||
"period": 60,
|
||||
"byIP": true,
|
||||
"byUserID": false
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -57,12 +57,24 @@ CREATE TABLE users (id BIGINT PRIMARY KEY AUTO_INCREMENT, ...);
|
||||
|
||||
#### 日期转换
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/datetime"
|
||||
**推荐方式：通过 factory 使用（黑盒模式）**
|
||||
|
||||
datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
now := datetime.Now()
|
||||
str := datetime.FormatDateTime(now)
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
str := fac.FormatDateTime(now)
|
||||
```
|
||||
|
||||
**或者直接使用 tools 包：**
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/tools"
|
||||
|
||||
tools.SetDefaultTimeZone(tools.AsiaShanghai)
|
||||
now := tools.Now()
|
||||
str := tools.FormatDateTime(now)
|
||||
```
|
||||
|
||||
#### HTTP响应（Handler黑盒模式）
|
||||
|
||||
439
docs/datetime.md
439
docs/datetime.md
@@ -4,6 +4,8 @@
|
||||
|
||||
日期转换工具提供了丰富的日期时间处理功能，支持时区设定、格式转换、时间计算等常用操作。
|
||||
|
||||
**重要说明**：日期时间功能位于 `tools` 包中，推荐通过 `factory` 包使用（黑盒模式），也可以直接使用 `tools` 包。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 支持时区设定和转换
|
||||
@@ -16,13 +18,34 @@
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 1. 设置默认时区
|
||||
### 方式1：通过 factory 使用（推荐，黑盒模式）
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/datetime"
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
// 创建工厂
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取当前时间
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
|
||||
// 格式化时间
|
||||
str := fac.FormatDateTime(now)
|
||||
|
||||
// 解析时间
|
||||
t, _ := fac.ParseDateTime("2024-01-01 12:00:00", "Asia/Shanghai")
|
||||
|
||||
// 时间计算
|
||||
tomorrow := fac.AddDays(now, 1)
|
||||
```
|
||||
|
||||
### 方式2：直接使用 tools 包
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/tools"
|
||||
|
||||
// 设置默认时区为上海时区
|
||||
err := datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
err := tools.SetDefaultTimeZone(tools.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -30,166 +53,284 @@ if err != nil {
|
||||
|
||||
### 2. 获取当前时间
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
// 使用默认时区
|
||||
now := datetime.Now()
|
||||
now := fac.Now()
|
||||
|
||||
// 使用指定时区
|
||||
now := datetime.Now(datetime.AsiaShanghai)
|
||||
now := datetime.Now("America/New_York")
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
now := fac.Now("America/New_York")
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
// 使用默认时区
|
||||
now := tools.Now()
|
||||
|
||||
// 使用指定时区
|
||||
now := tools.Now(tools.AsiaShanghai)
|
||||
now := tools.Now("America/New_York")
|
||||
```
|
||||
|
||||
### 3. 解析时间字符串
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
// 使用默认时区解析
|
||||
t, err := datetime.Parse("2006-01-02 15:04:05", "2024-01-01 12:00:00")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
t, err := fac.ParseDateTime("2024-01-01 12:00:00")
|
||||
|
||||
// 使用指定时区解析
|
||||
t, err := datetime.Parse("2006-01-02 15:04:05", "2024-01-01 12:00:00", datetime.AsiaShanghai)
|
||||
t, err := fac.ParseDateTime("2024-01-01 12:00:00", "Asia/Shanghai")
|
||||
|
||||
// 解析日期
|
||||
t, err := fac.ParseDate("2024-01-01")
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
// 使用默认时区解析
|
||||
t, err := tools.Parse("2006-01-02 15:04:05", "2024-01-01 12:00:00")
|
||||
|
||||
// 使用指定时区解析
|
||||
t, err := tools.Parse("2006-01-02 15:04:05", "2024-01-01 12:00:00", tools.AsiaShanghai)
|
||||
|
||||
// 使用常用格式解析
|
||||
t, err := datetime.ParseDateTime("2024-01-01 12:00:00")
|
||||
t, err := datetime.ParseDate("2024-01-01")
|
||||
t, err := tools.ParseDateTime("2024-01-01 12:00:00")
|
||||
t, err := tools.ParseDate("2024-01-01")
|
||||
```
|
||||
|
||||
### 4. 格式化时间
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 使用默认时区格式化
|
||||
str := datetime.Format(t, "2006-01-02 15:04:05")
|
||||
str := fac.FormatDateTime(t)
|
||||
str := fac.FormatDate(t)
|
||||
str := fac.FormatTime(t)
|
||||
|
||||
// 使用指定时区格式化
|
||||
str := datetime.Format(t, "2006-01-02 15:04:05", datetime.AsiaShanghai)
|
||||
str := fac.FormatDateTime(t, "Asia/Shanghai")
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 使用默认时区格式化
|
||||
str := tools.Format(t, "2006-01-02 15:04:05")
|
||||
|
||||
// 使用指定时区格式化
|
||||
str := tools.Format(t, "2006-01-02 15:04:05", tools.AsiaShanghai)
|
||||
|
||||
// 使用常用格式
|
||||
str := datetime.FormatDateTime(t) // "2006-01-02 15:04:05"
|
||||
str := datetime.FormatDate(t) // "2006-01-02"
|
||||
str := datetime.FormatTime(t) // "15:04:05"
|
||||
str := tools.FormatDateTime(t) // "2006-01-02 15:04:05"
|
||||
str := tools.FormatDate(t) // "2006-01-02"
|
||||
str := tools.FormatTime(t) // "15:04:05"
|
||||
```
|
||||
|
||||
### 5. 时区转换
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t := time.Now()
|
||||
t2, err := tools.ToTimezone(t, "Asia/Shanghai")
|
||||
```
|
||||
|
||||
// 转换到指定时区
|
||||
t2, err := datetime.ToTimezone(t, datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t := time.Now()
|
||||
t2, err := tools.ToTimezone(t, tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
### 6. Unix时间戳转换
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 转换为Unix时间戳（秒）
|
||||
unix := datetime.ToUnix(t)
|
||||
unix := fac.ToUnix(t)
|
||||
|
||||
// 从Unix时间戳创建时间
|
||||
t2 := datetime.FromUnix(unix)
|
||||
t2 := fac.FromUnix(unix)
|
||||
|
||||
// 转换为Unix毫秒时间戳
|
||||
unixMilli := datetime.ToUnixMilli(t)
|
||||
unixMilli := fac.ToUnixMilli(t)
|
||||
|
||||
// 从Unix毫秒时间戳创建时间
|
||||
t3 := datetime.FromUnixMilli(unixMilli)
|
||||
t3 := fac.FromUnixMilli(unixMilli)
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 转换为Unix时间戳（秒）
|
||||
unix := tools.ToUnix(t)
|
||||
|
||||
// 从Unix时间戳创建时间
|
||||
t2 := tools.FromUnix(unix)
|
||||
|
||||
// 转换为Unix毫秒时间戳
|
||||
unixMilli := tools.ToUnixMilli(t)
|
||||
|
||||
// 从Unix毫秒时间戳创建时间
|
||||
t3 := tools.FromUnixMilli(unixMilli)
|
||||
```
|
||||
|
||||
### 7. 时间计算
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 添加天数
|
||||
t1 := datetime.AddDays(t, 7)
|
||||
t1 := fac.AddDays(t, 7)
|
||||
|
||||
// 添加月数
|
||||
t2 := datetime.AddMonths(t, 1)
|
||||
t2 := fac.AddMonths(t, 1)
|
||||
|
||||
// 添加年数
|
||||
t3 := datetime.AddYears(t, 1)
|
||||
t3 := fac.AddYears(t, 1)
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 添加天数
|
||||
t1 := tools.AddDays(t, 7)
|
||||
|
||||
// 添加月数
|
||||
t2 := tools.AddMonths(t, 1)
|
||||
|
||||
// 添加年数
|
||||
t3 := tools.AddYears(t, 1)
|
||||
```
|
||||
|
||||
### 8. 时间范围获取
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 获取一天的开始时间（00:00:00）
|
||||
start := datetime.StartOfDay(t)
|
||||
start := fac.StartOfDay(t)
|
||||
|
||||
// 获取一天的结束时间（23:59:59.999999999）
|
||||
end := datetime.EndOfDay(t)
|
||||
end := fac.EndOfDay(t)
|
||||
|
||||
// 获取月份的开始时间
|
||||
monthStart := datetime.StartOfMonth(t)
|
||||
monthStart := fac.StartOfMonth(t)
|
||||
|
||||
// 获取月份的结束时间
|
||||
monthEnd := datetime.EndOfMonth(t)
|
||||
monthEnd := fac.EndOfMonth(t)
|
||||
|
||||
// 获取年份的开始时间
|
||||
yearStart := datetime.StartOfYear(t)
|
||||
yearStart := fac.StartOfYear(t)
|
||||
|
||||
// 获取年份的结束时间
|
||||
yearEnd := datetime.EndOfYear(t)
|
||||
yearEnd := fac.EndOfYear(t)
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t := time.Now()
|
||||
|
||||
// 获取一天的开始时间（00:00:00）
|
||||
start := tools.StartOfDay(t)
|
||||
|
||||
// 获取一天的结束时间（23:59:59.999999999）
|
||||
end := tools.EndOfDay(t)
|
||||
|
||||
// 获取月份的开始时间
|
||||
monthStart := tools.StartOfMonth(t)
|
||||
|
||||
// 获取月份的结束时间
|
||||
monthEnd := tools.EndOfMonth(t)
|
||||
|
||||
// 获取年份的开始时间
|
||||
yearStart := tools.StartOfYear(t)
|
||||
|
||||
// 获取年份的结束时间
|
||||
yearEnd := tools.EndOfYear(t)
|
||||
```
|
||||
|
||||
### 9. 时间差计算
|
||||
|
||||
**通过 factory：**
|
||||
```go
|
||||
t1 := time.Now()
|
||||
t2 := time.Now().Add(24 * time.Hour)
|
||||
|
||||
// 计算天数差
|
||||
days := datetime.DiffDays(t1, t2)
|
||||
days := fac.DiffDays(t1, t2)
|
||||
|
||||
// 计算小时差
|
||||
hours := datetime.DiffHours(t1, t2)
|
||||
hours := fac.DiffHours(t1, t2)
|
||||
|
||||
// 计算分钟差
|
||||
minutes := datetime.DiffMinutes(t1, t2)
|
||||
minutes := fac.DiffMinutes(t1, t2)
|
||||
|
||||
// 计算秒数差
|
||||
seconds := datetime.DiffSeconds(t1, t2)
|
||||
seconds := fac.DiffSeconds(t1, t2)
|
||||
```
|
||||
|
||||
**直接使用 tools：**
|
||||
```go
|
||||
t1 := time.Now()
|
||||
t2 := time.Now().Add(24 * time.Hour)
|
||||
|
||||
// 计算天数差
|
||||
days := tools.DiffDays(t1, t2)
|
||||
|
||||
// 计算小时差
|
||||
hours := tools.DiffHours(t1, t2)
|
||||
|
||||
// 计算分钟差
|
||||
minutes := tools.DiffMinutes(t1, t2)
|
||||
|
||||
// 计算秒数差
|
||||
seconds := tools.DiffSeconds(t1, t2)
|
||||
```
|
||||
|
||||
### 10. 转换为UTC时间（用于数据库存储）
|
||||
|
||||
**直接使用 tools（factory 暂未提供）：**
|
||||
```go
|
||||
// 将任意时区的时间转换为UTC
|
||||
t := time.Now() // 当前时区的时间
|
||||
utcTime := datetime.ToUTC(t)
|
||||
utcTime := tools.ToUTC(t)
|
||||
|
||||
// 从指定时区转换为UTC
|
||||
t, _ := datetime.ParseDateTime("2024-01-01 12:00:00", datetime.AsiaShanghai)
|
||||
utcTime, err := datetime.ToUTCFromTimezone(t, datetime.AsiaShanghai)
|
||||
t, _ := tools.ParseDateTime("2024-01-01 12:00:00", tools.AsiaShanghai)
|
||||
utcTime, err := tools.ToUTCFromTimezone(t, tools.AsiaShanghai)
|
||||
|
||||
// 解析时间字符串并直接转换为UTC
|
||||
utcTime, err := datetime.ParseDateTimeToUTC("2024-01-01 12:00:00", datetime.AsiaShanghai)
|
||||
utcTime, err := tools.ParseDateTimeToUTC("2024-01-01 12:00:00", tools.AsiaShanghai)
|
||||
|
||||
// 解析日期并转换为UTC（当天的00:00:00 UTC）
|
||||
utcTime, err := datetime.ParseDateToUTC("2024-01-01", datetime.AsiaShanghai)
|
||||
utcTime, err := tools.ParseDateToUTC("2024-01-01", tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
## API 参考
|
||||
|
||||
### 时区常量
|
||||
|
||||
**通过 tools 包使用：**
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/tools"
|
||||
|
||||
const (
|
||||
UTC = "UTC"
|
||||
AsiaShanghai = "Asia/Shanghai"
|
||||
AmericaNewYork = "America/New_York"
|
||||
EuropeLondon = "Europe/London"
|
||||
AsiaTokyo = "Asia/Tokyo"
|
||||
tools.UTC = "UTC"
|
||||
tools.AsiaShanghai = "Asia/Shanghai"
|
||||
tools.AmericaNewYork = "America/New_York"
|
||||
tools.EuropeLondon = "Europe/London"
|
||||
tools.AsiaTokyo = "Asia/Tokyo"
|
||||
)
|
||||
```
|
||||
|
||||
@@ -208,15 +349,22 @@ CommonLayouts.RFC3339Nano = time.RFC3339Nano
|
||||
|
||||
### 主要函数
|
||||
|
||||
**注意**：以下函数可以通过 `factory` 或 `tools` 包调用。推荐使用 `factory` 的黑盒模式。
|
||||
|
||||
#### SetDefaultTimeZone(timezone string) error
|
||||
|
||||
设置默认时区。
|
||||
设置默认时区（仅 tools 包提供）。
|
||||
|
||||
**参数：**
|
||||
- `timezone`: 时区字符串，如 "Asia/Shanghai"
|
||||
|
||||
**返回：** 错误信息
|
||||
|
||||
**使用方式：**
|
||||
```go
|
||||
tools.SetDefaultTimeZone(tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
#### Now(timezone ...string) time.Time
|
||||
|
||||
获取当前时间。
|
||||
@@ -226,105 +374,54 @@ CommonLayouts.RFC3339Nano = time.RFC3339Nano
|
||||
|
||||
**返回：** 时间对象
|
||||
|
||||
#### Parse(layout, value string, timezone ...string) (time.Time, error)
|
||||
**使用方式：**
|
||||
```go
|
||||
// 通过 factory
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
|
||||
解析时间字符串。
|
||||
// 直接使用 tools
|
||||
now := tools.Now(tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
#### ParseDateTime(value string, timezone ...string) (time.Time, error)
|
||||
|
||||
解析日期时间字符串（2006-01-02 15:04:05）。
|
||||
|
||||
**参数：**
|
||||
- `layout`: 时间格式，如 "2006-01-02 15:04:05"
|
||||
- `value`: 时间字符串
|
||||
- `timezone`: 可选，时区字符串
|
||||
|
||||
**返回：** 时间对象和错误信息
|
||||
|
||||
#### Format(t time.Time, layout string, timezone ...string) string
|
||||
**使用方式：**
|
||||
```go
|
||||
// 通过 factory
|
||||
t, err := fac.ParseDateTime("2024-01-01 12:00:00", "Asia/Shanghai")
|
||||
|
||||
格式化时间。
|
||||
// 直接使用 tools
|
||||
t, err := tools.ParseDateTime("2024-01-01 12:00:00", tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
#### FormatDateTime(t time.Time, timezone ...string) string
|
||||
|
||||
格式化日期时间（2006-01-02 15:04:05）。
|
||||
|
||||
**参数：**
|
||||
- `t`: 时间对象
|
||||
- `layout`: 时间格式
|
||||
- `timezone`: 可选，时区字符串
|
||||
|
||||
**返回：** 格式化后的时间字符串
|
||||
|
||||
#### ToTimezone(t time.Time, timezone string) (time.Time, error)
|
||||
**使用方式：**
|
||||
```go
|
||||
// 通过 factory
|
||||
str := fac.FormatDateTime(t, "Asia/Shanghai")
|
||||
|
||||
转换时区。
|
||||
// 直接使用 tools
|
||||
str := tools.FormatDateTime(t, tools.AsiaShanghai)
|
||||
```
|
||||
|
||||
**参数：**
|
||||
- `t`: 时间对象
|
||||
- `timezone`: 目标时区
|
||||
|
||||
**返回：** 转换后的时间对象和错误信息
|
||||
|
||||
#### ToUnix(t time.Time) int64
|
||||
|
||||
转换为Unix时间戳（秒）。
|
||||
|
||||
#### FromUnix(sec int64, timezone ...string) time.Time
|
||||
|
||||
从Unix时间戳创建时间。
|
||||
|
||||
#### ToUnixMilli(t time.Time) int64
|
||||
|
||||
转换为Unix毫秒时间戳。
|
||||
|
||||
#### FromUnixMilli(msec int64, timezone ...string) time.Time
|
||||
|
||||
从Unix毫秒时间戳创建时间。
|
||||
|
||||
#### AddDays(t time.Time, days int) time.Time
|
||||
|
||||
添加天数。
|
||||
|
||||
#### AddMonths(t time.Time, months int) time.Time
|
||||
|
||||
添加月数。
|
||||
|
||||
#### AddYears(t time.Time, years int) time.Time
|
||||
|
||||
添加年数。
|
||||
|
||||
#### StartOfDay(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取一天的开始时间。
|
||||
|
||||
#### EndOfDay(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取一天的结束时间。
|
||||
|
||||
#### StartOfMonth(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取月份的开始时间。
|
||||
|
||||
#### EndOfMonth(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取月份的结束时间。
|
||||
|
||||
#### StartOfYear(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取年份的开始时间。
|
||||
|
||||
#### EndOfYear(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取年份的结束时间。
|
||||
|
||||
#### DiffDays(t1, t2 time.Time) int
|
||||
|
||||
计算两个时间之间的天数差。
|
||||
|
||||
#### DiffHours(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的小时差。
|
||||
|
||||
#### DiffMinutes(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的分钟差。
|
||||
|
||||
#### DiffSeconds(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的秒数差。
|
||||
更多函数请参考 `factory` 包或 `tools` 包的 API 文档。
|
||||
|
||||
### UTC转换函数
|
||||
|
||||
@@ -391,7 +488,7 @@ CommonLayouts.RFC3339Nano = time.RFC3339Nano
|
||||
|
||||
## 完整示例
|
||||
|
||||
### 示例1：基本使用
|
||||
### 示例1：通过 factory 使用（推荐）
|
||||
|
||||
```go
|
||||
package main
|
||||
@@ -399,27 +496,67 @@ package main
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 创建工厂
|
||||
fac, err := factory.NewFactoryFromFile("config.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 获取当前时间
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
fmt.Printf("Current time: %s\n", fac.FormatDateTime(now))
|
||||
|
||||
// 解析时间
|
||||
t, err := fac.ParseDateTime("2024-01-01 12:00:00", "Asia/Shanghai")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 格式化时间
|
||||
fmt.Printf("Parsed time: %s\n", fac.FormatDateTime(t))
|
||||
|
||||
// 时间计算
|
||||
tomorrow := fac.AddDays(now, 1)
|
||||
fmt.Printf("Tomorrow: %s\n", fac.FormatDate(tomorrow))
|
||||
}
|
||||
```
|
||||
|
||||
### 示例2：直接使用 tools 包
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 设置默认时区
|
||||
datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
err := tools.SetDefaultTimeZone(tools.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 获取当前时间
|
||||
now := datetime.Now()
|
||||
fmt.Printf("Current time: %s\n", datetime.FormatDateTime(now))
|
||||
now := tools.Now()
|
||||
fmt.Printf("Current time: %s\n", tools.FormatDateTime(now))
|
||||
|
||||
// 时区转换
|
||||
t, _ := datetime.ParseDateTime("2024-01-01 12:00:00")
|
||||
t2, _ := datetime.ToTimezone(t, datetime.AmericaNewYork)
|
||||
fmt.Printf("Time in New York: %s\n", datetime.FormatDateTime(t2))
|
||||
t, _ := tools.ParseDateTime("2024-01-01 12:00:00")
|
||||
t2, _ := tools.ToTimezone(t, tools.AmericaNewYork)
|
||||
fmt.Printf("Time in New York: %s\n", tools.FormatDateTime(t2))
|
||||
}
|
||||
```
|
||||
|
||||
### 示例2：UTC转换（数据库存储场景）
|
||||
### 示例3：UTC转换（数据库存储场景）
|
||||
|
||||
```go
|
||||
package main
|
||||
@@ -428,34 +565,32 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 从请求中获取时间（假设是上海时区）
|
||||
requestTimeStr := "2024-01-01 12:00:00"
|
||||
requestTimezone := datetime.AsiaShanghai
|
||||
requestTimezone := tools.AsiaShanghai
|
||||
|
||||
// 转换为UTC时间（用于数据库存储）
|
||||
dbTime, err := datetime.ParseDateTimeToUTC(requestTimeStr, requestTimezone)
|
||||
dbTime, err := tools.ParseDateTimeToUTC(requestTimeStr, requestTimezone)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Printf("Request time (Shanghai): %s\n", requestTimeStr)
|
||||
fmt.Printf("Database time (UTC): %s\n", datetime.FormatDateTime(dbTime, datetime.UTC))
|
||||
fmt.Printf("Database time (UTC): %s\n", tools.FormatDateTime(dbTime, tools.UTC))
|
||||
|
||||
// 从数据库读取UTC时间，转换为用户时区显示
|
||||
userTimezone := datetime.AsiaShanghai
|
||||
displayTime, err := datetime.ToTimezone(dbTime, userTimezone)
|
||||
userTimezone := tools.AsiaShanghai
|
||||
displayTime, err := tools.ToTimezone(dbTime, userTimezone)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Display time (Shanghai): %s\n", datetime.FormatDateTime(displayTime, userTimezone))
|
||||
fmt.Printf("Display time (Shanghai): %s\n", tools.FormatDateTime(displayTime, userTimezone))
|
||||
}
|
||||
```
|
||||
|
||||
完整示例请参考：
|
||||
- `examples/datetime_example.go` - 基本使用示例
|
||||
- `examples/datetime_utc_example.go` - UTC转换示例
|
||||
完整示例请参考 `factory` 包中的 datetime 相关方法，通过 `factory` 调用 `tools` 包中的 datetime 功能。
|
||||
|
||||
|
||||
631
docs/factory.md
631
docs/factory.md
@@ -12,6 +12,38 @@
|
||||
- **统一接口**：所有操作通过工厂方法调用
|
||||
- **向后兼容**：保留 `GetXXX()` 方法，需要时可获取对象
|
||||
|
||||
## 方法分类总览
|
||||
|
||||
### 🌟 推荐使用：黑盒方法（一行代码搞定）
|
||||
|
||||
外部项目直接调用，无需获取内部对象：
|
||||
|
||||
| 功能 | 方法 | 示例 |
|
||||
|------|------|------|
|
||||
| **中间件** | `GetMiddlewareChain()` | `chain := fac.GetMiddlewareChain()` |
|
||||
| **日志** | `LogInfo()`, `LogError()` 等 | `fac.LogInfo("用户登录")` |
|
||||
| **Redis** | `RedisSet()`, `RedisGet()` 等 | `fac.RedisSet(ctx, "key", "val", time.Hour)` |
|
||||
| **邮件** | `SendEmail()` | `fac.SendEmail(to, subject, body)` |
|
||||
| **短信** | `SendSMS()` | `fac.SendSMS(phones, params)` |
|
||||
| **存储** | `UploadFile()`, `GetFileURL()` | `fac.UploadFile(ctx, key, file)` |
|
||||
| **日期时间** | `Now()`, `ParseDateTime()`, `FormatDateTime()` 等 | `fac.Now("Asia/Shanghai")` |
|
||||
| **时间工具** | `GetTimestamp()`, `IsToday()`, `GetBeginOfWeek()` 等 | `fac.GetTimestamp()` |
|
||||
| **加密工具** | `HashPassword()`, `MD5()`, `SHA256()`, `GenerateSMSCode()` 等 | `fac.HashPassword("password")` |
|
||||
| **金额计算** | `YuanToCents()`, `CentsToYuan()`, `FormatYuan()` | `fac.YuanToCents(100.5)` |
|
||||
| **版本信息** | `GetVersion()` | `fac.GetVersion()` |
|
||||
| **HTTP响应** | `Success()`, `Error()`, `SuccessPage()` | `fac.Success(w, data)` |
|
||||
| **HTTP请求** | `ParseJSON()`, `GetQuery()`, `GetTimezone()` 等 | `fac.ParseJSON(r, &req)` |
|
||||
|
||||
### 🔧 高级功能：Get方法（仅在必要时使用）
|
||||
|
||||
返回客户端对象，用于复杂操作：
|
||||
|
||||
| 方法 | 返回类型 | 使用场景 |
|
||||
|------|----------|----------|
|
||||
| `GetDatabase()` | `*gorm.DB` | 数据库复杂查询、事务、关联查询等 |
|
||||
| `GetRedisClient()` | `*redis.Client` | Hash、List、Set、ZSet、Pub/Sub等高级操作 |
|
||||
| `GetLogger()` | `*logger.Logger` | Close()、设置全局logger等 |
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 1. 创建工厂（推荐）
|
||||
@@ -151,7 +183,120 @@ db.Find(&users)
|
||||
db.Create(&user)
|
||||
```
|
||||
|
||||
### 8. Redis操作（获取客户端对象）
|
||||
### 8. 日期时间操作（黑盒模式）
|
||||
|
||||
```go
|
||||
// 获取当前时间
|
||||
now := fac.Now("Asia/Shanghai")
|
||||
|
||||
// 解析时间
|
||||
t, _ := fac.ParseDateTime("2024-01-01 12:00:00", "Asia/Shanghai")
|
||||
|
||||
// 格式化时间
|
||||
str := fac.FormatDateTime(now)
|
||||
|
||||
// 时间计算
|
||||
tomorrow := fac.AddDays(now, 1)
|
||||
startOfDay := fac.StartOfDay(now, "Asia/Shanghai")
|
||||
endOfDay := fac.EndOfDay(now, "Asia/Shanghai")
|
||||
|
||||
// Unix时间戳
|
||||
unix := fac.ToUnix(now)
|
||||
t2 := fac.FromUnix(unix, "Asia/Shanghai")
|
||||
```
|
||||
|
||||
### 9. 时间操作（黑盒模式）
|
||||
|
||||
```go
|
||||
// 时间戳
|
||||
timestamp := fac.GetTimestamp() // 当前时间戳（秒）
|
||||
millisTimestamp := fac.GetMillisTimestamp() // 当前时间戳（毫秒）
|
||||
utcTimestamp := fac.GetUTCTimestamp() // UTC时间戳
|
||||
|
||||
// 自定义格式格式化
|
||||
str := fac.FormatTimeWithLayout(now, "2006年01月02日 15:04:05")
|
||||
|
||||
// 自定义格式解析
|
||||
t, _ := fac.ParseTime("2024-01-01 12:00:00", "2006-01-02 15:04:05")
|
||||
|
||||
// 时间计算（补充）
|
||||
nextHour := fac.AddHours(now, 1)
|
||||
nextMinute := fac.AddMinutes(now, 30)
|
||||
|
||||
// 周相关
|
||||
beginOfWeek := fac.GetBeginOfWeek(now)
|
||||
endOfWeek := fac.GetEndOfWeek(now)
|
||||
|
||||
// 时间判断
|
||||
if fac.IsToday(t) {
|
||||
fmt.Println("是今天")
|
||||
}
|
||||
if fac.IsYesterday(t) {
|
||||
fmt.Println("是昨天")
|
||||
}
|
||||
|
||||
// 生成详细时间信息
|
||||
timeInfo := fac.GenerateTimeInfoWithTimezone(now, "Asia/Shanghai")
|
||||
fmt.Printf("UTC: %s, Local: %s, Unix: %d\n", timeInfo.UTC, timeInfo.Local, timeInfo.Unix)
|
||||
```
|
||||
|
||||
### 10. 金额计算（黑盒模式）
|
||||
|
||||
```go
|
||||
// 元转分
|
||||
cents := fac.YuanToCents(100.5) // 10050
|
||||
|
||||
// 分转元
|
||||
yuan := fac.CentsToYuan(10050) // 100.5
|
||||
|
||||
// 格式化显示
|
||||
str := fac.FormatYuan(10050) // "100.50"
|
||||
```
|
||||
|
||||
### 12. 版本信息（黑盒模式）
|
||||
|
||||
```go
|
||||
version := fac.GetVersion()
|
||||
fmt.Println("当前版本:", version)
|
||||
```
|
||||
|
||||
### 13. HTTP响应（黑盒模式）
|
||||
|
||||
```go
|
||||
import "net/http"
|
||||
|
||||
// 成功响应
|
||||
fac.Success(w, data)
|
||||
fac.Success(w, data, "操作成功")
|
||||
|
||||
// 分页响应
|
||||
fac.SuccessPage(w, users, total, page, pageSize)
|
||||
|
||||
// 错误响应
|
||||
fac.Error(w, 1001, "用户不存在")
|
||||
fac.SystemError(w, "系统错误")
|
||||
```
|
||||
|
||||
### 14. HTTP请求解析（黑盒模式）
|
||||
|
||||
```go
|
||||
import "net/http"
|
||||
|
||||
// 解析JSON
|
||||
var req UserRequest
|
||||
fac.ParseJSON(r, &req)
|
||||
|
||||
// 获取查询参数
|
||||
id := fac.GetQueryInt64(r, "id", 0)
|
||||
uid := fac.GetQueryUint64(r, "uid", 0)
|
||||
userId := fac.GetQueryUint32(r, "user_id", 0)
|
||||
keyword := fac.GetQuery(r, "keyword", "")
|
||||
|
||||
// 获取时区（需要配合middleware.Timezone使用）
|
||||
timezone := fac.GetTimezone(r)
|
||||
```
|
||||
|
||||
### 15. Redis操作（获取客户端对象）
|
||||
|
||||
```go
|
||||
import (
|
||||
@@ -456,6 +601,490 @@ func main() {
|
||||
|
||||
**返回：** 配置对象
|
||||
|
||||
### HTTP响应方法（黑盒模式）
|
||||
|
||||
#### Success(w http.ResponseWriter, data interface{}, message ...string)
|
||||
|
||||
发送成功响应。
|
||||
|
||||
**参数：**
|
||||
- `w`: HTTP响应写入器
|
||||
- `data`: 响应数据
|
||||
- `message`: 可选，成功消息（如果不提供，使用默认消息）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
fac.Success(w, user) // 使用默认消息
|
||||
fac.Success(w, user, "获取成功") // 自定义消息
|
||||
```
|
||||
|
||||
#### Error(w http.ResponseWriter, code int, message string)
|
||||
|
||||
发送错误响应。
|
||||
|
||||
**参数：**
|
||||
- `w`: HTTP响应写入器
|
||||
- `code`: 业务错误码
|
||||
- `message`: 错误消息
|
||||
|
||||
#### SystemError(w http.ResponseWriter, message string)
|
||||
|
||||
发送系统错误响应（HTTP 500）。
|
||||
|
||||
**参数：**
|
||||
- `w`: HTTP响应写入器
|
||||
- `message`: 错误消息
|
||||
|
||||
#### SuccessPage(w http.ResponseWriter, data interface{}, total int64, page, pageSize int, message ...string)
|
||||
|
||||
发送分页成功响应。
|
||||
|
||||
**参数：**
|
||||
- `w`: HTTP响应写入器
|
||||
- `data`: 响应数据列表
|
||||
- `total`: 总记录数
|
||||
- `page`: 当前页码
|
||||
- `pageSize`: 每页大小
|
||||
- `message`: 可选，成功消息
|
||||
|
||||
### HTTP请求方法（黑盒模式）
|
||||
|
||||
#### ParseJSON(r *http.Request, v interface{}) error
|
||||
|
||||
解析JSON请求体。
|
||||
|
||||
**参数：**
|
||||
- `r`: HTTP请求
|
||||
- `v`: 目标结构体指针
|
||||
|
||||
#### GetQuery(r *http.Request, key, defaultValue string) string
|
||||
|
||||
获取查询参数。
|
||||
|
||||
#### GetQueryInt(r *http.Request, key string, defaultValue int) int
|
||||
|
||||
获取查询整数参数。
|
||||
|
||||
#### GetQueryInt64(r *http.Request, key string, defaultValue int64) int64
|
||||
|
||||
获取查询64位整数参数。
|
||||
|
||||
#### GetQueryUint64(r *http.Request, key string, defaultValue uint64) uint64
|
||||
|
||||
获取查询64位无符号整数参数。
|
||||
|
||||
#### GetQueryUint32(r *http.Request, key string, defaultValue uint32) uint32
|
||||
|
||||
获取查询32位无符号整数参数。
|
||||
|
||||
#### GetFormValue(r *http.Request, key, defaultValue string) string
|
||||
|
||||
获取表单值。
|
||||
|
||||
#### GetTimezone(r *http.Request) string
|
||||
|
||||
从请求的context中获取时区（需要配合middleware.Timezone使用）。
|
||||
|
||||
### 日期时间工具方法（黑盒模式）
|
||||
|
||||
#### Now(timezone ...string) time.Time
|
||||
|
||||
获取当前时间。
|
||||
|
||||
**参数：**
|
||||
- `timezone`: 可选，时区字符串（如 "Asia/Shanghai"），不指定则使用默认时区
|
||||
|
||||
#### ParseDateTime(value string, timezone ...string) (time.Time, error)
|
||||
|
||||
解析日期时间字符串（格式：2006-01-02 15:04:05）。
|
||||
|
||||
#### ParseDate(value string, timezone ...string) (time.Time, error)
|
||||
|
||||
解析日期字符串（格式：2006-01-02）。
|
||||
|
||||
#### FormatDateTime(t time.Time, timezone ...string) string
|
||||
|
||||
格式化日期时间（格式：2006-01-02 15:04:05）。
|
||||
|
||||
#### FormatDate(t time.Time, timezone ...string) string
|
||||
|
||||
格式化日期（格式：2006-01-02）。
|
||||
|
||||
#### FormatTime(t time.Time, timezone ...string) string
|
||||
|
||||
格式化时间（格式：15:04:05）。
|
||||
|
||||
#### ToUnix(t time.Time) int64
|
||||
|
||||
转换为Unix时间戳（秒）。
|
||||
|
||||
#### FromUnix(sec int64, timezone ...string) time.Time
|
||||
|
||||
从Unix时间戳创建时间。
|
||||
|
||||
#### ToUnixMilli(t time.Time) int64
|
||||
|
||||
转换为Unix毫秒时间戳。
|
||||
|
||||
#### FromUnixMilli(msec int64, timezone ...string) time.Time
|
||||
|
||||
从Unix毫秒时间戳创建时间。
|
||||
|
||||
#### AddDays(t time.Time, days int) time.Time
|
||||
|
||||
添加天数。
|
||||
|
||||
#### AddMonths(t time.Time, months int) time.Time
|
||||
|
||||
添加月数。
|
||||
|
||||
#### AddYears(t time.Time, years int) time.Time
|
||||
|
||||
添加年数。
|
||||
|
||||
#### StartOfDay(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取一天的开始时间（00:00:00）。
|
||||
|
||||
#### EndOfDay(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取一天的结束时间（23:59:59.999999999）。
|
||||
|
||||
#### StartOfMonth(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取月份的开始时间。
|
||||
|
||||
#### EndOfMonth(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取月份的结束时间。
|
||||
|
||||
#### StartOfYear(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取年份的开始时间。
|
||||
|
||||
#### EndOfYear(t time.Time, timezone ...string) time.Time
|
||||
|
||||
获取年份的结束时间。
|
||||
|
||||
#### DiffDays(t1, t2 time.Time) int
|
||||
|
||||
计算两个时间之间的天数差。
|
||||
|
||||
#### DiffHours(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的小时差。
|
||||
|
||||
#### DiffMinutes(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的分钟差。
|
||||
|
||||
#### DiffSeconds(t1, t2 time.Time) int64
|
||||
|
||||
计算两个时间之间的秒数差。
|
||||
|
||||
### 加密工具方法（黑盒模式）
|
||||
|
||||
#### 密码加密
|
||||
|
||||
##### HashPassword(password string) (string, error)
|
||||
|
||||
使用bcrypt加密密码。
|
||||
|
||||
**参数：**
|
||||
- `password`: 原始密码
|
||||
|
||||
**返回：** 加密后的密码哈希值和错误信息
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
hashedPassword, err := fac.HashPassword("myPassword")
|
||||
```
|
||||
|
||||
##### CheckPassword(password, hash string) bool
|
||||
|
||||
验证密码。
|
||||
|
||||
**参数：**
|
||||
- `password`: 原始密码
|
||||
- `hash`: 加密后的密码哈希值
|
||||
|
||||
**返回：** 密码是否正确
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
isValid := fac.CheckPassword("myPassword", hashedPassword)
|
||||
```
|
||||
|
||||
#### 哈希计算
|
||||
|
||||
##### MD5(text string) string
|
||||
|
||||
计算MD5哈希值。
|
||||
|
||||
**参数：**
|
||||
- `text`: 要计算哈希的文本
|
||||
|
||||
**返回：** MD5哈希值（十六进制字符串）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
hash := fac.MD5("text")
|
||||
```
|
||||
|
||||
##### SHA256(text string) string
|
||||
|
||||
计算SHA256哈希值。
|
||||
|
||||
**参数：**
|
||||
- `text`: 要计算哈希的文本
|
||||
|
||||
**返回：** SHA256哈希值（十六进制字符串）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
hash := fac.SHA256("text")
|
||||
```
|
||||
|
||||
#### 随机字符串生成
|
||||
|
||||
##### GenerateRandomString(length int) string
|
||||
|
||||
生成指定长度的随机字符串。
|
||||
|
||||
**参数：**
|
||||
- `length`: 字符串长度
|
||||
|
||||
**返回：** 随机字符串（包含大小写字母和数字）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
randomStr := fac.GenerateRandomString(16)
|
||||
```
|
||||
|
||||
##### GenerateRandomNumber(length int) string
|
||||
|
||||
生成指定长度的随机数字字符串。
|
||||
|
||||
**参数：**
|
||||
- `length`: 字符串长度
|
||||
|
||||
**返回：** 随机数字字符串
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
randomNum := fac.GenerateRandomNumber(6)
|
||||
```
|
||||
|
||||
#### 业务相关随机码生成
|
||||
|
||||
##### GenerateSMSCode() string
|
||||
|
||||
生成短信验证码。
|
||||
|
||||
**返回：** 6位数字验证码
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
code := fac.GenerateSMSCode()
|
||||
```
|
||||
|
||||
##### GenerateOrderNo(prefix string) string
|
||||
|
||||
生成订单号。
|
||||
|
||||
**参数：**
|
||||
- `prefix`: 订单号前缀
|
||||
|
||||
**返回：** 订单号（格式：前缀+时间戳+6位随机数）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
orderNo := fac.GenerateOrderNo("ORD")
|
||||
```
|
||||
|
||||
##### GeneratePaymentNo() string
|
||||
|
||||
生成支付单号。
|
||||
|
||||
**返回：** 支付单号（格式：PAY+时间戳+6位随机数）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
paymentNo := fac.GeneratePaymentNo()
|
||||
```
|
||||
|
||||
##### GenerateRefundNo() string
|
||||
|
||||
生成退款单号。
|
||||
|
||||
**返回：** 退款单号（格式：RF+时间戳+6位随机数）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
refundNo := fac.GenerateRefundNo()
|
||||
```
|
||||
|
||||
##### GenerateTransferNo() string
|
||||
|
||||
生成调拨单号。
|
||||
|
||||
**返回：** 调拨单号（格式：TF+时间戳+6位随机数）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
transferNo := fac.GenerateTransferNo()
|
||||
```
|
||||
|
||||
### 时间工具方法（黑盒模式）
|
||||
|
||||
**说明**：Time 工具提供基础时间操作、时间戳、时间判断等功能，与 DateTime 工具的区别：
|
||||
- **DateTime**：专注于时区相关、格式化、解析、UTC转换
|
||||
- **Time**：专注于基础时间操作、时间戳、时间判断、时间信息生成
|
||||
|
||||
#### 时间戳方法
|
||||
|
||||
##### GetTimestamp() int64
|
||||
|
||||
获取当前时间戳（秒）。
|
||||
|
||||
##### GetMillisTimestamp() int64
|
||||
|
||||
获取当前时间戳（毫秒）。
|
||||
|
||||
##### GetUTCTimestamp() int64
|
||||
|
||||
获取UTC时间戳（秒）。
|
||||
|
||||
##### GetUTCTimestampFromTime(t time.Time) int64
|
||||
|
||||
从指定时间获取UTC时间戳（秒）。
|
||||
|
||||
#### 格式化方法（自定义格式）
|
||||
|
||||
##### FormatTimeWithLayout(t time.Time, layout string) string
|
||||
|
||||
格式化时间（自定义格式）。
|
||||
|
||||
**参数：**
|
||||
- `t`: 时间对象
|
||||
- `layout`: 时间格式，如 "2006-01-02 15:04:05"，如果为空则使用默认格式
|
||||
|
||||
##### FormatTimeUTC(t time.Time) string
|
||||
|
||||
格式化时间为UTC字符串（ISO 8601格式）。
|
||||
|
||||
##### GetCurrentTime() string
|
||||
|
||||
获取当前时间字符串（使用默认格式 "2006-01-02 15:04:05"）。
|
||||
|
||||
#### 解析方法（自定义格式）
|
||||
|
||||
##### ParseTime(timeStr, layout string) (time.Time, error)
|
||||
|
||||
解析时间字符串（自定义格式）。
|
||||
|
||||
**参数：**
|
||||
- `timeStr`: 时间字符串
|
||||
- `layout`: 时间格式，如 "2006-01-02 15:04:05"，如果为空则使用默认格式
|
||||
|
||||
#### 时间计算（补充 DateTime 的 Add 系列）
|
||||
|
||||
##### AddHours(t time.Time, hours int) time.Time
|
||||
|
||||
增加小时数。
|
||||
|
||||
##### AddMinutes(t time.Time, minutes int) time.Time
|
||||
|
||||
增加分钟数。
|
||||
|
||||
#### 时间范围（周相关）
|
||||
|
||||
##### GetBeginOfWeek(t time.Time) time.Time
|
||||
|
||||
获取某周的开始时间（周一）。
|
||||
|
||||
##### GetEndOfWeek(t time.Time) time.Time
|
||||
|
||||
获取某周的结束时间（周日）。
|
||||
|
||||
#### 时间判断
|
||||
|
||||
##### IsToday(t time.Time) bool
|
||||
|
||||
判断是否为今天。
|
||||
|
||||
##### IsYesterday(t time.Time) bool
|
||||
|
||||
判断是否为昨天。
|
||||
|
||||
##### IsTomorrow(t time.Time) bool
|
||||
|
||||
判断是否为明天。
|
||||
|
||||
#### 时间信息生成
|
||||
|
||||
##### GenerateTimeInfoWithTimezone(t time.Time, timezone string) TimeInfo
|
||||
|
||||
生成详细时间信息（指定时区）。
|
||||
|
||||
**参数：**
|
||||
- `t`: 时间对象
|
||||
- `timezone`: 时区字符串，如 "Asia/Shanghai"
|
||||
|
||||
**返回：** TimeInfo 结构体，包含：
|
||||
- `UTC`: UTC时间（RFC3339格式）
|
||||
- `Local`: 本地时间（RFC3339格式）
|
||||
- `Unix`: Unix时间戳（秒）
|
||||
- `Timezone`: 时区名称
|
||||
- `Offset`: 时区偏移量（小时）
|
||||
- `RFC3339`: RFC3339格式时间
|
||||
- `DateTime`: 日期时间格式（2006-01-02 15:04:05）
|
||||
- `Date`: 日期格式（2006-01-02）
|
||||
- `Time`: 时间格式（15:04:05）
|
||||
|
||||
### 金额工具方法（黑盒模式）
|
||||
|
||||
#### GetMoneyCalculator() *tools.MoneyCalculator
|
||||
|
||||
获取金额计算器实例。
|
||||
|
||||
#### YuanToCents(yuan float64) int64
|
||||
|
||||
元转分。
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
cents := fac.YuanToCents(100.5) // 返回 10050
|
||||
```
|
||||
|
||||
#### CentsToYuan(cents int64) float64
|
||||
|
||||
分转元。
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
yuan := fac.CentsToYuan(10050) // 返回 100.5
|
||||
```
|
||||
|
||||
#### FormatYuan(cents int64) string
|
||||
|
||||
格式化显示金额（分转元，保留2位小数）。
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
str := fac.FormatYuan(10050) // 返回 "100.50"
|
||||
```
|
||||
|
||||
### 版本工具方法（黑盒模式）
|
||||
|
||||
#### GetVersion() string
|
||||
|
||||
获取版本号。
|
||||
|
||||
**说明：**
|
||||
- 优先从环境变量 `DOCKER_TAG` 或 `VERSION` 中读取
|
||||
- 如果没有设置环境变量，则使用默认版本号
|
||||
|
||||
## 设计优势
|
||||
|
||||
### 优势总结
|
||||
|
||||
604
docs/http.md
604
docs/http.md
@@ -2,16 +2,17 @@
|
||||
|
||||
## 概述
|
||||
|
||||
HTTP Restful工具提供了标准化的HTTP请求和响应处理功能，采用Handler黑盒模式，封装了`ResponseWriter`和`Request`，提供简洁的API，无需每次都传递这两个参数。
|
||||
HTTP Restful工具提供了标准化的HTTP请求和响应处理功能，提供公共方法供外部调用，保持低耦合。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- **黑盒模式**：封装`ResponseWriter`和`Request`，提供简洁的API
|
||||
- **低耦合设计**：提供公共方法，不封装Handler结构
|
||||
- **标准化的响应结构**：`{code, message, timestamp, data}`
|
||||
- **分离HTTP状态码和业务状态码**
|
||||
- **支持分页响应**
|
||||
- **提供便捷的请求参数解析方法**
|
||||
- **支持JSON请求体解析**
|
||||
- **Factory黑盒模式**：推荐使用 `factory.Success()` 等方法
|
||||
|
||||
## 响应结构
|
||||
|
||||
@@ -26,6 +27,18 @@ HTTP Restful工具提供了标准化的HTTP请求和响应处理功能，采用H
|
||||
}
|
||||
```
|
||||
|
||||
**结构体类型（暴露在 factory 中）：**
|
||||
|
||||
```go
|
||||
// 在 factory 包中可以直接使用
|
||||
type Response struct {
|
||||
Code int `json:"code"` // 业务状态码，0表示成功
|
||||
Message string `json:"message"` // 响应消息
|
||||
Timestamp int64 `json:"timestamp"` // 时间戳
|
||||
Data interface{} `json:"data"` // 响应数据
|
||||
}
|
||||
```
|
||||
|
||||
### 分页响应结构
|
||||
|
||||
```json
|
||||
@@ -42,9 +55,116 @@ HTTP Restful工具提供了标准化的HTTP请求和响应处理功能，采用H
|
||||
}
|
||||
```
|
||||
|
||||
**结构体类型（暴露在 factory 中）：**
|
||||
|
||||
```go
|
||||
// 在 factory 包中可以直接使用
|
||||
type PageData struct {
|
||||
List interface{} `json:"list"` // 数据列表
|
||||
Total int64 `json:"total"` // 总记录数
|
||||
Page int `json:"page"` // 当前页码
|
||||
PageSize int `json:"pageSize"` // 每页大小
|
||||
}
|
||||
|
||||
type PageResponse struct {
|
||||
Code int `json:"code"`
|
||||
Message string `json:"message"`
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Data *PageData `json:"data"`
|
||||
}
|
||||
```
|
||||
|
||||
### 使用暴露的结构体
|
||||
|
||||
外部项目可以直接使用 `factory.Response`、`factory.PageData` 等类型：
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
// 创建标准响应对象
|
||||
response := factory.Response{
|
||||
Code: 0,
|
||||
Message: "success",
|
||||
Data: userData,
|
||||
}
|
||||
|
||||
// 创建分页数据对象
|
||||
pageData := &factory.PageData{
|
||||
List: users,
|
||||
Total: 100,
|
||||
Page: 1,
|
||||
PageSize: 20,
|
||||
}
|
||||
|
||||
// 传递给 Success 方法
|
||||
fac.Success(w, pageData)
|
||||
```
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 1. 创建Handler
|
||||
### 方式一：使用Factory黑盒方法（推荐）⭐
|
||||
|
||||
这是最简单的方式，直接使用 `factory.Success()` 等方法：
|
||||
|
||||
```go
|
||||
import (
|
||||
"net/http"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
|
||||
func GetUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取查询参数（使用公共方法）
|
||||
id := commonhttp.GetQueryInt64(r, "id", 0)
|
||||
|
||||
// 返回成功响应（使用factory方法）
|
||||
fac.Success(w, data)
|
||||
}
|
||||
|
||||
func CreateUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 解析JSON（使用公共方法）
|
||||
var req struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 返回成功响应（使用factory方法）
|
||||
fac.Success(w, data, "创建成功")
|
||||
}
|
||||
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取分页参数（使用factory方法，推荐）
|
||||
pagination := fac.ParsePaginationRequest(r)
|
||||
page := pagination.GetPage()
|
||||
pageSize := pagination.GetSize()
|
||||
|
||||
// 获取查询参数（使用factory方法，推荐）
|
||||
keyword := fac.GetQuery(r, "keyword", "")
|
||||
|
||||
// 查询数据
|
||||
list, total := getDataList(keyword, page, pageSize)
|
||||
|
||||
// 返回分页响应（使用factory方法）
|
||||
fac.SuccessPage(w, list, total, page, pageSize)
|
||||
}
|
||||
|
||||
// 注册路由
|
||||
http.HandleFunc("/user", GetUser)
|
||||
http.HandleFunc("/users", GetUserList)
|
||||
```
|
||||
|
||||
### 方式二：直接使用公共方法
|
||||
|
||||
如果不想使用Factory，可以直接使用 `http` 包的公共方法：
|
||||
|
||||
```go
|
||||
import (
|
||||
@@ -52,154 +172,110 @@ import (
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
|
||||
// 方式1：使用HandleFunc包装器（推荐，最简洁）
|
||||
func GetUser(h *commonhttp.Handler) {
|
||||
id := h.GetQueryInt64("id", 0)
|
||||
h.Success(data)
|
||||
func GetUser(w http.ResponseWriter, r *http.Request) {
|
||||
// 获取查询参数
|
||||
id := commonhttp.GetQueryInt64(r, "id", 0)
|
||||
|
||||
// 返回成功响应
|
||||
commonhttp.Success(w, data)
|
||||
}
|
||||
|
||||
http.HandleFunc("/user", commonhttp.HandleFunc(GetUser))
|
||||
func CreateUser(w http.ResponseWriter, r *http.Request) {
|
||||
// 解析JSON
|
||||
var req struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 方式2：手动创建Handler（需要更多控制时）
|
||||
http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
GetUser(h)
|
||||
})
|
||||
// 返回成功响应
|
||||
commonhttp.Success(w, data, "创建成功")
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 成功响应
|
||||
### 成功响应
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 简单成功响应（data为nil）
|
||||
h.Success(nil)
|
||||
// 使用Factory（推荐）
|
||||
fac.Success(w, data) // 只有数据，使用默认消息 "success"
|
||||
fac.Success(w, data, "操作成功") // 数据+消息
|
||||
|
||||
// 带数据的成功响应
|
||||
data := map[string]interface{}{
|
||||
"id": 1,
|
||||
"name": "test",
|
||||
}
|
||||
h.Success(data)
|
||||
|
||||
// 带消息的成功响应
|
||||
h.SuccessWithMessage("操作成功", data)
|
||||
}
|
||||
// 或直接使用公共方法
|
||||
commonhttp.Success(w, data) // 只有数据
|
||||
commonhttp.Success(w, data, "操作成功") // 数据+消息
|
||||
```
|
||||
|
||||
### 3. 错误响应
|
||||
### 错误响应
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 业务错误（HTTP 200，业务code非0）
|
||||
h.Error(1001, "用户不存在")
|
||||
// 使用Factory（推荐）
|
||||
fac.Error(w, 1001, "用户不存在") // 业务错误（HTTP 200，业务code非0）
|
||||
fac.SystemError(w, "服务器内部错误") // 系统错误（HTTP 500）
|
||||
|
||||
// 系统错误（HTTP 500）
|
||||
h.SystemError("服务器内部错误")
|
||||
|
||||
// 其他HTTP错误状态码，使用WriteJSON直接指定
|
||||
// 请求错误（HTTP 400）
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数错误", nil)
|
||||
|
||||
// 未授权（HTTP 401）
|
||||
h.WriteJSON(http.StatusUnauthorized, 401, "未登录", nil)
|
||||
|
||||
// 禁止访问（HTTP 403）
|
||||
h.WriteJSON(http.StatusForbidden, 403, "无权限访问", nil)
|
||||
|
||||
// 未找到（HTTP 404）
|
||||
h.WriteJSON(http.StatusNotFound, 404, "资源不存在", nil)
|
||||
}
|
||||
// 或直接使用公共方法
|
||||
commonhttp.Error(w, 1001, "用户不存在")
|
||||
commonhttp.SystemError(w, "服务器内部错误")
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数错误", nil) // 自定义HTTP状态码（仅公共方法）
|
||||
```
|
||||
|
||||
### 4. 分页响应
|
||||
### 分页响应
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 获取分页参数
|
||||
pagination := h.ParsePaginationRequest()
|
||||
page := pagination.GetPage()
|
||||
pageSize := pagination.GetSize()
|
||||
// 使用Factory（推荐）
|
||||
fac.SuccessPage(w, list, total, page, pageSize)
|
||||
fac.SuccessPage(w, list, total, page, pageSize, "查询成功")
|
||||
|
||||
// 查询数据（示例）
|
||||
list, total := getDataList(page, pageSize)
|
||||
|
||||
// 返回分页响应（使用默认消息）
|
||||
h.SuccessPage(list, total, page, pageSize)
|
||||
|
||||
// 返回分页响应（自定义消息）
|
||||
h.SuccessPage(list, total, page, pageSize, "查询成功")
|
||||
}
|
||||
// 或直接使用公共方法
|
||||
commonhttp.SuccessPage(w, list, total, page, pageSize)
|
||||
commonhttp.SuccessPage(w, list, total, page, pageSize, "查询成功")
|
||||
```
|
||||
|
||||
### 5. 解析请求
|
||||
### 解析请求
|
||||
|
||||
#### 解析JSON请求体
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
type CreateUserRequest struct {
|
||||
// 使用公共方法
|
||||
var req struct {
|
||||
Name string `json:"name"`
|
||||
Email string `json:"email"`
|
||||
}
|
||||
|
||||
var req CreateUserRequest
|
||||
if err := h.ParseJSON(&req); err != nil {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 使用req...
|
||||
}
|
||||
```
|
||||
|
||||
#### 获取查询参数
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 获取字符串参数
|
||||
name := h.GetQuery("name", "")
|
||||
email := h.GetQuery("email", "default@example.com")
|
||||
|
||||
// 获取整数参数
|
||||
id := h.GetQueryInt("id", 0)
|
||||
age := h.GetQueryInt("age", 18)
|
||||
|
||||
// 获取int64参数
|
||||
userId := h.GetQueryInt64("userId", 0)
|
||||
|
||||
// 获取布尔参数
|
||||
isActive := h.GetQueryBool("isActive", false)
|
||||
|
||||
// 获取浮点数参数
|
||||
price := h.GetQueryFloat64("price", 0.0)
|
||||
}
|
||||
// 使用公共方法
|
||||
name := commonhttp.GetQuery(r, "name", "")
|
||||
id := commonhttp.GetQueryInt(r, "id", 0)
|
||||
userId := commonhttp.GetQueryInt64(r, "userId", 0)
|
||||
isActive := commonhttp.GetQueryBool(r, "isActive", false)
|
||||
price := commonhttp.GetQueryFloat64(r, "price", 0.0)
|
||||
```
|
||||
|
||||
#### 获取表单参数
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 获取表单字符串
|
||||
name := h.GetFormValue("name", "")
|
||||
|
||||
// 获取表单整数
|
||||
age := h.GetFormInt("age", 0)
|
||||
|
||||
// 获取表单int64
|
||||
userId := h.GetFormInt64("userId", 0)
|
||||
|
||||
// 获取表单布尔值
|
||||
isActive := h.GetFormBool("isActive", false)
|
||||
}
|
||||
// 使用公共方法
|
||||
name := commonhttp.GetFormValue(r, "name", "")
|
||||
age := commonhttp.GetFormInt(r, "age", 0)
|
||||
userId := commonhttp.GetFormInt64(r, "userId", 0)
|
||||
isActive := commonhttp.GetFormBool(r, "isActive", false)
|
||||
```
|
||||
|
||||
#### 获取请求头
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
token := h.GetHeader("Authorization", "")
|
||||
contentType := h.GetHeader("Content-Type", "application/json")
|
||||
}
|
||||
// 使用公共方法
|
||||
token := commonhttp.GetHeader(r, "Authorization", "")
|
||||
contentType := commonhttp.GetHeader(r, "Content-Type", "application/json")
|
||||
```
|
||||
|
||||
#### 获取分页参数
|
||||
@@ -207,7 +283,6 @@ func handler(h *commonhttp.Handler) {
|
||||
**方式1：使用 PaginationRequest 结构（推荐）**
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 定义请求结构（包含分页字段）
|
||||
type ListUserRequest struct {
|
||||
Keyword string `json:"keyword"`
|
||||
@@ -216,8 +291,8 @@ func handler(h *commonhttp.Handler) {
|
||||
|
||||
// 从JSON请求体解析（分页字段会自动解析）
|
||||
var req ListUserRequest
|
||||
if err := h.ParseJSON(&req); err != nil {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
@@ -225,53 +300,38 @@ func handler(h *commonhttp.Handler) {
|
||||
page := req.GetPage() // 获取页码（默认1）
|
||||
size := req.GetSize() // 获取每页数量（默认20，最大100，优先使用page_size）
|
||||
offset := req.GetOffset() // 计算偏移量
|
||||
}
|
||||
```
|
||||
|
||||
// 或者从查询参数/form解析分页
|
||||
func handler(h *commonhttp.Handler) {
|
||||
pagination := h.ParsePaginationRequest()
|
||||
**方式2：从查询参数/form解析分页**
|
||||
|
||||
```go
|
||||
// 使用公共方法
|
||||
pagination := commonhttp.ParsePaginationRequest(r)
|
||||
page := pagination.GetPage()
|
||||
size := pagination.GetSize()
|
||||
offset := pagination.GetOffset()
|
||||
}
|
||||
```
|
||||
|
||||
#### 获取时区
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 从请求的context中获取时区
|
||||
// 使用公共方法
|
||||
// 如果使用了middleware.Timezone中间件，可以从context中获取时区信息
|
||||
// 如果未设置，返回默认时区 AsiaShanghai
|
||||
timezone := h.GetTimezone()
|
||||
}
|
||||
```
|
||||
|
||||
### 6. 访问原始对象
|
||||
|
||||
如果需要访问原始的`ResponseWriter`或`Request`：
|
||||
|
||||
```go
|
||||
func handler(h *commonhttp.Handler) {
|
||||
// 获取原始ResponseWriter
|
||||
w := h.ResponseWriter()
|
||||
|
||||
// 获取原始Request
|
||||
r := h.Request()
|
||||
|
||||
// 获取Context
|
||||
ctx := h.Context()
|
||||
}
|
||||
timezone := commonhttp.GetTimezone(r)
|
||||
```
|
||||
|
||||
## 完整示例
|
||||
|
||||
### 使用Factory（推荐）
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
"net/http"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
)
|
||||
|
||||
@@ -283,91 +343,97 @@ type User struct {
|
||||
}
|
||||
|
||||
// 用户列表接口
|
||||
func GetUserList(h *commonhttp.Handler) {
|
||||
// 获取分页参数
|
||||
pagination := h.ParsePaginationRequest()
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取分页参数（使用公共方法）
|
||||
pagination := commonhttp.ParsePaginationRequest(r)
|
||||
page := pagination.GetPage()
|
||||
pageSize := pagination.GetSize()
|
||||
|
||||
// 获取查询参数
|
||||
keyword := h.GetQuery("keyword", "")
|
||||
// 获取查询参数（使用公共方法）
|
||||
keyword := commonhttp.GetQuery(r, "keyword", "")
|
||||
|
||||
// 查询数据
|
||||
users, total := queryUsers(keyword, page, pageSize)
|
||||
|
||||
// 返回分页响应
|
||||
h.SuccessPage(users, total, page, pageSize)
|
||||
// 返回分页响应（使用factory方法）
|
||||
fac.SuccessPage(w, users, total, page, pageSize)
|
||||
}
|
||||
|
||||
// 创建用户接口
|
||||
func CreateUser(h *commonhttp.Handler) {
|
||||
// 解析请求体
|
||||
func CreateUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 解析请求体（使用公共方法）
|
||||
var req struct {
|
||||
Name string `json:"name"`
|
||||
Email string `json:"email"`
|
||||
}
|
||||
|
||||
if err := h.ParseJSON(&req); err != nil {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
fac.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 参数验证
|
||||
if req.Name == "" {
|
||||
h.Error(1001, "用户名不能为空")
|
||||
fac.Error(w, 1001, "用户名不能为空")
|
||||
return
|
||||
}
|
||||
|
||||
// 创建用户
|
||||
user, err := createUser(req.Name, req.Email)
|
||||
if err != nil {
|
||||
h.SystemError("创建用户失败")
|
||||
fac.SystemError(w, "创建用户失败")
|
||||
return
|
||||
}
|
||||
|
||||
// 返回成功响应
|
||||
h.SuccessWithMessage("创建成功", user)
|
||||
// 返回成功响应（使用factory方法）
|
||||
fac.Success(w, user, "创建成功")
|
||||
}
|
||||
|
||||
// 获取用户详情接口
|
||||
func GetUser(h *commonhttp.Handler) {
|
||||
// 获取查询参数
|
||||
id := h.GetQueryInt64("id", 0)
|
||||
func GetUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取查询参数（使用factory方法，推荐）
|
||||
id := fac.GetQueryInt64(r, "id", 0)
|
||||
|
||||
if id == 0 {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "用户ID不能为空", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "用户ID不能为空", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 查询用户
|
||||
user, err := getUserByID(id)
|
||||
if err != nil {
|
||||
h.SystemError("查询用户失败")
|
||||
fac.SystemError(w, "查询用户失败")
|
||||
return
|
||||
}
|
||||
|
||||
if user == nil {
|
||||
h.Error(1002, "用户不存在")
|
||||
fac.Error(w, 1002, "用户不存在")
|
||||
return
|
||||
}
|
||||
|
||||
h.Success(user)
|
||||
// 返回成功响应（使用factory方法）
|
||||
fac.Success(w, user)
|
||||
}
|
||||
|
||||
func main() {
|
||||
// 使用HandleFunc包装器（推荐）
|
||||
http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
switch h.Request().Method {
|
||||
http.HandleFunc("/users", func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.Method {
|
||||
case http.MethodGet:
|
||||
GetUserList(h)
|
||||
GetUserList(w, r)
|
||||
case http.MethodPost:
|
||||
CreateUser(h)
|
||||
CreateUser(w, r)
|
||||
default:
|
||||
h.WriteJSON(http.StatusMethodNotAllowed, 405, "方法不支持", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusMethodNotAllowed, 405, "方法不支持", nil)
|
||||
}
|
||||
}))
|
||||
})
|
||||
|
||||
http.HandleFunc("/user", commonhttp.HandleFunc(GetUser))
|
||||
http.HandleFunc("/user", GetUser)
|
||||
|
||||
log.Println("Server started on :8080")
|
||||
log.Fatal(http.ListenAndServe(":8080", nil))
|
||||
@@ -376,53 +442,93 @@ func main() {
|
||||
|
||||
## API 参考
|
||||
|
||||
### Handler结构
|
||||
### Factory HTTP响应结构体（暴露给外部项目使用）
|
||||
|
||||
Handler封装了`ResponseWriter`和`Request`，提供更简洁的API。
|
||||
#### Response
|
||||
|
||||
```go
|
||||
type Handler struct {
|
||||
w http.ResponseWriter
|
||||
r *http.Request
|
||||
}
|
||||
```
|
||||
标准响应结构体，外部项目可以直接使用 `factory.Response`。
|
||||
|
||||
### 创建Handler
|
||||
|
||||
#### NewHandler(w http.ResponseWriter, r *http.Request) *Handler
|
||||
|
||||
创建Handler实例。
|
||||
|
||||
#### HandleFunc(fn func(*Handler)) http.HandlerFunc
|
||||
|
||||
将Handler函数转换为标准的http.HandlerFunc（便捷包装器）。
|
||||
**字段：**
|
||||
- `Code`: 业务状态码，0表示成功
|
||||
- `Message`: 响应消息
|
||||
- `Timestamp`: 时间戳（Unix时间戳，秒）
|
||||
- `Data`: 响应数据
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
h.Success(data)
|
||||
}))
|
||||
response := factory.Response{
|
||||
Code: 0,
|
||||
Message: "success",
|
||||
Data: userData,
|
||||
}
|
||||
```
|
||||
|
||||
### Handler响应方法
|
||||
#### PageData
|
||||
|
||||
#### (h *Handler) Success(data interface{})
|
||||
分页数据结构体，外部项目可以直接使用 `factory.PageData`。
|
||||
|
||||
**字段：**
|
||||
- `List`: 数据列表
|
||||
- `Total`: 总记录数
|
||||
- `Page`: 当前页码
|
||||
- `PageSize`: 每页大小
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
pageData := &factory.PageData{
|
||||
List: users,
|
||||
Total: 100,
|
||||
Page: 1,
|
||||
PageSize: 20,
|
||||
}
|
||||
fac.Success(w, pageData)
|
||||
```
|
||||
|
||||
#### PageResponse
|
||||
|
||||
分页响应结构体，外部项目可以直接使用 `factory.PageResponse`。
|
||||
|
||||
**字段：**
|
||||
- `Code`: 业务状态码
|
||||
- `Message`: 响应消息
|
||||
- `Timestamp`: 时间戳
|
||||
- `Data`: 分页数据（*PageData）
|
||||
|
||||
### Factory HTTP响应方法（推荐使用）
|
||||
|
||||
#### (f *Factory) Success(w http.ResponseWriter, data interface{}, message ...string)
|
||||
|
||||
成功响应，HTTP 200，业务code 0。
|
||||
|
||||
#### (h *Handler) SuccessWithMessage(message string, data interface{})
|
||||
**参数：**
|
||||
- `data`: 响应数据，可以为nil
|
||||
- `message`: 响应消息（可选），如果为空则使用默认消息 "success"
|
||||
|
||||
带消息的成功响应。
|
||||
**示例：**
|
||||
```go
|
||||
fac.Success(w, data) // 只有数据，使用默认消息 "success"
|
||||
fac.Success(w, data, "操作成功") // 数据+消息
|
||||
```
|
||||
|
||||
#### (h *Handler) Error(code int, message string)
|
||||
#### (f *Factory) Error(w http.ResponseWriter, code int, message string)
|
||||
|
||||
业务错误响应，HTTP 200，业务code非0。
|
||||
|
||||
#### (h *Handler) SystemError(message string)
|
||||
**示例：**
|
||||
```go
|
||||
fac.Error(w, 1001, "用户不存在")
|
||||
```
|
||||
|
||||
#### (f *Factory) SystemError(w http.ResponseWriter, message string)
|
||||
|
||||
系统错误响应，HTTP 500，业务code 500。
|
||||
|
||||
#### (h *Handler) WriteJSON(httpCode, code int, message string, data interface{})
|
||||
**示例：**
|
||||
```go
|
||||
fac.SystemError(w, "服务器内部错误")
|
||||
```
|
||||
|
||||
#### (f *Factory) WriteJSON(w http.ResponseWriter, httpCode, code int, message string, data interface{})
|
||||
|
||||
写入JSON响应（自定义）。
|
||||
|
||||
@@ -432,7 +538,17 @@ http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
- `message`: 响应消息
|
||||
- `data`: 响应数据
|
||||
|
||||
#### (h *Handler) SuccessPage(list interface{}, total int64, page, pageSize int, message ...string)
|
||||
**说明：**
|
||||
- 此方法不在 Factory 中，直接使用 `commonhttp.WriteJSON()`
|
||||
- 用于需要自定义HTTP状态码的场景（如 400, 401, 403, 404 等）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数错误", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusUnauthorized, 401, "未登录", nil)
|
||||
```
|
||||
|
||||
#### (f *Factory) SuccessPage(w http.ResponseWriter, list interface{}, total int64, page, pageSize int, message ...string)
|
||||
|
||||
分页成功响应。
|
||||
|
||||
@@ -443,53 +559,81 @@ http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
- `pageSize`: 每页大小
|
||||
- `message`: 响应消息（可选，如果为空则使用默认消息 "success"）
|
||||
|
||||
### Handler请求解析方法
|
||||
**示例：**
|
||||
```go
|
||||
fac.SuccessPage(w, users, total, page, pageSize)
|
||||
fac.SuccessPage(w, users, total, page, pageSize, "查询成功")
|
||||
```
|
||||
|
||||
#### (h *Handler) ParseJSON(v interface{}) error
|
||||
### HTTP公共方法（直接使用）
|
||||
|
||||
#### WriteJSON(w http.ResponseWriter, httpCode, code int, message string, data interface{})
|
||||
|
||||
写入JSON响应（自定义HTTP状态码和业务状态码）。
|
||||
|
||||
**说明：**
|
||||
- 此方法不在 Factory 中，直接使用 `commonhttp.WriteJSON()`
|
||||
- 用于需要自定义HTTP状态码的场景（如 400, 401, 403, 404 等）
|
||||
|
||||
**示例：**
|
||||
```go
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数错误", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusUnauthorized, 401, "未登录", nil)
|
||||
```
|
||||
|
||||
#### ParseJSON(r *http.Request, v interface{}) error
|
||||
|
||||
解析JSON请求体。
|
||||
|
||||
#### (h *Handler) GetQuery(key, defaultValue string) string
|
||||
**示例：**
|
||||
```go
|
||||
var req CreateUserRequest
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
// 处理错误
|
||||
}
|
||||
```
|
||||
|
||||
#### GetQuery(r *http.Request, key, defaultValue string) string
|
||||
|
||||
获取查询参数（字符串）。
|
||||
|
||||
#### (h *Handler) GetQueryInt(key string, defaultValue int) int
|
||||
#### GetQueryInt(r *http.Request, key string, defaultValue int) int
|
||||
|
||||
获取查询参数（整数）。
|
||||
|
||||
#### (h *Handler) GetQueryInt64(key string, defaultValue int64) int64
|
||||
#### GetQueryInt64(r *http.Request, key string, defaultValue int64) int64
|
||||
|
||||
获取查询参数（int64）。
|
||||
|
||||
#### (h *Handler) GetQueryBool(key string, defaultValue bool) bool
|
||||
#### GetQueryBool(r *http.Request, key string, defaultValue bool) bool
|
||||
|
||||
获取查询参数（布尔值）。
|
||||
|
||||
#### (h *Handler) GetQueryFloat64(key string, defaultValue float64) float64
|
||||
#### GetQueryFloat64(r *http.Request, key string, defaultValue float64) float64
|
||||
|
||||
获取查询参数（浮点数）。
|
||||
|
||||
#### (h *Handler) GetFormValue(key, defaultValue string) string
|
||||
#### GetFormValue(r *http.Request, key, defaultValue string) string
|
||||
|
||||
获取表单值（字符串）。
|
||||
|
||||
#### (h *Handler) GetFormInt(key string, defaultValue int) int
|
||||
#### GetFormInt(r *http.Request, key string, defaultValue int) int
|
||||
|
||||
获取表单值（整数）。
|
||||
|
||||
#### (h *Handler) GetFormInt64(key string, defaultValue int64) int64
|
||||
#### GetFormInt64(r *http.Request, key string, defaultValue int64) int64
|
||||
|
||||
获取表单值（int64）。
|
||||
|
||||
#### (h *Handler) GetFormBool(key string, defaultValue bool) bool
|
||||
#### GetFormBool(r *http.Request, key string, defaultValue bool) bool
|
||||
|
||||
获取表单值（布尔值）。
|
||||
|
||||
#### (h *Handler) GetHeader(key, defaultValue string) string
|
||||
#### GetHeader(r *http.Request, key, defaultValue string) string
|
||||
|
||||
获取请求头。
|
||||
|
||||
#### (h *Handler) ParsePaginationRequest() *PaginationRequest
|
||||
#### ParsePaginationRequest(r *http.Request) *PaginationRequest
|
||||
|
||||
从请求中解析分页参数。
|
||||
|
||||
@@ -498,7 +642,7 @@ http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
- 优先级：查询参数 > form表单
|
||||
- 如果请求体是JSON格式且包含分页字段，建议先使用`ParseJSON`解析完整请求体到包含`PaginationRequest`的结构体中
|
||||
|
||||
#### (h *Handler) GetTimezone() string
|
||||
#### GetTimezone(r *http.Request) string
|
||||
|
||||
从请求的context中获取时区。
|
||||
|
||||
@@ -506,19 +650,39 @@ http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
- 如果使用了middleware.Timezone中间件，可以从context中获取时区信息
|
||||
- 如果未设置，返回默认时区 AsiaShanghai
|
||||
|
||||
### Handler访问原始对象
|
||||
#### Success(w http.ResponseWriter, data interface{}, message ...string)
|
||||
|
||||
#### (h *Handler) ResponseWriter() http.ResponseWriter
|
||||
成功响应（公共方法）。
|
||||
|
||||
获取原始的ResponseWriter（需要时使用）。
|
||||
**参数：**
|
||||
- `data`: 响应数据，可以为nil
|
||||
- `message`: 响应消息（可选），如果为空则使用默认消息 "success"
|
||||
|
||||
#### (h *Handler) Request() *http.Request
|
||||
**示例：**
|
||||
```go
|
||||
commonhttp.Success(w, data) // 只有数据
|
||||
commonhttp.Success(w, data, "操作成功") // 数据+消息
|
||||
```
|
||||
|
||||
获取原始的Request（需要时使用）。
|
||||
#### Error(w http.ResponseWriter, code int, message string)
|
||||
|
||||
#### (h *Handler) Context() context.Context
|
||||
错误响应（公共方法）。
|
||||
|
||||
获取请求的Context。
|
||||
#### SystemError(w http.ResponseWriter, message string)
|
||||
|
||||
系统错误响应（公共方法）。
|
||||
|
||||
#### WriteJSON(w http.ResponseWriter, httpCode, code int, message string, data interface{})
|
||||
|
||||
写入JSON响应（公共方法，不在Factory中）。
|
||||
|
||||
**说明：**
|
||||
- 用于需要自定义HTTP状态码的场景
|
||||
- 直接使用 `commonhttp.WriteJSON()`，不在 Factory 中
|
||||
|
||||
#### SuccessPage(w http.ResponseWriter, list interface{}, total int64, page, pageSize int, message ...string)
|
||||
|
||||
分页成功响应（公共方法）。
|
||||
|
||||
### 分页请求结构
|
||||
|
||||
@@ -575,10 +739,14 @@ http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
- 使用`SystemError`返回系统错误（HTTP 500）
|
||||
- 其他HTTP错误状态码（400, 401, 403, 404等）使用`WriteJSON`方法直接指定
|
||||
|
||||
5. **黑盒模式**：
|
||||
- 所有功能都通过Handler对象调用，无需传递`w`和`r`参数
|
||||
- 代码更简洁，减少调用方工作量
|
||||
5. **推荐使用Factory**：
|
||||
- 使用 `factory.Success()` 等方法，代码更简洁
|
||||
- 直接使用 `http` 包的公共方法，保持低耦合
|
||||
- 不需要Handler结构，减少不必要的封装
|
||||
|
||||
## 示例
|
||||
|
||||
完整示例请参考 `examples/http_handler_example.go`
|
||||
完整示例请参考：
|
||||
- `examples/http_handler_example.go` - 使用Factory和公共方法
|
||||
- `examples/http_pagination_example.go` - 分页示例
|
||||
- `examples/factory_blackbox_example.go` - Factory黑盒模式示例
|
||||
|
||||
@@ -136,7 +136,7 @@ import (
|
||||
"net/http"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func handler(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -146,12 +146,12 @@ func handler(w http.ResponseWriter, r *http.Request) {
|
||||
timezone := h.GetTimezone()
|
||||
|
||||
// 使用时区
|
||||
now := datetime.Now(timezone)
|
||||
datetime.FormatDateTime(now, timezone)
|
||||
now := tools.Now(timezone)
|
||||
tools.FormatDateTime(now, timezone)
|
||||
|
||||
h.Success(map[string]interface{}{
|
||||
"timezone": timezone,
|
||||
"time": datetime.FormatDateTime(now),
|
||||
"time": tools.FormatDateTime(now),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -168,7 +168,7 @@ func main() {
|
||||
import (
|
||||
"net/http"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func handler(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -177,7 +177,7 @@ func handler(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
func main() {
|
||||
// 使用自定义默认时区
|
||||
handler := middleware.TimezoneWithDefault(datetime.UTC)(http.HandlerFunc(handler))
|
||||
handler := middleware.TimezoneWithDefault(tools.UTC)(http.HandlerFunc(handler))
|
||||
http.Handle("/api", handler)
|
||||
http.ListenAndServe(":8080", nil)
|
||||
}
|
||||
@@ -185,11 +185,43 @@ func main() {
|
||||
|
||||
#### 在业务代码中使用时区
|
||||
|
||||
**推荐方式：通过 factory 使用（黑盒模式）**
|
||||
|
||||
```go
|
||||
import (
|
||||
"net/http"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 从请求中获取时区
|
||||
timezone := fac.GetTimezone(r)
|
||||
|
||||
// 使用时区进行时间处理
|
||||
now := fac.Now(timezone)
|
||||
|
||||
// 查询数据时使用时区
|
||||
startTime := fac.StartOfDay(now, timezone)
|
||||
endTime := fac.EndOfDay(now, timezone)
|
||||
|
||||
// 返回数据
|
||||
fac.Success(w, map[string]interface{}{
|
||||
"timezone": timezone,
|
||||
"startTime": fac.FormatDateTime(startTime),
|
||||
"endTime": fac.FormatDateTime(endTime),
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
**或者直接使用 tools 包：**
|
||||
|
||||
```go
|
||||
import (
|
||||
"net/http"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -199,17 +231,17 @@ func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
timezone := h.GetTimezone()
|
||||
|
||||
// 使用时区进行时间处理
|
||||
now := datetime.Now(timezone)
|
||||
now := tools.Now(timezone)
|
||||
|
||||
// 查询数据时使用时区
|
||||
startTime := datetime.StartOfDay(now, timezone)
|
||||
endTime := datetime.EndOfDay(now, timezone)
|
||||
startTime := tools.StartOfDay(now, timezone)
|
||||
endTime := tools.EndOfDay(now, timezone)
|
||||
|
||||
// 返回数据
|
||||
h.Success(map[string]interface{}{
|
||||
"timezone": timezone,
|
||||
"startTime": datetime.FormatDateTime(startTime),
|
||||
"endTime": datetime.FormatDateTime(endTime),
|
||||
"startTime": tools.FormatDateTime(startTime),
|
||||
"endTime": tools.FormatDateTime(endTime),
|
||||
})
|
||||
}
|
||||
```
|
||||
@@ -658,7 +690,7 @@ import (
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
"git.toowon.com/jimmy/go-common/logger"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func apiHandler(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -666,12 +698,12 @@ func apiHandler(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
// 从Handler获取时区
|
||||
timezone := h.GetTimezone()
|
||||
now := datetime.Now(timezone)
|
||||
now := tools.Now(timezone)
|
||||
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Hello",
|
||||
"timezone": timezone,
|
||||
"time": datetime.FormatDateTime(now),
|
||||
"time": tools.FormatDateTime(now),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -756,7 +788,7 @@ import (
|
||||
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
func apiHandler(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -764,12 +796,12 @@ func apiHandler(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
// 从Handler获取时区
|
||||
timezone := h.GetTimezone()
|
||||
now := datetime.Now(timezone)
|
||||
now := tools.Now(timezone)
|
||||
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Hello",
|
||||
"timezone": timezone,
|
||||
"time": datetime.FormatDateTime(now),
|
||||
"time": tools.FormatDateTime(now),
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -13,7 +13,101 @@
|
||||
- 自动创建迁移记录表
|
||||
- 事务支持，确保迁移的原子性
|
||||
|
||||
## 使用方法
|
||||
## 🚀 最简单的使用方式（黑盒模式，推荐）
|
||||
|
||||
这是最简单的迁移方式，内部自动处理配置加载、数据库连接、迁移执行等所有细节。
|
||||
|
||||
### 方式一：使用独立迁移工具（推荐）
|
||||
|
||||
1. **复制迁移工具模板到你的项目**：
|
||||
|
||||
```bash
|
||||
mkdir -p cmd/migrate
|
||||
cp /path/to/go-common/templates/migrate/main.go cmd/migrate/
|
||||
```
|
||||
|
||||
2. **创建迁移文件**：
|
||||
|
||||
```bash
|
||||
mkdir -p migrations
|
||||
# 或使用其他目录，如 scripts/sql
|
||||
```
|
||||
|
||||
创建 `migrations/01_init_schema.sql`：
|
||||
|
||||
```sql
|
||||
CREATE TABLE users (
|
||||
id BIGINT PRIMARY KEY AUTO_INCREMENT,
|
||||
username VARCHAR(255) NOT NULL,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
```
|
||||
|
||||
3. **编译和使用**：
|
||||
|
||||
```bash
|
||||
# 编译
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
|
||||
# 使用（最简单，使用默认配置和默认迁移目录）
|
||||
./bin/migrate up
|
||||
|
||||
# 指定配置文件
|
||||
./bin/migrate up -config config.json
|
||||
|
||||
# 指定配置和迁移目录
|
||||
./bin/migrate up -config config.json -dir scripts/sql
|
||||
|
||||
# 查看状态
|
||||
./bin/migrate status
|
||||
|
||||
# 回滚
|
||||
./bin/migrate down
|
||||
```
|
||||
|
||||
**特点**：
|
||||
- ✅ 零配置：使用默认值即可运行
|
||||
- ✅ 自动查找配置：支持环境变量、默认路径
|
||||
- ✅ 自动处理：配置加载、数据库连接、迁移执行全自动
|
||||
|
||||
### 方式二：在代码中直接调用（简单场景）
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/migration"
|
||||
|
||||
// 最简单：使用默认配置和默认迁移目录
|
||||
err := migration.RunMigrationsFromConfigWithCommand("", "", "up")
|
||||
|
||||
// 指定配置文件，使用默认迁移目录
|
||||
err := migration.RunMigrationsFromConfigWithCommand("config.json", "", "up")
|
||||
|
||||
// 指定配置和迁移目录
|
||||
err := migration.RunMigrationsFromConfigWithCommand("config.json", "scripts/sql", "up")
|
||||
|
||||
// 查看状态
|
||||
err := migration.RunMigrationsFromConfigWithCommand("config.json", "migrations", "status")
|
||||
```
|
||||
|
||||
**参数说明**：
|
||||
- `configFile`: 配置文件路径，空字符串时自动查找（config.json, ../config.json）
|
||||
- `migrationsDir`: 迁移文件目录，空字符串时使用默认值 "migrations"
|
||||
- `command`: 命令，支持 "up", "down", "status"
|
||||
|
||||
### 方式三：使用Factory（如果项目已使用Factory）
|
||||
|
||||
```go
|
||||
import "git.toowon.com/jimmy/go-common/factory"
|
||||
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
// 使用默认目录 "migrations"
|
||||
err := fac.RunMigrations()
|
||||
// 或指定目录
|
||||
err := fac.RunMigrations("scripts/sql")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 详细使用方法（高级功能）
|
||||
|
||||
### 1. 创建迁移器
|
||||
|
||||
@@ -86,14 +180,16 @@ migrations := []migration.Migration{
|
||||
migrator.AddMigrations(migrations...)
|
||||
```
|
||||
|
||||
#### 方式三：从文件加载迁移
|
||||
#### 方式三：从文件加载迁移（推荐）
|
||||
|
||||
```go
|
||||
// 文件命名格式: {version}_{description}.sql 或 {version}_{description}.up.sql
|
||||
// 例如: 20240101000001_create_users_table.up.sql
|
||||
// 对应的回滚文件: 20240101000001_create_users_table.down.sql
|
||||
// 支持的文件命名格式：
|
||||
// 1. 数字前缀: 01_init_schema.sql
|
||||
// 2. 时间戳: 20240101000001_create_users.sql
|
||||
// 3. 带.up后缀: 20240101000001_create_users.up.sql
|
||||
// 对应的回滚文件: 20240101000001_create_users.down.sql
|
||||
|
||||
migrations, err := migration.LoadMigrationsFromFiles("./migrations", "*.up.sql")
|
||||
migrations, err := migration.LoadMigrationsFromFiles("./migrations", "*.sql")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -101,6 +197,12 @@ if err != nil {
|
||||
migrator.AddMigrations(migrations...)
|
||||
```
|
||||
|
||||
**新特性：**
|
||||
- ✅ 支持数字前缀命名（如 `01_init_schema.sql`）
|
||||
- ✅ 自动分割多行 SQL 语句
|
||||
- ✅ 自动处理注释（单行 `--` 和多行 `/* */`）
|
||||
- ✅ 记录执行时间（毫秒）
|
||||
|
||||
### 3. 执行迁移
|
||||
|
||||
```go
|
||||
@@ -289,15 +391,31 @@ type MigrationStatus struct {
|
||||
|
||||
**参数：**
|
||||
- `dir`: 迁移文件目录
|
||||
- `pattern`: 文件匹配模式，如 "*.up.sql"
|
||||
- `pattern`: 文件匹配模式，如 "*.sql" 或 "*.up.sql"
|
||||
|
||||
**返回：** 迁移列表和错误信息
|
||||
|
||||
**文件命名格式：** `{version}_{description}.up.sql`
|
||||
**支持的文件命名格式：**
|
||||
|
||||
**示例：**
|
||||
- `20240101000001_create_users_table.up.sql` - 升级文件
|
||||
- `20240101000001_create_users_table.down.sql` - 回滚文件（可选）
|
||||
1. **数字前缀格式**（新支持）：
|
||||
- `01_init_schema.sql`
|
||||
- `02_init_data.sql`
|
||||
- `03_add_log_schema.sql`
|
||||
|
||||
2. **时间戳格式**（现有）：
|
||||
- `20240101000001_create_users.sql`
|
||||
- `20240101000002_add_index.sql`
|
||||
|
||||
3. **带.up后缀格式**（现有）：
|
||||
- `20240101000001_create_users.up.sql` - 升级文件
|
||||
- `20240101000001_create_users.down.sql` - 回滚文件（可选）
|
||||
|
||||
**新特性：**
|
||||
- ✅ 自动识别文件命名格式（数字前缀或时间戳）
|
||||
- ✅ 自动分割多行 SQL 语句（按分号分割）
|
||||
- ✅ 自动处理注释（单行 `--` 和多行 `/* */`）
|
||||
- ✅ 自动跳过空行和空白字符
|
||||
- ✅ 支持一个文件包含多个 SQL 语句
|
||||
|
||||
#### GenerateVersion() string
|
||||
|
||||
|
||||
183
email/email.go
183
email/email.go
@@ -17,37 +17,43 @@ type Email struct {
|
||||
}
|
||||
|
||||
// NewEmail 创建邮件发送器
|
||||
func NewEmail(cfg *config.EmailConfig) (*Email, error) {
|
||||
if cfg == nil {
|
||||
func NewEmail(cfg *config.Config) *Email {
|
||||
if cfg == nil || cfg.Email == nil {
|
||||
return &Email{config: nil}
|
||||
}
|
||||
return &Email{config: cfg.Email}
|
||||
}
|
||||
|
||||
// getEmailConfig 获取邮件配置（内部方法）
|
||||
func (e *Email) getEmailConfig() (*config.EmailConfig, error) {
|
||||
if e.config == nil {
|
||||
return nil, fmt.Errorf("email config is nil")
|
||||
}
|
||||
|
||||
if cfg.Host == "" {
|
||||
if e.config.Host == "" {
|
||||
return nil, fmt.Errorf("email host is required")
|
||||
}
|
||||
|
||||
if cfg.Username == "" {
|
||||
if e.config.Username == "" {
|
||||
return nil, fmt.Errorf("email username is required")
|
||||
}
|
||||
|
||||
if cfg.Password == "" {
|
||||
if e.config.Password == "" {
|
||||
return nil, fmt.Errorf("email password is required")
|
||||
}
|
||||
|
||||
// 设置默认值
|
||||
if cfg.Port == 0 {
|
||||
cfg.Port = 587
|
||||
if e.config.Port == 0 {
|
||||
e.config.Port = 587
|
||||
}
|
||||
if cfg.From == "" {
|
||||
cfg.From = cfg.Username
|
||||
if e.config.From == "" {
|
||||
e.config.From = e.config.Username
|
||||
}
|
||||
if cfg.Timeout == 0 {
|
||||
cfg.Timeout = 30
|
||||
if e.config.Timeout == 0 {
|
||||
e.config.Timeout = 30
|
||||
}
|
||||
|
||||
return &Email{
|
||||
config: cfg,
|
||||
}, nil
|
||||
return e.config, nil
|
||||
}
|
||||
|
||||
// Message 邮件消息
|
||||
@@ -69,66 +75,91 @@ type Message struct {
|
||||
|
||||
// HTMLBody HTML正文（可选，如果设置了会优先使用）
|
||||
HTMLBody string
|
||||
|
||||
// Attachments 附件列表（可选）
|
||||
Attachments []Attachment
|
||||
}
|
||||
|
||||
// Attachment 附件
|
||||
type Attachment struct {
|
||||
// Filename 文件名
|
||||
Filename string
|
||||
|
||||
// Content 文件内容
|
||||
Content []byte
|
||||
|
||||
// ContentType 文件类型（如：application/pdf）
|
||||
ContentType string
|
||||
// SendEmail 发送邮件
|
||||
// to: 收件人列表
|
||||
// subject: 邮件主题
|
||||
// body: 邮件正文（纯文本）
|
||||
// htmlBody: HTML正文（可选，如果设置了会优先使用）
|
||||
func (e *Email) SendEmail(to []string, subject, body string, htmlBody ...string) error {
|
||||
cfg, err := e.getEmailConfig()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// SendRaw 发送原始邮件内容
|
||||
// recipients: 收件人列表（To、Cc、Bcc的合并列表）
|
||||
// body: 完整的邮件内容（MIME格式），由外部构建
|
||||
func (e *Email) SendRaw(recipients []string, body []byte) error {
|
||||
if len(recipients) == 0 {
|
||||
msg := &Message{
|
||||
To: to,
|
||||
Subject: subject,
|
||||
Body: body,
|
||||
}
|
||||
|
||||
if len(htmlBody) > 0 && htmlBody[0] != "" {
|
||||
msg.HTMLBody = htmlBody[0]
|
||||
}
|
||||
|
||||
return e.send(msg, cfg)
|
||||
}
|
||||
|
||||
// send 发送邮件（内部方法）
|
||||
func (e *Email) send(msg *Message, cfg *config.EmailConfig) error {
|
||||
if msg == nil {
|
||||
return fmt.Errorf("message is nil")
|
||||
}
|
||||
|
||||
if len(msg.To) == 0 {
|
||||
return fmt.Errorf("recipients are required")
|
||||
}
|
||||
|
||||
if len(body) == 0 {
|
||||
return fmt.Errorf("email body is required")
|
||||
if msg.Subject == "" {
|
||||
return fmt.Errorf("subject is required")
|
||||
}
|
||||
|
||||
if msg.Body == "" && msg.HTMLBody == "" {
|
||||
return fmt.Errorf("body or HTMLBody is required")
|
||||
}
|
||||
|
||||
// 构建邮件内容
|
||||
emailBody, err := e.buildEmailBody(msg, cfg)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to build email body: %w", err)
|
||||
}
|
||||
|
||||
// 合并收件人列表
|
||||
recipients := append(msg.To, msg.Cc...)
|
||||
recipients = append(recipients, msg.Bcc...)
|
||||
|
||||
// 连接SMTP服务器
|
||||
addr := fmt.Sprintf("%s:%d", e.config.Host, e.config.Port)
|
||||
auth := smtp.PlainAuth("", e.config.Username, e.config.Password, e.config.Host)
|
||||
addr := net.JoinHostPort(cfg.Host, fmt.Sprintf("%d", cfg.Port))
|
||||
auth := smtp.PlainAuth("", cfg.Username, cfg.Password, cfg.Host)
|
||||
|
||||
// 创建连接
|
||||
conn, err := net.DialTimeout("tcp", addr, time.Duration(e.config.Timeout)*time.Second)
|
||||
conn, err := net.DialTimeout("tcp", addr, time.Duration(cfg.Timeout)*time.Second)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to connect to SMTP server: %w", err)
|
||||
}
|
||||
defer conn.Close()
|
||||
|
||||
// 创建SMTP客户端
|
||||
client, err := smtp.NewClient(conn, e.config.Host)
|
||||
client, err := smtp.NewClient(conn, cfg.Host)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create SMTP client: %w", err)
|
||||
}
|
||||
defer client.Close()
|
||||
|
||||
// TLS/SSL处理
|
||||
if e.config.UseSSL {
|
||||
if cfg.UseSSL {
|
||||
// SSL模式（端口通常是465）
|
||||
tlsConfig := &tls.Config{
|
||||
ServerName: e.config.Host,
|
||||
ServerName: cfg.Host,
|
||||
}
|
||||
if err := client.StartTLS(tlsConfig); err != nil {
|
||||
return fmt.Errorf("failed to start TLS: %w", err)
|
||||
}
|
||||
} else if e.config.UseTLS {
|
||||
} else if cfg.UseTLS {
|
||||
// TLS模式（STARTTLS，端口通常是587）
|
||||
tlsConfig := &tls.Config{
|
||||
ServerName: e.config.Host,
|
||||
ServerName: cfg.Host,
|
||||
}
|
||||
if err := client.StartTLS(tlsConfig); err != nil {
|
||||
return fmt.Errorf("failed to start TLS: %w", err)
|
||||
@@ -141,7 +172,7 @@ func (e *Email) SendRaw(recipients []string, body []byte) error {
|
||||
}
|
||||
|
||||
// 设置发件人
|
||||
if err := client.Mail(e.config.From); err != nil {
|
||||
if err := client.Mail(cfg.From); err != nil {
|
||||
return fmt.Errorf("failed to set sender: %w", err)
|
||||
}
|
||||
|
||||
@@ -158,7 +189,7 @@ func (e *Email) SendRaw(recipients []string, body []byte) error {
|
||||
return fmt.Errorf("failed to get data writer: %w", err)
|
||||
}
|
||||
|
||||
_, err = writer.Write(body)
|
||||
_, err = writer.Write(emailBody)
|
||||
if err != nil {
|
||||
writer.Close()
|
||||
return fmt.Errorf("failed to write email body: %w", err)
|
||||
@@ -177,47 +208,14 @@ func (e *Email) SendRaw(recipients []string, body []byte) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Send 发送邮件（使用Message结构，内部会构建邮件内容）
|
||||
// 注意：如果需要完全控制邮件内容，请使用SendRaw方法
|
||||
func (e *Email) Send(msg *Message) error {
|
||||
if msg == nil {
|
||||
return fmt.Errorf("message is nil")
|
||||
}
|
||||
|
||||
if len(msg.To) == 0 {
|
||||
return fmt.Errorf("recipients are required")
|
||||
}
|
||||
|
||||
if msg.Subject == "" {
|
||||
return fmt.Errorf("subject is required")
|
||||
}
|
||||
|
||||
if msg.Body == "" && msg.HTMLBody == "" {
|
||||
return fmt.Errorf("body or HTMLBody is required")
|
||||
}
|
||||
|
||||
// 构建邮件内容
|
||||
emailBody, err := e.buildEmailBody(msg)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to build email body: %w", err)
|
||||
}
|
||||
|
||||
// 合并收件人列表
|
||||
recipients := append(msg.To, msg.Cc...)
|
||||
recipients = append(recipients, msg.Bcc...)
|
||||
|
||||
// 使用SendRaw发送
|
||||
return e.SendRaw(recipients, emailBody)
|
||||
}
|
||||
|
||||
// buildEmailBody 构建邮件内容
|
||||
func (e *Email) buildEmailBody(msg *Message) ([]byte, error) {
|
||||
func (e *Email) buildEmailBody(msg *Message, cfg *config.EmailConfig) ([]byte, error) {
|
||||
var buf bytes.Buffer
|
||||
|
||||
// 邮件头
|
||||
from := e.config.From
|
||||
if e.config.FromName != "" {
|
||||
from = fmt.Sprintf("%s <%s>", e.config.FromName, e.config.From)
|
||||
from := cfg.From
|
||||
if cfg.FromName != "" {
|
||||
from = fmt.Sprintf("%s <%s>", cfg.FromName, cfg.From)
|
||||
}
|
||||
buf.WriteString(fmt.Sprintf("From: %s\r\n", from))
|
||||
|
||||
@@ -281,26 +279,3 @@ func joinEmails(emails []string) string {
|
||||
return result
|
||||
}
|
||||
|
||||
// SendSimple 发送简单邮件（便捷方法）
|
||||
// to: 收件人
|
||||
// subject: 主题
|
||||
// body: 正文
|
||||
func (e *Email) SendSimple(to []string, subject, body string) error {
|
||||
return e.Send(&Message{
|
||||
To: to,
|
||||
Subject: subject,
|
||||
Body: body,
|
||||
})
|
||||
}
|
||||
|
||||
// SendHTML 发送HTML邮件（便捷方法）
|
||||
// to: 收件人
|
||||
// subject: 主题
|
||||
// htmlBody: HTML正文
|
||||
func (e *Email) SendHTML(to []string, subject, htmlBody string) error {
|
||||
return e.Send(&Message{
|
||||
To: to,
|
||||
Subject: subject,
|
||||
HTMLBody: htmlBody,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 设置默认时区
|
||||
err := datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 获取当前时间
|
||||
now := datetime.Now()
|
||||
fmt.Printf("Current time: %s\n", datetime.FormatDateTime(now))
|
||||
|
||||
// 解析时间字符串
|
||||
t, err := datetime.ParseDateTime("2024-01-01 12:00:00")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Parsed time: %s\n", datetime.FormatDateTime(t))
|
||||
|
||||
// 时区转换
|
||||
t2, err := datetime.ToTimezone(t, datetime.AmericaNewYork)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Time in New York: %s\n", datetime.FormatDateTime(t2))
|
||||
|
||||
// Unix时间戳
|
||||
unix := datetime.ToUnix(now)
|
||||
fmt.Printf("Unix timestamp: %d\n", unix)
|
||||
t3 := datetime.FromUnix(unix)
|
||||
fmt.Printf("From Unix: %s\n", datetime.FormatDateTime(t3))
|
||||
|
||||
// 时间计算
|
||||
tomorrow := datetime.AddDays(now, 1)
|
||||
fmt.Printf("Tomorrow: %s\n", datetime.FormatDate(tomorrow))
|
||||
|
||||
// 时间范围
|
||||
startOfDay := datetime.StartOfDay(now)
|
||||
endOfDay := datetime.EndOfDay(now)
|
||||
fmt.Printf("Start of day: %s\n", datetime.FormatDateTime(startOfDay))
|
||||
fmt.Printf("End of day: %s\n", datetime.FormatDateTime(endOfDay))
|
||||
|
||||
// 时间差
|
||||
diff := datetime.DiffDays(now, tomorrow)
|
||||
fmt.Printf("Days difference: %d\n", diff)
|
||||
}
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 示例1：将当前时间转换为UTC
|
||||
fmt.Println("=== Example 1: Convert Current Time to UTC ===")
|
||||
now := time.Now()
|
||||
utcTime := datetime.ToUTC(now)
|
||||
fmt.Printf("Local time: %s\n", datetime.FormatDateTime(now))
|
||||
fmt.Printf("UTC time: %s\n", datetime.FormatDateTime(utcTime))
|
||||
|
||||
// 示例2：从指定时区转换为UTC
|
||||
fmt.Println("\n=== Example 2: Convert from Specific Timezone to UTC ===")
|
||||
// 解析上海时区的时间
|
||||
shanghaiTime, err := datetime.ParseDateTime("2024-01-01 12:00:00", datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Shanghai time: %s\n", datetime.FormatDateTime(shanghaiTime, datetime.AsiaShanghai))
|
||||
|
||||
// 转换为UTC
|
||||
utcTime2, err := datetime.ToUTCFromTimezone(shanghaiTime, datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("UTC time: %s\n", datetime.FormatDateTime(utcTime2, datetime.UTC))
|
||||
|
||||
// 示例3：解析时间字符串并直接转换为UTC
|
||||
fmt.Println("\n=== Example 3: Parse and Convert to UTC ===")
|
||||
utcTime3, err := datetime.ParseDateTimeToUTC("2024-01-01 12:00:00", datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Parsed from Shanghai timezone, UTC: %s\n", datetime.FormatDateTime(utcTime3, datetime.UTC))
|
||||
|
||||
// 示例4：解析日期并转换为UTC
|
||||
fmt.Println("\n=== Example 4: Parse Date and Convert to UTC ===")
|
||||
utcTime4, err := datetime.ParseDateToUTC("2024-01-01", datetime.AsiaShanghai)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Date parsed from Shanghai timezone, UTC: %s\n", datetime.FormatDateTime(utcTime4, datetime.UTC))
|
||||
|
||||
// 示例5：数据库存储场景
|
||||
fmt.Println("\n=== Example 5: Database Storage Scenario ===")
|
||||
// 从请求中获取时间（假设是上海时区）
|
||||
requestTimeStr := "2024-01-01 12:00:00"
|
||||
requestTimezone := datetime.AsiaShanghai
|
||||
|
||||
// 转换为UTC时间（用于数据库存储）
|
||||
dbTime, err := datetime.ParseDateTimeToUTC(requestTimeStr, requestTimezone)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Printf("Request time (Shanghai): %s\n", requestTimeStr)
|
||||
fmt.Printf("Database time (UTC): %s\n", datetime.FormatDateTime(dbTime, datetime.UTC))
|
||||
|
||||
// 从数据库读取UTC时间，转换为用户时区显示
|
||||
userTimezone := datetime.AsiaShanghai
|
||||
displayTime, err := datetime.ToTimezone(dbTime, userTimezone)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Display time (Shanghai): %s\n", datetime.FormatDateTime(displayTime, userTimezone))
|
||||
}
|
||||
|
||||
166
examples/factory_blackbox_example.go
Normal file
166
examples/factory_blackbox_example.go
Normal file
@@ -0,0 +1,166 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
// 示例：Factory黑盒模式 - 最简化的使用方式
|
||||
//
|
||||
// 核心理念：
|
||||
//
|
||||
// 外部项目只需要传递一个配置文件路径，
|
||||
// 直接使用 factory 的黑盒方法，无需获取内部对象
|
||||
func main() {
|
||||
// ====== 第1步：创建工厂（只需要配置文件路径）======
|
||||
fac, err := factory.NewFactoryFromFile("config.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// ====== 第2步：使用黑盒方法（推荐）======
|
||||
|
||||
// 1. 获取中间件链（自动配置所有基础中间件）
|
||||
chain := fac.GetMiddlewareChain()
|
||||
|
||||
// 2. 添加项目特定的自定义中间件
|
||||
chain.Append(authMiddleware, metricsMiddleware)
|
||||
|
||||
// 3. 注册路由
|
||||
http.Handle("/api/users", chain.ThenFunc(handleUsers))
|
||||
http.Handle("/api/upload", chain.ThenFunc(handleUpload))
|
||||
|
||||
// 4. 启动服务
|
||||
log.Println("Server started on :8080")
|
||||
log.Fatal(http.ListenAndServe(":8080", nil))
|
||||
}
|
||||
|
||||
// ====== API处理器 ======
|
||||
|
||||
// 用户列表
|
||||
func handleUsers(w http.ResponseWriter, r *http.Request) {
|
||||
// 创建工厂（在处理器中也可以复用）
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 1. 使用数据库（需要获取对象，因为GORM很复杂）
|
||||
db, _ := fac.GetDatabase()
|
||||
var users []map[string]interface{}
|
||||
db.Table("users").Find(&users)
|
||||
|
||||
// 2. 使用Redis（黑盒方法，推荐）
|
||||
cacheKey := "users:list"
|
||||
cached, _ := fac.RedisGet(ctx, cacheKey)
|
||||
if cached != "" {
|
||||
fac.Success(w, cached)
|
||||
return
|
||||
}
|
||||
|
||||
// 3. 记录日志（黑盒方法，推荐）
|
||||
fac.LogInfof(map[string]interface{}{
|
||||
"action": "list_users",
|
||||
"count": len(users),
|
||||
}, "查询用户列表")
|
||||
|
||||
// 4. 缓存结果
|
||||
fac.RedisSet(ctx, cacheKey, users, 5*time.Minute)
|
||||
|
||||
fac.Success(w, users)
|
||||
}
|
||||
|
||||
// 文件上传
|
||||
func handleUpload(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 解析上传的文件
|
||||
file, header, err := r.FormFile("file")
|
||||
if err != nil {
|
||||
fac.LogError("文件上传失败: %v", err)
|
||||
fac.Error(w, 400, "文件上传失败")
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
// 上传文件（黑盒方法，自动选择OSS或MinIO）
|
||||
objectKey := "uploads/" + header.Filename
|
||||
url, err := fac.UploadFile(ctx, objectKey, file, header.Header.Get("Content-Type"))
|
||||
if err != nil {
|
||||
fac.LogError("文件上传到存储失败: %v", err)
|
||||
fac.Error(w, 500, "文件上传失败")
|
||||
return
|
||||
}
|
||||
|
||||
// 记录上传日志
|
||||
fac.LogInfof(map[string]interface{}{
|
||||
"filename": header.Filename,
|
||||
"size": header.Size,
|
||||
"url": url,
|
||||
}, "文件上传成功")
|
||||
|
||||
fac.Success(w, map[string]interface{}{
|
||||
"url": url,
|
||||
})
|
||||
}
|
||||
|
||||
// ====== 自定义中间件 ======
|
||||
|
||||
// 认证中间件
|
||||
func authMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
// 获取token
|
||||
token := r.Header.Get("Authorization")
|
||||
if token == "" {
|
||||
fac.Error(w, 401, "未授权")
|
||||
return
|
||||
}
|
||||
|
||||
// 从Redis验证token（黑盒方法）
|
||||
userID, err := fac.RedisGet(ctx, "token:"+token)
|
||||
if err != nil || userID == "" {
|
||||
fac.Error(w, 401, "token无效")
|
||||
return
|
||||
}
|
||||
|
||||
// 记录日志（黑盒方法）
|
||||
fac.LogInfof(map[string]interface{}{
|
||||
"user_id": userID,
|
||||
"path": r.URL.Path,
|
||||
}, "用户请求")
|
||||
|
||||
// 将用户ID存入context（或header）
|
||||
r.Header.Set("X-User-ID", userID)
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// 指标中间件
|
||||
func metricsMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
ctx := context.Background()
|
||||
|
||||
start := time.Now()
|
||||
|
||||
// 继续处理请求
|
||||
next.ServeHTTP(w, r)
|
||||
|
||||
// 记录请求耗时到Redis（黑盒方法）
|
||||
latency := time.Since(start).Milliseconds()
|
||||
key := "metrics:" + r.URL.Path
|
||||
fac.RedisSet(ctx, key, latency, time.Minute)
|
||||
|
||||
// 记录指标日志（黑盒方法）
|
||||
fac.LogDebugf(map[string]interface{}{
|
||||
"path": r.URL.Path,
|
||||
"latency": latency,
|
||||
}, "请求指标")
|
||||
})
|
||||
}
|
||||
@@ -1,186 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
"github.com/redis/go-redis/v9"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 方式1：直接从配置文件创建工厂（推荐）
|
||||
fac, err := factory.NewFactoryFromFile("./config/example.json")
|
||||
if err != nil {
|
||||
log.Fatal("Failed to create factory:", err)
|
||||
}
|
||||
|
||||
ctx := context.Background()
|
||||
|
||||
// ========== 日志记录（黑盒模式，推荐） ==========
|
||||
fac.LogInfo("应用启动")
|
||||
fac.LogDebug("调试信息: %s", "test")
|
||||
fac.LogWarn("警告信息")
|
||||
fac.LogError("错误信息: %v", fmt.Errorf("test error"))
|
||||
|
||||
// 带字段的日志
|
||||
fac.LogInfof(map[string]interface{}{
|
||||
"user_id": 123,
|
||||
"ip": "192.168.1.1",
|
||||
}, "用户登录成功")
|
||||
|
||||
fac.LogErrorf(map[string]interface{}{
|
||||
"error_code": 1001,
|
||||
"user_id": 123,
|
||||
}, "登录失败: %v", fmt.Errorf("invalid password"))
|
||||
|
||||
// ========== 邮件发送（黑盒模式，推荐） ==========
|
||||
err = fac.SendEmail(
|
||||
[]string{"user@example.com"},
|
||||
"验证码",
|
||||
"您的验证码是：123456",
|
||||
)
|
||||
if err != nil {
|
||||
fac.LogError("发送邮件失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("邮件发送成功")
|
||||
}
|
||||
|
||||
// HTML邮件
|
||||
err = fac.SendEmail(
|
||||
[]string{"user@example.com"},
|
||||
"欢迎",
|
||||
"纯文本内容",
|
||||
"<h1>HTML内容</h1>",
|
||||
)
|
||||
if err != nil {
|
||||
fac.LogError("发送HTML邮件失败: %v", err)
|
||||
}
|
||||
|
||||
// ========== 短信发送（黑盒模式，推荐） ==========
|
||||
resp, err := fac.SendSMS(
|
||||
[]string{"13800138000"},
|
||||
map[string]string{"code": "123456"},
|
||||
)
|
||||
if err != nil {
|
||||
fac.LogError("发送短信失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("短信发送成功: %s", resp.RequestID)
|
||||
}
|
||||
|
||||
// 指定模板代码
|
||||
resp, err = fac.SendSMS(
|
||||
[]string{"13800138000"},
|
||||
map[string]string{"code": "123456"},
|
||||
"SMS_123456789", // 模板代码
|
||||
)
|
||||
if err != nil {
|
||||
fac.LogError("发送短信失败: %v", err)
|
||||
}
|
||||
|
||||
// ========== 文件上传（黑盒模式，推荐，自动选择OSS或MinIO） ==========
|
||||
file, err := os.Open("test.jpg")
|
||||
if err == nil {
|
||||
defer file.Close()
|
||||
|
||||
url, err := fac.UploadFile(ctx, "images/test.jpg", file, "image/jpeg")
|
||||
if err != nil {
|
||||
fac.LogError("上传文件失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("文件上传成功: %s", url)
|
||||
}
|
||||
}
|
||||
|
||||
// ========== 获取文件URL（黑盒模式） ==========
|
||||
// 永久有效
|
||||
url, err := fac.GetFileURL("images/test.jpg", 0)
|
||||
if err != nil {
|
||||
fac.LogError("获取文件URL失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("文件URL: %s", url)
|
||||
}
|
||||
|
||||
// 临时访问URL（1小时后过期）
|
||||
url, err = fac.GetFileURL("images/test.jpg", 3600)
|
||||
if err != nil {
|
||||
fac.LogError("获取临时URL失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("临时URL: %s", url)
|
||||
}
|
||||
|
||||
// ========== Redis操作（黑盒模式，推荐） ==========
|
||||
// 设置值（不过期）
|
||||
err = fac.RedisSet(ctx, "user:123", "value")
|
||||
if err != nil {
|
||||
fac.LogError("Redis设置失败: %v", err)
|
||||
}
|
||||
|
||||
// 设置值（带过期时间）
|
||||
err = fac.RedisSet(ctx, "user:123", "value", time.Hour)
|
||||
if err != nil {
|
||||
fac.LogError("Redis设置失败: %v", err)
|
||||
}
|
||||
|
||||
// 获取值
|
||||
value, err := fac.RedisGet(ctx, "user:123")
|
||||
if err != nil {
|
||||
fac.LogError("Redis获取失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("Redis值: %s", value)
|
||||
}
|
||||
|
||||
// 删除键
|
||||
err = fac.RedisDelete(ctx, "user:123", "user:456")
|
||||
if err != nil {
|
||||
fac.LogError("Redis删除失败: %v", err)
|
||||
}
|
||||
|
||||
// 检查键是否存在
|
||||
exists, err := fac.RedisExists(ctx, "user:123")
|
||||
if err != nil {
|
||||
fac.LogError("Redis检查失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("键是否存在: %v", exists)
|
||||
}
|
||||
|
||||
// ========== 数据库操作（黑盒模式，获取对象） ==========
|
||||
db, err := fac.GetDatabase()
|
||||
if err != nil {
|
||||
fac.LogError("数据库连接失败: %v", err)
|
||||
} else {
|
||||
// 直接使用GORM，无需自己实现创建逻辑
|
||||
var count int64
|
||||
if err := db.Table("users").Count(&count).Error; err != nil {
|
||||
fac.LogError("查询用户数量失败: %v", err)
|
||||
} else {
|
||||
fac.LogInfo("用户数量: %d", count)
|
||||
}
|
||||
}
|
||||
|
||||
// ========== Redis操作（获取客户端对象，黑盒模式） ==========
|
||||
redisClient, err := fac.GetRedisClient()
|
||||
if err != nil {
|
||||
fac.LogError("Redis客户端不可用: %v", err)
|
||||
} else {
|
||||
// 直接使用Redis客户端，无需自己实现创建逻辑
|
||||
val, err := redisClient.Get(ctx, "test_key").Result()
|
||||
if err != nil && err != redis.Nil {
|
||||
fac.LogError("Redis错误: %v", err)
|
||||
} else if err == redis.Nil {
|
||||
fac.LogInfo("Redis键不存在")
|
||||
} else {
|
||||
fac.LogInfo("Redis值: %s", val)
|
||||
}
|
||||
|
||||
// 使用高级功能（如Hash操作）
|
||||
redisClient.HSet(ctx, "user:123", "name", "John")
|
||||
name, _ := redisClient.HGet(ctx, "user:123", "name").Result()
|
||||
fac.LogInfo("Redis Hash值: %s", name)
|
||||
}
|
||||
|
||||
|
||||
fac.LogInfo("示例执行完成")
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"net/http"
|
||||
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
// 用户结构
|
||||
@@ -14,15 +15,17 @@ type User struct {
|
||||
Email string `json:"email"`
|
||||
}
|
||||
|
||||
// 获取用户列表（使用Handler黑盒模式）
|
||||
func GetUserList(h *commonhttp.Handler) {
|
||||
// 获取分页参数（简洁方式）
|
||||
pagination := h.ParsePaginationRequest()
|
||||
// 获取用户列表（使用公共方法和factory）
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取分页参数（使用公共方法）
|
||||
pagination := commonhttp.ParsePaginationRequest(r)
|
||||
page := pagination.GetPage()
|
||||
pageSize := pagination.GetSize()
|
||||
|
||||
// 获取查询参数（简洁方式）
|
||||
_ = h.GetQuery("keyword", "") // 示例：获取查询参数
|
||||
// 获取查询参数（使用公共方法）
|
||||
_ = commonhttp.GetQuery(r, "keyword", "") // 示例：获取查询参数
|
||||
|
||||
// 模拟查询数据
|
||||
users := []User{
|
||||
@@ -31,26 +34,28 @@ func GetUserList(h *commonhttp.Handler) {
|
||||
}
|
||||
total := int64(100)
|
||||
|
||||
// 返回分页响应（简洁方式）
|
||||
h.SuccessPage(users, total, page, pageSize)
|
||||
// 返回分页响应（使用factory方法）
|
||||
fac.SuccessPage(w, users, total, page, pageSize)
|
||||
}
|
||||
|
||||
// 创建用户（使用Handler黑盒模式）
|
||||
func CreateUser(h *commonhttp.Handler) {
|
||||
// 解析请求体（简洁方式）
|
||||
// 创建用户（使用公共方法和factory）
|
||||
func CreateUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 解析请求体（使用公共方法）
|
||||
var req struct {
|
||||
Name string `json:"name"`
|
||||
Email string `json:"email"`
|
||||
}
|
||||
|
||||
if err := h.ParseJSON(&req); err != nil {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 参数验证
|
||||
if req.Name == "" {
|
||||
h.Error(1001, "用户名不能为空")
|
||||
fac.Error(w, 1001, "用户名不能为空")
|
||||
return
|
||||
}
|
||||
|
||||
@@ -61,49 +66,46 @@ func CreateUser(h *commonhttp.Handler) {
|
||||
Email: req.Email,
|
||||
}
|
||||
|
||||
// 返回成功响应（简洁方式）
|
||||
h.SuccessWithMessage("创建成功", user)
|
||||
// 返回成功响应（使用factory方法，统一Success方法）
|
||||
fac.Success(w, user, "创建成功")
|
||||
}
|
||||
|
||||
// 获取用户详情（使用Handler黑盒模式）
|
||||
func GetUser(h *commonhttp.Handler) {
|
||||
// 获取查询参数（简洁方式）
|
||||
id := h.GetQueryInt64("id", 0)
|
||||
// 获取用户详情（使用公共方法和factory）
|
||||
func GetUser(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
|
||||
// 获取查询参数（使用公共方法）
|
||||
id := commonhttp.GetQueryInt64(r, "id", 0)
|
||||
|
||||
if id == 0 {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "用户ID不能为空", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "用户ID不能为空", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 模拟查询用户
|
||||
if id == 1 {
|
||||
user := User{ID: 1, Name: "User1", Email: "user1@example.com"}
|
||||
h.Success(user)
|
||||
fac.Success(w, user)
|
||||
} else {
|
||||
h.Error(1002, "用户不存在")
|
||||
fac.Error(w, 1002, "用户不存在")
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
// 方式1：使用HandleFunc包装器（推荐，最简洁）
|
||||
http.HandleFunc("/users", commonhttp.HandleFunc(func(h *commonhttp.Handler) {
|
||||
switch h.Request().Method {
|
||||
// 使用标准http.HandleFunc
|
||||
http.HandleFunc("/users", func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.Method {
|
||||
case http.MethodGet:
|
||||
GetUserList(h)
|
||||
GetUserList(w, r)
|
||||
case http.MethodPost:
|
||||
CreateUser(h)
|
||||
CreateUser(w, r)
|
||||
default:
|
||||
h.WriteJSON(http.StatusMethodNotAllowed, 405, "方法不支持", nil)
|
||||
commonhttp.WriteJSON(w, http.StatusMethodNotAllowed, 405, "方法不支持", nil)
|
||||
}
|
||||
}))
|
||||
|
||||
// 方式2：手动创建Handler（需要更多控制时）
|
||||
http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
GetUser(h)
|
||||
})
|
||||
|
||||
http.HandleFunc("/user", GetUser)
|
||||
|
||||
log.Println("Server started on :8080")
|
||||
log.Fatal(http.ListenAndServe(":8080", nil))
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"net/http"
|
||||
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/factory"
|
||||
)
|
||||
|
||||
// ListUserRequest 用户列表请求（包含分页字段）
|
||||
@@ -20,21 +21,22 @@ type User struct {
|
||||
Email string `json:"email"`
|
||||
}
|
||||
|
||||
// 获取用户列表（使用Handler和PaginationRequest）
|
||||
func GetUserList(h *commonhttp.Handler) {
|
||||
// 获取用户列表（使用公共方法和factory）
|
||||
func GetUserList(w http.ResponseWriter, r *http.Request) {
|
||||
fac, _ := factory.NewFactoryFromFile("config.json")
|
||||
var req ListUserRequest
|
||||
|
||||
// 方式1：从JSON请求体解析（分页字段会自动解析）
|
||||
if h.Request().Method == http.MethodPost {
|
||||
if err := h.ParseJSON(&req); err != nil {
|
||||
h.WriteJSON(http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
if r.Method == http.MethodPost {
|
||||
if err := commonhttp.ParseJSON(r, &req); err != nil {
|
||||
commonhttp.WriteJSON(w, http.StatusBadRequest, 400, "请求参数解析失败", nil)
|
||||
return
|
||||
}
|
||||
} else {
|
||||
// 方式2：从查询参数解析分页
|
||||
pagination := h.ParsePaginationRequest()
|
||||
pagination := commonhttp.ParsePaginationRequest(r)
|
||||
req.PaginationRequest = *pagination
|
||||
req.Keyword = h.GetQuery("keyword", "")
|
||||
req.Keyword = commonhttp.GetQuery(r, "keyword", "")
|
||||
}
|
||||
|
||||
// 使用分页方法
|
||||
@@ -49,12 +51,12 @@ func GetUserList(h *commonhttp.Handler) {
|
||||
}
|
||||
total := int64(100)
|
||||
|
||||
// 返回分页响应
|
||||
h.SuccessPage(users, total, page, size)
|
||||
// 返回分页响应（使用factory方法）
|
||||
fac.SuccessPage(w, users, total, page, size)
|
||||
}
|
||||
|
||||
func main() {
|
||||
http.HandleFunc("/users", commonhttp.HandleFunc(GetUserList))
|
||||
http.HandleFunc("/users", GetUserList)
|
||||
|
||||
log.Println("Server started on :8080")
|
||||
log.Fatal(http.ListenAndServe(":8080", nil))
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/config"
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/logger"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
)
|
||||
|
||||
// 示例：完整的中间件配置
|
||||
// 包括：Recovery、Logging、RateLimit、CORS、Timezone
|
||||
func main() {
|
||||
// 1. 配置logger（异步模式，输出到文件和stdout）
|
||||
loggerConfig := &logger.LoggerConfig{
|
||||
Level: "info",
|
||||
Output: "both", // 同时输出到stdout和文件
|
||||
FilePath: "./logs/app.log",
|
||||
Async: true, // 异步模式
|
||||
BufferSize: 1000, // 缓冲区大小
|
||||
Prefix: "[API]", // 日志前缀
|
||||
}
|
||||
myLogger, err := logger.NewLogger(loggerConfig)
|
||||
if err != nil {
|
||||
log.Fatal("Failed to create logger:", err)
|
||||
}
|
||||
defer myLogger.Close() // 确保程序退出时关闭logger
|
||||
|
||||
// 2. 配置CORS
|
||||
corsConfig := &middleware.CORSConfig{
|
||||
AllowedOrigins: []string{"*"},
|
||||
AllowedMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
|
||||
AllowedHeaders: []string{"Content-Type", "Authorization", "X-Timezone"},
|
||||
ExposedHeaders: []string{"X-Total-Count"},
|
||||
AllowCredentials: false,
|
||||
MaxAge: 3600, // 1小时
|
||||
}
|
||||
|
||||
// 3. 配置日志中间件
|
||||
loggingConfig := &middleware.LoggingConfig{
|
||||
Logger: myLogger,
|
||||
SkipPaths: []string{"/health", "/metrics"}, // 跳过健康检查和监控接口
|
||||
}
|
||||
|
||||
// 4. 配置Recovery中间件
|
||||
recoveryConfig := &middleware.RecoveryConfig{
|
||||
Logger: myLogger,
|
||||
EnableStackTrace: true, // 启用堆栈跟踪
|
||||
CustomHandler: func(w http.ResponseWriter, r *http.Request, err interface{}) {
|
||||
// 使用统一的JSON响应格式
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
h.SystemError("服务器内部错误，请稍后重试")
|
||||
},
|
||||
}
|
||||
|
||||
// 5. 配置限流中间件（100请求/分钟）
|
||||
rateLimiter := middleware.NewTokenBucketLimiter(100, time.Minute)
|
||||
rateLimitConfig := &middleware.RateLimitConfig{
|
||||
Limiter: rateLimiter,
|
||||
OnRateLimitExceeded: func(w http.ResponseWriter, r *http.Request, key string) {
|
||||
// 记录限流事件
|
||||
myLogger.Warnf(map[string]interface{}{
|
||||
"key": key,
|
||||
"path": r.URL.Path,
|
||||
"ip": r.RemoteAddr,
|
||||
}, "Rate limit exceeded")
|
||||
},
|
||||
}
|
||||
|
||||
// 6. 创建中间件链（顺序很重要！）
|
||||
// 顺序：Recovery -> Logging -> RateLimit -> CORS -> Timezone
|
||||
chain := middleware.NewChain(
|
||||
middleware.Recovery(recoveryConfig), // 1. 最外层：捕获panic
|
||||
middleware.Logging(loggingConfig), // 2. 日志记录
|
||||
middleware.RateLimit(rateLimitConfig), // 3. 限流保护
|
||||
middleware.CORS(corsConfig), // 4. CORS处理
|
||||
middleware.Timezone, // 5. 时区处理
|
||||
)
|
||||
|
||||
// 7. 定义路由
|
||||
mux := http.NewServeMux()
|
||||
|
||||
// API路由（应用所有中间件）
|
||||
mux.Handle("/api/hello", chain.ThenFunc(handleHello))
|
||||
mux.Handle("/api/panic", chain.ThenFunc(handlePanic)) // 测试panic恢复
|
||||
mux.Handle("/api/users", chain.ThenFunc(handleUsers))
|
||||
|
||||
// 健康检查（不应用中间件链，直接处理）
|
||||
mux.HandleFunc("/health", handleHealth)
|
||||
mux.HandleFunc("/metrics", handleMetrics)
|
||||
|
||||
// 8. 启动服务器
|
||||
addr := ":8080"
|
||||
log.Printf("Server starting on %s", addr)
|
||||
log.Printf("Try: http://localhost%s/api/hello", addr)
|
||||
log.Printf("Health: http://localhost%s/health", addr)
|
||||
|
||||
if err := http.ListenAndServe(addr, mux); err != nil {
|
||||
log.Fatal("Server failed:", err)
|
||||
}
|
||||
}
|
||||
|
||||
// handleHello 示例处理器：返回问候信息
|
||||
func handleHello(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
|
||||
// 从Handler获取时区
|
||||
timezone := h.GetTimezone()
|
||||
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Hello, World!",
|
||||
"timezone": timezone,
|
||||
"method": r.Method,
|
||||
"path": r.URL.Path,
|
||||
})
|
||||
}
|
||||
|
||||
// handlePanic 示例处理器：测试panic恢复
|
||||
func handlePanic(w http.ResponseWriter, r *http.Request) {
|
||||
// 故意触发panic，测试Recovery中间件
|
||||
panic("This is a test panic!")
|
||||
}
|
||||
|
||||
// handleUsers 示例处理器：返回用户列表
|
||||
func handleUsers(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
|
||||
// 模拟用户数据
|
||||
users := []map[string]interface{}{
|
||||
{"id": 1, "name": "Alice"},
|
||||
{"id": 2, "name": "Bob"},
|
||||
{"id": 3, "name": "Charlie"},
|
||||
}
|
||||
|
||||
h.Success(users)
|
||||
}
|
||||
|
||||
// handleHealth 健康检查处理器（不应用中间件）
|
||||
func handleHealth(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/plain")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
w.Write([]byte("OK"))
|
||||
}
|
||||
|
||||
// handleMetrics 监控指标处理器（不应用中间件）
|
||||
func handleMetrics(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/plain")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
w.Write([]byte("metrics: ok"))
|
||||
}
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
commonhttp "git.toowon.com/jimmy/go-common/http"
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
)
|
||||
|
||||
// 示例：限流中间件的使用
|
||||
// 展示不同的限流策略
|
||||
func main() {
|
||||
// 策略1：按IP限流（10请求/分钟）
|
||||
ipLimitChain := middleware.NewChain(
|
||||
middleware.RateLimitByIP(10, time.Minute),
|
||||
)
|
||||
|
||||
// 策略2：按用户ID限流（100请求/分钟）
|
||||
limiter := middleware.NewTokenBucketLimiter(100, time.Minute)
|
||||
userLimitConfig := &middleware.RateLimitConfig{
|
||||
Limiter: limiter,
|
||||
KeyFunc: func(r *http.Request) string {
|
||||
// 从请求头获取用户ID
|
||||
userID := r.Header.Get("X-User-ID")
|
||||
if userID != "" {
|
||||
return "user:" + userID
|
||||
}
|
||||
// 没有用户ID则使用IP
|
||||
return "ip:" + r.RemoteAddr
|
||||
},
|
||||
OnRateLimitExceeded: func(w http.ResponseWriter, r *http.Request, key string) {
|
||||
log.Printf("Rate limit exceeded for key: %s, path: %s", key, r.URL.Path)
|
||||
},
|
||||
}
|
||||
userLimitChain := middleware.NewChain(
|
||||
middleware.RateLimit(userLimitConfig),
|
||||
)
|
||||
|
||||
// 路由1：按IP限流的API（严格限制）
|
||||
http.Handle("/api/public", ipLimitChain.ThenFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Public API - IP rate limited (10/min)",
|
||||
"tip": "Try refreshing quickly to see rate limiting",
|
||||
})
|
||||
}))
|
||||
|
||||
// 路由2：按用户ID限流的API（宽松限制）
|
||||
http.Handle("/api/private", userLimitChain.ThenFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
userID := r.Header.Get("X-User-ID")
|
||||
if userID == "" {
|
||||
h.Error(401, "Missing X-User-ID header")
|
||||
return
|
||||
}
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Private API - User rate limited (100/min)",
|
||||
"user_id": userID,
|
||||
})
|
||||
}))
|
||||
|
||||
// 路由3：无限流的API（用于测试对比）
|
||||
http.HandleFunc("/api/unlimited", func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
h.Success(map[string]interface{}{
|
||||
"message": "Unlimited API - No rate limiting",
|
||||
})
|
||||
})
|
||||
|
||||
// 启动服务器
|
||||
addr := ":8080"
|
||||
log.Printf("Server starting on %s", addr)
|
||||
log.Println("Test endpoints:")
|
||||
log.Printf(" - IP limited (10/min): http://localhost%s/api/public", addr)
|
||||
log.Printf(" - User limited (100/min): http://localhost%s/api/private (add X-User-ID header)", addr)
|
||||
log.Printf(" - No limit: http://localhost%s/api/unlimited", addr)
|
||||
log.Println("\nTest with curl:")
|
||||
log.Printf(" curl http://localhost%s/api/public", addr)
|
||||
log.Printf(" curl -H 'X-User-ID: user123' http://localhost%s/api/private", addr)
|
||||
log.Println("\nResponse headers:")
|
||||
log.Println(" X-RateLimit-Limit: Total allowed requests")
|
||||
log.Println(" X-RateLimit-Remaining: Remaining requests")
|
||||
log.Println(" X-RateLimit-Reset: Reset timestamp")
|
||||
|
||||
log.Fatal(http.ListenAndServe(addr, nil))
|
||||
}
|
||||
|
||||
@@ -21,13 +21,11 @@ func main() {
|
||||
|
||||
// 定义API处理器
|
||||
http.Handle("/api/hello", chain.ThenFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
h := commonhttp.NewHandler(w, r)
|
||||
// 获取时区（使用公共方法）
|
||||
timezone := commonhttp.GetTimezone(r)
|
||||
|
||||
// 获取时区
|
||||
timezone := h.GetTimezone()
|
||||
|
||||
// 返回响应
|
||||
h.Success(map[string]interface{}{
|
||||
// 返回响应（使用公共方法）
|
||||
commonhttp.Success(w, map[string]interface{}{
|
||||
"message": "Hello, World!",
|
||||
"timezone": timezone,
|
||||
})
|
||||
|
||||
@@ -1,58 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"gorm.io/driver/mysql"
|
||||
"gorm.io/gorm"
|
||||
"git.toowon.com/jimmy/go-common/migration"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 初始化数据库连接
|
||||
dsn := "user:password@tcp(localhost:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
|
||||
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 创建迁移器
|
||||
migrator := migration.NewMigrator(db)
|
||||
|
||||
// 添加迁移
|
||||
migrator.AddMigration(migration.Migration{
|
||||
Version: "20240101000001",
|
||||
Description: "create_users_table",
|
||||
Up: func(db *gorm.DB) error {
|
||||
return db.Exec(`
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id INT PRIMARY KEY AUTO_INCREMENT,
|
||||
name VARCHAR(255) NOT NULL,
|
||||
email VARCHAR(255) UNIQUE NOT NULL,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
)
|
||||
`).Error
|
||||
},
|
||||
Down: func(db *gorm.DB) error {
|
||||
return db.Exec("DROP TABLE IF EXISTS users").Error
|
||||
},
|
||||
})
|
||||
|
||||
// 执行迁移
|
||||
if err := migrator.Up(); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// 查看迁移状态
|
||||
status, err := migrator.Status()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
for _, s := range status {
|
||||
fmt.Printf("Version: %s, Description: %s, Applied: %v\n",
|
||||
s.Version, s.Description, s.Applied)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,105 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/migration"
|
||||
"gorm.io/driver/sqlite"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 初始化数据库连接（使用SQLite作为示例）
|
||||
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
|
||||
if err != nil {
|
||||
log.Fatal("Failed to connect to database:", err)
|
||||
}
|
||||
|
||||
// 创建迁移器
|
||||
migrator := migration.NewMigrator(db)
|
||||
|
||||
// 添加一些迁移
|
||||
migrator.AddMigrations(
|
||||
migration.Migration{
|
||||
Version: "20240101000001",
|
||||
Description: "create_users_table",
|
||||
Up: func(db *gorm.DB) error {
|
||||
return db.Exec(`
|
||||
CREATE TABLE users (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name VARCHAR(255) NOT NULL,
|
||||
email VARCHAR(255) UNIQUE NOT NULL
|
||||
)
|
||||
`).Error
|
||||
},
|
||||
Down: func(db *gorm.DB) error {
|
||||
return db.Exec("DROP TABLE IF EXISTS users").Error
|
||||
},
|
||||
},
|
||||
migration.Migration{
|
||||
Version: "20240101000002",
|
||||
Description: "add_created_at_to_users",
|
||||
Up: func(db *gorm.DB) error {
|
||||
return db.Exec("ALTER TABLE users ADD COLUMN created_at DATETIME").Error
|
||||
},
|
||||
Down: func(db *gorm.DB) error {
|
||||
return db.Exec("ALTER TABLE users DROP COLUMN created_at").Error
|
||||
},
|
||||
},
|
||||
)
|
||||
|
||||
// 执行迁移
|
||||
fmt.Println("=== Executing migrations ===")
|
||||
err = migrator.Up()
|
||||
if err != nil {
|
||||
log.Fatal("Failed to run migrations:", err)
|
||||
}
|
||||
|
||||
// 查看状态
|
||||
fmt.Println("\n=== Migration status ===")
|
||||
status, err := migrator.Status()
|
||||
if err != nil {
|
||||
log.Fatal("Failed to get status:", err)
|
||||
}
|
||||
for _, s := range status {
|
||||
fmt.Printf("Version: %s, Description: %s, Applied: %v\n",
|
||||
s.Version, s.Description, s.Applied)
|
||||
}
|
||||
|
||||
// 示例1：仅清空迁移记录（不回滚数据库变更）
|
||||
fmt.Println("\n=== Example 1: Reset migration records only ===")
|
||||
fmt.Println("Note: This only clears records, not database changes")
|
||||
// 直接调用（需要确认标志）
|
||||
// err = migrator.Reset(true)
|
||||
// if err != nil {
|
||||
// log.Fatal("Failed to reset:", err)
|
||||
// }
|
||||
|
||||
// 交互式确认（推荐）
|
||||
// 取消注释下面的代码来测试交互式重置
|
||||
// err = migrator.ResetWithConfirm()
|
||||
// if err != nil {
|
||||
// log.Fatal("Failed to reset with confirm:", err)
|
||||
// }
|
||||
|
||||
// 示例2：回滚所有迁移并清空记录
|
||||
fmt.Println("\n=== Example 2: Reset all migrations (rollback + clear records) ===")
|
||||
fmt.Println("Note: This will rollback all migrations and clear records")
|
||||
// 直接调用（需要确认标志）
|
||||
// err = migrator.ResetAll(true)
|
||||
// if err != nil {
|
||||
// log.Fatal("Failed to reset all:", err)
|
||||
// }
|
||||
|
||||
// 交互式确认（推荐）
|
||||
// 取消注释下面的代码来测试交互式重置
|
||||
// err = migrator.ResetAllWithConfirm()
|
||||
// if err != nil {
|
||||
// log.Fatal("Failed to reset all with confirm:", err)
|
||||
// }
|
||||
|
||||
fmt.Println("\nNote: Reset functions are commented out for safety.")
|
||||
fmt.Println("Uncomment the code above to test reset functionality.")
|
||||
}
|
||||
|
||||
@@ -110,10 +110,14 @@ func main() {
|
||||
}
|
||||
```
|
||||
|
||||
### 方式2：环境变量（Docker友好）
|
||||
### 方式2：使用配置文件（推荐）
|
||||
|
||||
```bash
|
||||
DATABASE_URL="mysql://root:password@localhost:3306/mydb" go run migrate.go up
|
||||
# 使用默认配置文件 config.json
|
||||
go run migrate.go up
|
||||
|
||||
# 或指定配置文件路径
|
||||
go run migrate.go up -config /path/to/config.json
|
||||
```
|
||||
|
||||
**Docker 中**：
|
||||
@@ -121,12 +125,13 @@ DATABASE_URL="mysql://root:password@localhost:3306/mydb" go run migrate.go up
|
||||
# docker-compose.yml
|
||||
services:
|
||||
app:
|
||||
environment:
|
||||
DATABASE_URL: mysql://root:password@db:3306/mydb
|
||||
volumes:
|
||||
# 挂载配置文件
|
||||
- ./config.json:/app/config.json:ro
|
||||
command: sh -c "go run migrate.go up && ./app"
|
||||
```
|
||||
|
||||
**注意**：Docker 中使用服务名（`db`），不是 `localhost`
|
||||
**注意**：配置文件中的数据库主机应使用服务名（`db`），不是 `localhost`
|
||||
|
||||
## 更多信息
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
279
http/handler.go
279
http/handler.go
@@ -1,279 +0,0 @@
|
||||
package http
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"strconv"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
)
|
||||
|
||||
// Handler HTTP处理器包装器，封装ResponseWriter和Request，提供简洁的API
|
||||
type Handler struct {
|
||||
w http.ResponseWriter
|
||||
r *http.Request
|
||||
}
|
||||
|
||||
// NewHandler 创建Handler实例
|
||||
func NewHandler(w http.ResponseWriter, r *http.Request) *Handler {
|
||||
return &Handler{
|
||||
w: w,
|
||||
r: r,
|
||||
}
|
||||
}
|
||||
|
||||
// ResponseWriter 获取原始的ResponseWriter（需要时使用）
|
||||
func (h *Handler) ResponseWriter() http.ResponseWriter {
|
||||
return h.w
|
||||
}
|
||||
|
||||
// Request 获取原始的Request（需要时使用）
|
||||
func (h *Handler) Request() *http.Request {
|
||||
return h.r
|
||||
}
|
||||
|
||||
// Context 获取请求的Context
|
||||
func (h *Handler) Context() context.Context {
|
||||
return h.r.Context()
|
||||
}
|
||||
|
||||
// ========== 响应方法（黑盒模式） ==========
|
||||
|
||||
// Success 成功响应
|
||||
// data: 响应数据，可以为nil
|
||||
func (h *Handler) Success(data interface{}) {
|
||||
writeJSON(h.w, http.StatusOK, 0, "success", data)
|
||||
}
|
||||
|
||||
// SuccessWithMessage 带消息的成功响应
|
||||
func (h *Handler) SuccessWithMessage(message string, data interface{}) {
|
||||
writeJSON(h.w, http.StatusOK, 0, message, data)
|
||||
}
|
||||
|
||||
// Error 错误响应
|
||||
// code: 业务错误码，非0表示业务错误
|
||||
// message: 错误消息
|
||||
func (h *Handler) Error(code int, message string) {
|
||||
writeJSON(h.w, http.StatusOK, code, message, nil)
|
||||
}
|
||||
|
||||
// SystemError 系统错误响应（返回HTTP 500）
|
||||
// message: 错误消息
|
||||
func (h *Handler) SystemError(message string) {
|
||||
writeJSON(h.w, http.StatusInternalServerError, 500, message, nil)
|
||||
}
|
||||
|
||||
// WriteJSON 写入JSON响应（自定义HTTP状态码和业务状态码）
|
||||
// httpCode: HTTP状态码（200表示正常，500表示系统错误等）
|
||||
// code: 业务状态码（0表示成功，非0表示业务错误）
|
||||
// message: 响应消息
|
||||
// data: 响应数据
|
||||
func (h *Handler) WriteJSON(httpCode, code int, message string, data interface{}) {
|
||||
writeJSON(h.w, httpCode, code, message, data)
|
||||
}
|
||||
|
||||
// SuccessPage 分页成功响应
|
||||
// list: 数据列表
|
||||
// total: 总记录数
|
||||
// page: 当前页码
|
||||
// pageSize: 每页大小
|
||||
// message: 响应消息（可选，如果为空则使用默认消息 "success"）
|
||||
func (h *Handler) SuccessPage(list interface{}, total int64, page, pageSize int, message ...string) {
|
||||
msg := "success"
|
||||
if len(message) > 0 && message[0] != "" {
|
||||
msg = message[0]
|
||||
}
|
||||
|
||||
pageData := &PageData{
|
||||
List: list,
|
||||
Total: total,
|
||||
Page: page,
|
||||
PageSize: pageSize,
|
||||
}
|
||||
|
||||
writeJSON(h.w, http.StatusOK, 0, msg, pageData)
|
||||
}
|
||||
|
||||
// ========== 请求解析方法（黑盒模式） ==========
|
||||
|
||||
// ParseJSON 解析JSON请求体
|
||||
// v: 目标结构体指针
|
||||
func (h *Handler) ParseJSON(v interface{}) error {
|
||||
body, err := io.ReadAll(h.r.Body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer h.r.Body.Close()
|
||||
|
||||
if len(body) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return json.Unmarshal(body, v)
|
||||
}
|
||||
|
||||
// GetQuery 获取查询参数
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func (h *Handler) GetQuery(key, defaultValue string) string {
|
||||
value := h.r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// GetQueryInt 获取整数查询参数
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func (h *Handler) GetQueryInt(key string, defaultValue int) int {
|
||||
value := h.r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.Atoi(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetQueryInt64 获取int64查询参数
|
||||
func (h *Handler) GetQueryInt64(key string, defaultValue int64) int64 {
|
||||
value := h.r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.ParseInt(value, 10, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetQueryBool 获取布尔查询参数
|
||||
func (h *Handler) GetQueryBool(key string, defaultValue bool) bool {
|
||||
value := h.r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
boolValue, err := strconv.ParseBool(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return boolValue
|
||||
}
|
||||
|
||||
// GetQueryFloat64 获取float64查询参数
|
||||
func (h *Handler) GetQueryFloat64(key string, defaultValue float64) float64 {
|
||||
value := h.r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
floatValue, err := strconv.ParseFloat(value, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return floatValue
|
||||
}
|
||||
|
||||
// GetFormValue 获取表单值
|
||||
func (h *Handler) GetFormValue(key, defaultValue string) string {
|
||||
value := h.r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// GetFormInt 获取表单整数
|
||||
func (h *Handler) GetFormInt(key string, defaultValue int) int {
|
||||
value := h.r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.Atoi(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetFormInt64 获取表单int64
|
||||
func (h *Handler) GetFormInt64(key string, defaultValue int64) int64 {
|
||||
value := h.r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.ParseInt(value, 10, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetFormBool 获取表单布尔值
|
||||
func (h *Handler) GetFormBool(key string, defaultValue bool) bool {
|
||||
value := h.r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
boolValue, err := strconv.ParseBool(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return boolValue
|
||||
}
|
||||
|
||||
// GetHeader 获取请求头
|
||||
func (h *Handler) GetHeader(key, defaultValue string) string {
|
||||
value := h.r.Header.Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// ParsePaginationRequest 从请求中解析分页参数
|
||||
// 支持从查询参数和form表单中解析
|
||||
// 优先级：查询参数 > form表单
|
||||
func (h *Handler) ParsePaginationRequest() *PaginationRequest {
|
||||
return ParsePaginationRequest(h.r)
|
||||
}
|
||||
|
||||
// GetTimezone 从请求的context中获取时区
|
||||
// 如果使用了middleware.Timezone中间件，可以从context中获取时区信息
|
||||
// 如果未设置，返回默认时区 AsiaShanghai
|
||||
func (h *Handler) GetTimezone() string {
|
||||
return middleware.GetTimezoneFromContext(h.r.Context())
|
||||
}
|
||||
|
||||
// HandleFunc 将Handler函数转换为标准的http.HandlerFunc
|
||||
// 这样可以将Handler函数直接用于http.HandleFunc
|
||||
// 示例：
|
||||
//
|
||||
// http.HandleFunc("/users", http.HandleFunc(func(h *http.Handler) {
|
||||
// h.Success(data)
|
||||
// }))
|
||||
func HandleFunc(fn func(*Handler)) http.HandlerFunc {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
h := NewHandler(w, r)
|
||||
fn(h)
|
||||
}
|
||||
}
|
||||
222
http/request.go
222
http/request.go
@@ -1,8 +1,12 @@
|
||||
package http
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"strconv"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/middleware"
|
||||
)
|
||||
|
||||
// getQueryInt 获取整数查询参数（内部方法，供ParsePaginationRequest使用）
|
||||
@@ -41,6 +45,7 @@ type PaginationRequest struct {
|
||||
Page int `json:"page" form:"page"` // 页码，默认1
|
||||
Size int `json:"size" form:"size"` // 每页数量（兼容旧版本）
|
||||
PageSize int `json:"page_size" form:"page_size"` // 每页数量（推荐使用）
|
||||
Keyword string `json:"keyword" form:"keyword"` // 关键字
|
||||
}
|
||||
|
||||
// GetPage 获取页码，如果未设置则返回默认值1
|
||||
@@ -114,3 +119,220 @@ func ParsePaginationRequest(r *http.Request) *PaginationRequest {
|
||||
|
||||
return req
|
||||
}
|
||||
|
||||
// ========== 请求解析公共方法 ==========
|
||||
|
||||
// ParseJSON 解析JSON请求体（公共方法）
|
||||
// r: HTTP请求
|
||||
// v: 目标结构体指针
|
||||
func ParseJSON(r *http.Request, v interface{}) error {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer r.Body.Close()
|
||||
|
||||
if len(body) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return json.Unmarshal(body, v)
|
||||
}
|
||||
|
||||
// GetQuery 获取查询参数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetQuery(r *http.Request, key, defaultValue string) string {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// GetQueryInt 获取整数查询参数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetQueryInt(r *http.Request, key string, defaultValue int) int {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.Atoi(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetQueryInt64 获取int64查询参数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetQueryInt64(r *http.Request, key string, defaultValue int64) int64 {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.ParseInt(value, 10, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetQueryBool 获取布尔查询参数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetQueryBool(r *http.Request, key string, defaultValue bool) bool {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
boolValue, err := strconv.ParseBool(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return boolValue
|
||||
}
|
||||
|
||||
// GetQueryFloat64 获取float64查询参数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetQueryFloat64(r *http.Request, key string, defaultValue float64) float64 {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
floatValue, err := strconv.ParseFloat(value, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return floatValue
|
||||
}
|
||||
|
||||
func GetQueryUint64(r *http.Request, key string, defaultValue uint64) uint64 {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
uintValue, err := strconv.ParseUint(value, 10, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return uintValue
|
||||
}
|
||||
|
||||
func GetQueryUint32(r *http.Request, key string, defaultValue uint32) uint32 {
|
||||
value := r.URL.Query().Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
uintValue, err := strconv.ParseUint(value, 10, 32)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return uint32(uintValue)
|
||||
}
|
||||
|
||||
// GetFormValue 获取表单值（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetFormValue(r *http.Request, key, defaultValue string) string {
|
||||
value := r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// GetFormInt 获取表单整数（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetFormInt(r *http.Request, key string, defaultValue int) int {
|
||||
value := r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.Atoi(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetFormInt64 获取表单int64（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetFormInt64(r *http.Request, key string, defaultValue int64) int64 {
|
||||
value := r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
intValue, err := strconv.ParseInt(value, 10, 64)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return intValue
|
||||
}
|
||||
|
||||
// GetFormBool 获取表单布尔值（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 参数名
|
||||
// defaultValue: 默认值
|
||||
func GetFormBool(r *http.Request, key string, defaultValue bool) bool {
|
||||
value := r.FormValue(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
boolValue, err := strconv.ParseBool(value)
|
||||
if err != nil {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return boolValue
|
||||
}
|
||||
|
||||
// GetHeader 获取请求头（公共方法）
|
||||
// r: HTTP请求
|
||||
// key: 请求头名称
|
||||
// defaultValue: 默认值
|
||||
func GetHeader(r *http.Request, key, defaultValue string) string {
|
||||
value := r.Header.Get(key)
|
||||
if value == "" {
|
||||
return defaultValue
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
// GetTimezone 从请求的context中获取时区（公共方法）
|
||||
// r: HTTP请求
|
||||
// 如果使用了middleware.Timezone中间件，可以从context中获取时区信息
|
||||
// 如果未设置，返回默认时区 AsiaShanghai
|
||||
func GetTimezone(r *http.Request) string {
|
||||
return middleware.GetTimezoneFromContext(r.Context())
|
||||
}
|
||||
|
||||
@@ -30,7 +30,7 @@ type PageData struct {
|
||||
PageSize int `json:"pageSize"` // 每页大小
|
||||
}
|
||||
|
||||
// writeJSON 写入JSON响应（内部方法）
|
||||
// writeJSON 写入JSON响应（公共方法）
|
||||
// httpCode: HTTP状态码（200表示正常，500表示系统错误等）
|
||||
// code: 业务状态码（0表示成功，非0表示业务错误）
|
||||
// message: 响应消息
|
||||
@@ -48,3 +48,58 @@ func writeJSON(w http.ResponseWriter, httpCode, code int, message string, data i
|
||||
|
||||
json.NewEncoder(w).Encode(response)
|
||||
}
|
||||
|
||||
// Success 成功响应（公共方法）
|
||||
// w: ResponseWriter
|
||||
// data: 响应数据，可以为nil
|
||||
// message: 响应消息（可选），如果为空则使用默认消息 "success"
|
||||
//
|
||||
// 使用方式：
|
||||
//
|
||||
// Success(w, data) // 只有数据，使用默认消息 "success"
|
||||
// Success(w, data, "查询成功") // 数据+消息
|
||||
func Success(w http.ResponseWriter, data interface{}, message ...string) {
|
||||
msg := "success"
|
||||
if len(message) > 0 && message[0] != "" {
|
||||
msg = message[0]
|
||||
}
|
||||
writeJSON(w, http.StatusOK, 0, msg, data)
|
||||
}
|
||||
|
||||
// SuccessPage 分页成功响应（公共方法）
|
||||
// w: ResponseWriter
|
||||
// list: 数据列表
|
||||
// total: 总记录数
|
||||
// page: 当前页码
|
||||
// pageSize: 每页大小
|
||||
// message: 响应消息（可选），如果为空则使用默认消息 "success"
|
||||
func SuccessPage(w http.ResponseWriter, list interface{}, total int64, page, pageSize int, message ...string) {
|
||||
msg := "success"
|
||||
if len(message) > 0 && message[0] != "" {
|
||||
msg = message[0]
|
||||
}
|
||||
|
||||
pageData := &PageData{
|
||||
List: list,
|
||||
Total: total,
|
||||
Page: page,
|
||||
PageSize: pageSize,
|
||||
}
|
||||
|
||||
writeJSON(w, http.StatusOK, 0, msg, pageData)
|
||||
}
|
||||
|
||||
// Error 错误响应（公共方法）
|
||||
// w: ResponseWriter
|
||||
// code: 业务错误码，非0表示业务错误
|
||||
// message: 错误消息
|
||||
func Error(w http.ResponseWriter, code int, message string) {
|
||||
writeJSON(w, http.StatusOK, code, message, nil)
|
||||
}
|
||||
|
||||
// SystemError 系统错误响应（返回HTTP 500）（公共方法）
|
||||
// w: ResponseWriter
|
||||
// message: 错误消息
|
||||
func SystemError(w http.ResponseWriter, message string) {
|
||||
writeJSON(w, http.StatusInternalServerError, 500, message, nil)
|
||||
}
|
||||
|
||||
@@ -123,7 +123,7 @@ func shouldSkipPath(path string, skipPaths []string) bool {
|
||||
// logHTTPRequest 记录HTTP请求日志
|
||||
func logHTTPRequest(log *logger.Logger, r *http.Request, rw *responseWriter, duration time.Duration) {
|
||||
// 获取客户端IP
|
||||
clientIP := getClientIP(r)
|
||||
clientIP := GetClientIP(r)
|
||||
|
||||
// 构建日志字段
|
||||
fields := map[string]interface{}{
|
||||
@@ -188,9 +188,9 @@ func formatValue(v interface{}) string {
|
||||
}
|
||||
}
|
||||
|
||||
// getClientIP 获取客户端真实IP
|
||||
// GetClientIP 获取客户端真实IP
|
||||
// 优先级：X-Forwarded-For > X-Real-IP > RemoteAddr
|
||||
func getClientIP(r *http.Request) string {
|
||||
func GetClientIP(r *http.Request) string {
|
||||
// 尝试从 X-Forwarded-For 获取
|
||||
xff := r.Header.Get("X-Forwarded-For")
|
||||
if xff != "" {
|
||||
|
||||
@@ -169,7 +169,7 @@ func RateLimit(config *RateLimitConfig) func(http.Handler) http.Handler {
|
||||
// 如果没有提供KeyFunc，使用默认的（客户端IP）
|
||||
if config.KeyFunc == nil {
|
||||
config.KeyFunc = func(r *http.Request) string {
|
||||
return getClientIP(r)
|
||||
return GetClientIP(r)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -223,7 +223,7 @@ func RateLimitByIP(rate int, windowSize time.Duration) func(http.Handler) http.H
|
||||
return RateLimit(&RateLimitConfig{
|
||||
Limiter: NewTokenBucketLimiter(rate, windowSize),
|
||||
KeyFunc: func(r *http.Request) string {
|
||||
return getClientIP(r)
|
||||
return GetClientIP(r)
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
@@ -109,7 +109,7 @@ func logPanic(log *logger.Logger, r *http.Request, err interface{}, enableStackT
|
||||
"method": r.Method,
|
||||
"path": r.URL.Path,
|
||||
"query": r.URL.RawQuery,
|
||||
"ip": getClientIP(r),
|
||||
"ip": GetClientIP(r),
|
||||
"error": fmt.Sprintf("%v", err),
|
||||
}
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"net/http"
|
||||
|
||||
"git.toowon.com/jimmy/go-common/datetime"
|
||||
"git.toowon.com/jimmy/go-common/tools"
|
||||
)
|
||||
|
||||
// TimezoneKey context中存储时区的key
|
||||
@@ -14,7 +14,7 @@ type timezoneKey struct{}
|
||||
const TimezoneHeaderName = "X-Timezone"
|
||||
|
||||
// DefaultTimezone 默认时区
|
||||
const DefaultTimezone = datetime.AsiaShanghai
|
||||
const DefaultTimezone = tools.AsiaShanghai
|
||||
|
||||
// GetTimezoneFromContext 从context中获取时区
|
||||
func GetTimezoneFromContext(ctx context.Context) string {
|
||||
@@ -38,7 +38,7 @@ func Timezone(next http.Handler) http.Handler {
|
||||
}
|
||||
|
||||
// 验证时区是否有效
|
||||
if _, err := datetime.GetLocation(timezone); err != nil {
|
||||
if _, err := tools.GetLocation(timezone); err != nil {
|
||||
// 如果时区无效，使用默认时区
|
||||
timezone = DefaultTimezone
|
||||
}
|
||||
@@ -53,7 +53,7 @@ func Timezone(next http.Handler) http.Handler {
|
||||
// defaultTimezone: 默认时区，如果未指定则使用 AsiaShanghai
|
||||
func TimezoneWithDefault(defaultTimezone string) func(http.Handler) http.Handler {
|
||||
// 验证默认时区是否有效
|
||||
if _, err := datetime.GetLocation(defaultTimezone); err != nil {
|
||||
if _, err := tools.GetLocation(defaultTimezone); err != nil {
|
||||
defaultTimezone = DefaultTimezone
|
||||
}
|
||||
|
||||
@@ -68,7 +68,7 @@ func TimezoneWithDefault(defaultTimezone string) func(http.Handler) http.Handler
|
||||
}
|
||||
|
||||
// 验证时区是否有效
|
||||
if _, err := datetime.GetLocation(timezone); err != nil {
|
||||
if _, err := tools.GetLocation(timezone); err != nil {
|
||||
// 如果时区无效，使用默认时区
|
||||
timezone = defaultTimezone
|
||||
}
|
||||
@@ -79,4 +79,3 @@ func TimezoneWithDefault(defaultTimezone string) func(http.Handler) http.Handler
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -25,46 +25,38 @@ import (
|
||||
//
|
||||
// import "git.toowon.com/jimmy/go-common/migration"
|
||||
// migration.RunMigrationsFromConfig("config.json", "migrations")
|
||||
// // 或使用默认迁移目录
|
||||
// migration.RunMigrationsFromConfig("config.json", "")
|
||||
func RunMigrationsFromConfig(configFile, migrationsDir string) error {
|
||||
// 加载配置
|
||||
cfg, err := loadConfigFromFileOrEnv(configFile)
|
||||
if err != nil {
|
||||
return fmt.Errorf("加载配置失败: %w", err)
|
||||
return RunMigrationsFromConfigWithCommand(configFile, migrationsDir, "up")
|
||||
}
|
||||
|
||||
// 连接数据库
|
||||
db, err := connectDB(cfg)
|
||||
if err != nil {
|
||||
return fmt.Errorf("连接数据库失败: %w", err)
|
||||
}
|
||||
|
||||
// 创建迁移器
|
||||
migrator := NewMigrator(db)
|
||||
|
||||
// 加载迁移文件
|
||||
migrations, err := LoadMigrationsFromFiles(migrationsDir, "*.sql")
|
||||
if err != nil {
|
||||
return fmt.Errorf("加载迁移文件失败: %w", err)
|
||||
}
|
||||
|
||||
if len(migrations) == 0 {
|
||||
fmt.Printf("在目录 '%s' 中没有找到迁移文件\n", migrationsDir)
|
||||
return nil
|
||||
}
|
||||
|
||||
migrator.AddMigrations(migrations...)
|
||||
|
||||
// 执行迁移
|
||||
if err := migrator.Up(); err != nil {
|
||||
return fmt.Errorf("执行迁移失败: %w", err)
|
||||
}
|
||||
|
||||
fmt.Println("✓ 迁移执行成功")
|
||||
return nil
|
||||
}
|
||||
|
||||
// RunMigrationsFromConfigWithCommand 从配置文件运行迁移（支持命令）
|
||||
// command: "up", "down", "status"
|
||||
// RunMigrationsFromConfigWithCommand 从配置文件运行迁移（支持命令，黑盒模式）
|
||||
//
|
||||
// 这是最简单的迁移方式，内部自动处理：
|
||||
// - 配置加载（支持配置文件、默认路径）
|
||||
// - 数据库连接（自动识别数据库类型）
|
||||
// - 迁移文件加载和执行
|
||||
//
|
||||
// 参数：
|
||||
// - configFile: 配置文件路径，支持：
|
||||
// - 空字符串：自动查找（config.json, ../config.json）
|
||||
// - 相对路径或绝对路径：指定配置文件路径
|
||||
// - migrationsDir: 迁移文件目录，支持：
|
||||
// - 空字符串：使用默认目录 "migrations"
|
||||
// - 相对路径或绝对路径
|
||||
// - command: 命令，支持 "up", "down", "status"
|
||||
//
|
||||
// 使用示例：
|
||||
//
|
||||
// // 最简单：使用默认配置和默认迁移目录
|
||||
// migration.RunMigrationsFromConfigWithCommand("", "", "up")
|
||||
//
|
||||
// // 指定配置文件，使用默认迁移目录
|
||||
// migration.RunMigrationsFromConfigWithCommand("config.json", "", "up")
|
||||
//
|
||||
// // 指定配置和迁移目录
|
||||
// migration.RunMigrationsFromConfigWithCommand("config.json", "scripts/sql", "up")
|
||||
func RunMigrationsFromConfigWithCommand(configFile, migrationsDir, command string) error {
|
||||
// 加载配置
|
||||
cfg, err := loadConfigFromFileOrEnv(configFile)
|
||||
@@ -78,8 +70,13 @@ func RunMigrationsFromConfigWithCommand(configFile, migrationsDir, command strin
|
||||
return fmt.Errorf("连接数据库失败: %w", err)
|
||||
}
|
||||
|
||||
// 创建迁移器
|
||||
migrator := NewMigrator(db)
|
||||
// 使用默认迁移目录（如果未指定）
|
||||
if migrationsDir == "" {
|
||||
migrationsDir = "migrations"
|
||||
}
|
||||
|
||||
// 创建迁移器（传入数据库类型，性能更好）
|
||||
migrator := NewMigratorWithType(db, cfg.Database.Type)
|
||||
|
||||
// 加载迁移文件
|
||||
migrations, err := LoadMigrationsFromFiles(migrationsDir, "*.sql")
|
||||
@@ -122,22 +119,16 @@ func RunMigrationsFromConfigWithCommand(configFile, migrationsDir, command strin
|
||||
return nil
|
||||
}
|
||||
|
||||
// loadConfigFromFileOrEnv 从文件或环境变量加载配置
|
||||
// loadConfigFromFileOrEnv 从配置文件加载配置
|
||||
// 支持指定配置文件路径，或自动查找默认路径
|
||||
func loadConfigFromFileOrEnv(configFile string) (*config.Config, error) {
|
||||
// 优先从环境变量加载
|
||||
if dbURL := os.Getenv("DATABASE_URL"); dbURL != "" {
|
||||
return &config.Config{
|
||||
Database: &config.DatabaseConfig{
|
||||
DSN: dbURL,
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
// 尝试从配置文件加载
|
||||
// 如果指定了配置文件路径，优先使用
|
||||
if configFile != "" {
|
||||
if _, err := os.Stat(configFile); err == nil {
|
||||
return config.LoadFromFile(configFile)
|
||||
}
|
||||
// 如果指定的文件不存在，返回错误
|
||||
return nil, fmt.Errorf("配置文件不存在: %s", configFile)
|
||||
}
|
||||
|
||||
// 尝试默认路径
|
||||
@@ -148,10 +139,11 @@ func loadConfigFromFileOrEnv(configFile string) (*config.Config, error) {
|
||||
}
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("未找到配置文件，也未设置环境变量 DATABASE_URL")
|
||||
return nil, fmt.Errorf("未找到配置文件，请指定配置文件路径或确保存在以下文件之一: %v", defaultPaths)
|
||||
}
|
||||
|
||||
// connectDB 连接数据库
|
||||
// 与 factory.getDatabase 保持一致的实现，避免代码重复
|
||||
func connectDB(cfg *config.Config) (*gorm.DB, error) {
|
||||
if cfg.Database == nil {
|
||||
return nil, fmt.Errorf("数据库配置为空")
|
||||
@@ -178,15 +170,30 @@ func connectDB(cfg *config.Config) (*gorm.DB, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 配置连接池
|
||||
// 配置连接池（与 factory.getDatabase 保持一致）
|
||||
sqlDB, err := db.DB()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
sqlDB.SetMaxOpenConns(10)
|
||||
sqlDB.SetMaxIdleConns(5)
|
||||
sqlDB.SetConnMaxLifetime(time.Hour)
|
||||
// 使用配置文件中的连接池参数，如果没有配置则使用默认值
|
||||
if cfg.Database.MaxOpenConns > 0 {
|
||||
sqlDB.SetMaxOpenConns(cfg.Database.MaxOpenConns)
|
||||
} else {
|
||||
sqlDB.SetMaxOpenConns(10) // 默认值
|
||||
}
|
||||
|
||||
if cfg.Database.MaxIdleConns > 0 {
|
||||
sqlDB.SetMaxIdleConns(cfg.Database.MaxIdleConns)
|
||||
} else {
|
||||
sqlDB.SetMaxIdleConns(5) // 默认值
|
||||
}
|
||||
|
||||
if cfg.Database.ConnMaxLifetime > 0 {
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(cfg.Database.ConnMaxLifetime) * time.Second)
|
||||
} else {
|
||||
sqlDB.SetConnMaxLifetime(time.Hour) // 默认值
|
||||
}
|
||||
|
||||
return db, nil
|
||||
}
|
||||
@@ -213,4 +220,3 @@ func printMigrationStatus(status []MigrationStatus) {
|
||||
fmt.Println("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
|
||||
fmt.Println()
|
||||
}
|
||||
|
||||
|
||||
@@ -26,6 +26,7 @@ type Migrator struct {
|
||||
db *gorm.DB
|
||||
migrations []Migration
|
||||
tableName string
|
||||
dbType string // 数据库类型: mysql, postgres, sqlite
|
||||
}
|
||||
|
||||
// NewMigrator 创建新的迁移器
|
||||
@@ -41,6 +42,25 @@ func NewMigrator(db *gorm.DB, tableName ...string) *Migrator {
|
||||
db: db,
|
||||
migrations: make([]Migration, 0),
|
||||
tableName: table,
|
||||
dbType: "", // 未指定时为空，会使用兼容模式
|
||||
}
|
||||
}
|
||||
|
||||
// NewMigratorWithType 创建新的迁移器（指定数据库类型，性能更好）
|
||||
// db: GORM数据库连接
|
||||
// dbType: 数据库类型 ("mysql", "postgres", "sqlite")
|
||||
// tableName: 存储迁移记录的表名，默认为 "schema_migrations"
|
||||
func NewMigratorWithType(db *gorm.DB, dbType string, tableName ...string) *Migrator {
|
||||
table := "schema_migrations"
|
||||
if len(tableName) > 0 && tableName[0] != "" {
|
||||
table = tableName[0]
|
||||
}
|
||||
|
||||
return &Migrator{
|
||||
db: db,
|
||||
migrations: make([]Migration, 0),
|
||||
tableName: table,
|
||||
dbType: dbType,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -56,33 +76,152 @@ func (m *Migrator) AddMigrations(migrations ...Migration) {
|
||||
|
||||
// initTable 初始化迁移记录表
|
||||
func (m *Migrator) initTable() error {
|
||||
// 检查表是否存在
|
||||
// 检查表是否存在（根据数据库类型使用对应的SQL，性能更好）
|
||||
var exists bool
|
||||
err := m.db.Raw(fmt.Sprintf(`
|
||||
var err error
|
||||
|
||||
switch m.dbType {
|
||||
case "mysql":
|
||||
// MySQL/MariaDB语法
|
||||
var count int64
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*) FROM information_schema.tables
|
||||
WHERE table_schema = DATABASE()
|
||||
AND table_name = '%s'
|
||||
`, m.tableName)).Scan(&count).Error
|
||||
if err == nil {
|
||||
exists = count > 0
|
||||
}
|
||||
case "postgres":
|
||||
// PostgreSQL语法
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT EXISTS (
|
||||
SELECT FROM information_schema.tables
|
||||
SELECT 1 FROM information_schema.tables
|
||||
WHERE table_schema = CURRENT_SCHEMA()
|
||||
AND table_name = '%s'
|
||||
)
|
||||
`, m.tableName)).Scan(&exists).Error
|
||||
case "sqlite":
|
||||
// SQLite语法
|
||||
var count int64
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*) FROM sqlite_master
|
||||
WHERE type='table' AND name='%s'
|
||||
`, m.tableName)).Scan(&count).Error
|
||||
if err == nil {
|
||||
exists = count > 0
|
||||
}
|
||||
default:
|
||||
// 未指定数据库类型时，使用兼容模式（向后兼容）
|
||||
// 按顺序尝试不同数据库的语法
|
||||
var count int64
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*) FROM information_schema.tables
|
||||
WHERE table_schema = DATABASE()
|
||||
AND table_name = '%s'
|
||||
`, m.tableName)).Scan(&count).Error
|
||||
if err == nil && count > 0 {
|
||||
exists = true
|
||||
} else {
|
||||
var pgExists bool
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT EXISTS (
|
||||
SELECT 1 FROM information_schema.tables
|
||||
WHERE table_schema = CURRENT_SCHEMA()
|
||||
AND table_name = '%s'
|
||||
)
|
||||
`, m.tableName)).Scan(&pgExists).Error
|
||||
if err == nil {
|
||||
exists = pgExists
|
||||
} else {
|
||||
var sqliteCount int64
|
||||
err = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*) FROM sqlite_master
|
||||
WHERE type='table' AND name='%s'
|
||||
`, m.tableName)).Scan(&sqliteCount).Error
|
||||
if err == nil && sqliteCount > 0 {
|
||||
exists = true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 如果查询失败，假设表不存在，尝试创建
|
||||
if err != nil {
|
||||
// 如果查询失败，可能是SQLite或其他数据库，尝试直接创建
|
||||
exists = false
|
||||
}
|
||||
|
||||
if !exists {
|
||||
// 创建迁移记录表
|
||||
// 创建迁移记录表（包含执行时间字段）
|
||||
err = m.db.Exec(fmt.Sprintf(`
|
||||
CREATE TABLE IF NOT EXISTS %s (
|
||||
version VARCHAR(255) PRIMARY KEY,
|
||||
description VARCHAR(255),
|
||||
applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
execution_time INT COMMENT '执行耗时(ms)'
|
||||
)
|
||||
`, m.tableName)).Error
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create migration table: %w", err)
|
||||
}
|
||||
} else {
|
||||
// 表已存在，检查是否有 execution_time 字段（向后兼容）
|
||||
// 注意：这个检查可能在某些数据库中失败，但不影响功能
|
||||
// 如果字段不存在，记录执行时间时会失败，但不影响迁移执行
|
||||
var hasExecutionTime bool
|
||||
var columnCount int64
|
||||
var checkErr error
|
||||
|
||||
switch m.dbType {
|
||||
case "mysql":
|
||||
// MySQL/MariaDB语法
|
||||
checkErr = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*)
|
||||
FROM information_schema.columns
|
||||
WHERE table_schema = DATABASE()
|
||||
AND table_name = '%s'
|
||||
AND column_name = 'execution_time'
|
||||
`, m.tableName)).Scan(&columnCount).Error
|
||||
if checkErr == nil {
|
||||
hasExecutionTime = columnCount > 0
|
||||
}
|
||||
case "postgres":
|
||||
// PostgreSQL语法
|
||||
checkErr = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*)
|
||||
FROM information_schema.columns
|
||||
WHERE table_schema = CURRENT_SCHEMA()
|
||||
AND table_name = '%s'
|
||||
AND column_name = 'execution_time'
|
||||
`, m.tableName)).Scan(&columnCount).Error
|
||||
if checkErr == nil {
|
||||
hasExecutionTime = columnCount > 0
|
||||
}
|
||||
case "sqlite":
|
||||
// SQLite不支持information_schema，跳过检查
|
||||
hasExecutionTime = false
|
||||
default:
|
||||
// 兼容模式：尝试MySQL语法
|
||||
checkErr = m.db.Raw(fmt.Sprintf(`
|
||||
SELECT COUNT(*)
|
||||
FROM information_schema.columns
|
||||
WHERE table_schema = DATABASE()
|
||||
AND table_name = '%s'
|
||||
AND column_name = 'execution_time'
|
||||
`, m.tableName)).Scan(&columnCount).Error
|
||||
if checkErr == nil {
|
||||
hasExecutionTime = columnCount > 0
|
||||
}
|
||||
}
|
||||
|
||||
if !hasExecutionTime {
|
||||
// 尝试添加字段（如果失败不影响功能）
|
||||
// 注意：SQLite的ALTER TABLE ADD COLUMN语法略有不同，但GORM会处理
|
||||
_ = m.db.Exec(fmt.Sprintf(`
|
||||
ALTER TABLE %s
|
||||
ADD COLUMN execution_time INT
|
||||
`, m.tableName))
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -109,17 +248,34 @@ func (m *Migrator) getAppliedMigrations() (map[string]bool, error) {
|
||||
}
|
||||
|
||||
// recordMigration 记录迁移
|
||||
func (m *Migrator) recordMigration(version, description string, isUp bool) error {
|
||||
func (m *Migrator) recordMigration(version, description string, isUp bool, executionTime ...int) error {
|
||||
if err := m.initTable(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if isUp {
|
||||
// 记录迁移
|
||||
err := m.db.Exec(fmt.Sprintf(`
|
||||
// 记录迁移（包含执行时间，如果提供了）
|
||||
var err error
|
||||
if len(executionTime) > 0 && executionTime[0] > 0 {
|
||||
// 尝试插入执行时间（如果字段存在）
|
||||
err = m.db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at, execution_time)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now(), executionTime[0]).Error
|
||||
if err != nil {
|
||||
// 如果失败（可能是字段不存在），尝试不包含执行时间
|
||||
err = m.db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at)
|
||||
VALUES (?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now()).Error
|
||||
}
|
||||
} else {
|
||||
// 不包含执行时间
|
||||
err = m.db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at)
|
||||
VALUES (?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now()).Error
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to record migration: %w", err)
|
||||
}
|
||||
@@ -160,6 +316,9 @@ func (m *Migrator) Up() error {
|
||||
return fmt.Errorf("migration %s has no Up function", migration.Version)
|
||||
}
|
||||
|
||||
// 记录开始时间
|
||||
startTime := time.Now()
|
||||
|
||||
// 开始事务
|
||||
tx := m.db.Begin()
|
||||
if tx.Error != nil {
|
||||
@@ -172,8 +331,11 @@ func (m *Migrator) Up() error {
|
||||
return fmt.Errorf("failed to apply migration %s: %w", migration.Version, err)
|
||||
}
|
||||
|
||||
// 记录迁移
|
||||
if err := m.recordMigrationWithDB(tx, migration.Version, migration.Description, true); err != nil {
|
||||
// 计算执行时间（毫秒）
|
||||
executionTime := int(time.Since(startTime).Milliseconds())
|
||||
|
||||
// 记录迁移（包含执行时间）
|
||||
if err := m.recordMigrationWithDB(tx, migration.Version, migration.Description, true, executionTime); err != nil {
|
||||
tx.Rollback()
|
||||
return err
|
||||
}
|
||||
@@ -183,7 +345,7 @@ func (m *Migrator) Up() error {
|
||||
return fmt.Errorf("failed to commit migration %s: %w", migration.Version, err)
|
||||
}
|
||||
|
||||
fmt.Printf("Applied migration: %s - %s\n", migration.Version, migration.Description)
|
||||
fmt.Printf("Applied migration: %s - %s (耗时: %dms)\n", migration.Version, migration.Description, executionTime)
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -246,12 +408,29 @@ func (m *Migrator) Down() error {
|
||||
}
|
||||
|
||||
// recordMigrationWithDB 使用指定的数据库连接记录迁移
|
||||
func (m *Migrator) recordMigrationWithDB(db *gorm.DB, version, description string, isUp bool) error {
|
||||
func (m *Migrator) recordMigrationWithDB(db *gorm.DB, version, description string, isUp bool, executionTime ...int) error {
|
||||
if isUp {
|
||||
err := db.Exec(fmt.Sprintf(`
|
||||
var err error
|
||||
if len(executionTime) > 0 && executionTime[0] > 0 {
|
||||
// 尝试插入执行时间（如果字段存在）
|
||||
err = db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at, execution_time)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now(), executionTime[0]).Error
|
||||
if err != nil {
|
||||
// 如果失败（可能是字段不存在），尝试不包含执行时间
|
||||
err = db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at)
|
||||
VALUES (?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now()).Error
|
||||
}
|
||||
} else {
|
||||
// 不包含执行时间
|
||||
err = db.Exec(fmt.Sprintf(`
|
||||
INSERT INTO %s (version, description, applied_at)
|
||||
VALUES (?, ?, ?)
|
||||
`, m.tableName), version, description, time.Now()).Error
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to record migration: %w", err)
|
||||
}
|
||||
@@ -300,10 +479,96 @@ type MigrationStatus struct {
|
||||
Applied bool
|
||||
}
|
||||
|
||||
// splitSQL 分割SQL语句，处理多行SQL、注释等
|
||||
// 支持单行注释（--）、多行注释（/* */）、按分号分割语句
|
||||
func splitSQL(content string) []string {
|
||||
var statements []string
|
||||
var current strings.Builder
|
||||
|
||||
lines := strings.Split(content, "\n")
|
||||
inMultiLineComment := false
|
||||
|
||||
for _, line := range lines {
|
||||
trimmedLine := strings.TrimSpace(line)
|
||||
|
||||
// 跳过空行
|
||||
if trimmedLine == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
// 处理多行注释
|
||||
if strings.HasPrefix(trimmedLine, "/*") {
|
||||
inMultiLineComment = true
|
||||
}
|
||||
if strings.HasSuffix(trimmedLine, "*/") {
|
||||
inMultiLineComment = false
|
||||
continue
|
||||
}
|
||||
if inMultiLineComment {
|
||||
continue
|
||||
}
|
||||
|
||||
// 跳过单行注释
|
||||
if strings.HasPrefix(trimmedLine, "--") {
|
||||
continue
|
||||
}
|
||||
|
||||
// 添加到当前语句
|
||||
current.WriteString(line)
|
||||
current.WriteString("\n")
|
||||
|
||||
// 检查是否是完整语句（以分号结尾）
|
||||
if strings.HasSuffix(trimmedLine, ";") {
|
||||
stmt := strings.TrimSpace(current.String())
|
||||
if stmt != "" && !strings.HasPrefix(stmt, "--") {
|
||||
statements = append(statements, stmt)
|
||||
}
|
||||
current.Reset()
|
||||
}
|
||||
}
|
||||
|
||||
// 添加最后一个语句（如果没有分号结尾）
|
||||
if current.Len() > 0 {
|
||||
stmt := strings.TrimSpace(current.String())
|
||||
if stmt != "" && !strings.HasPrefix(stmt, "--") {
|
||||
statements = append(statements, stmt)
|
||||
}
|
||||
}
|
||||
|
||||
return statements
|
||||
}
|
||||
|
||||
// parseMigrationFileName 解析迁移文件名，支持多种格式
|
||||
// 格式1: 数字前缀 - 01_init_schema.sql
|
||||
// 格式2: 时间戳 - 20240101000001_create_users.sql
|
||||
// 格式3: 带.up后缀 - 20240101000001_create_users.up.sql
|
||||
// 返回: (version, description, error)
|
||||
func parseMigrationFileName(baseName string) (string, string, error) {
|
||||
// 移除扩展名
|
||||
nameWithoutExt := strings.TrimSuffix(baseName, filepath.Ext(baseName))
|
||||
// 移除 .up 后缀（如果存在）
|
||||
nameWithoutExt = strings.TrimSuffix(nameWithoutExt, ".up")
|
||||
|
||||
// 解析版本号和描述
|
||||
parts := strings.SplitN(nameWithoutExt, "_", 2)
|
||||
if len(parts) < 2 {
|
||||
// 如果只有一个部分，尝试作为版本号（向后兼容）
|
||||
return nameWithoutExt, baseName, nil
|
||||
}
|
||||
|
||||
version := parts[0]
|
||||
description := strings.Join(parts[1:], "_")
|
||||
|
||||
return version, description, nil
|
||||
}
|
||||
|
||||
// LoadMigrationsFromFiles 从文件系统加载迁移文件
|
||||
// dir: 迁移文件目录
|
||||
// pattern: 文件命名模式，例如 "*.sql" 或 "*.up.sql"
|
||||
// 文件命名格式: {version}_{description}.sql 或 {version}_{description}.up.sql
|
||||
// 文件命名格式支持:
|
||||
// - 数字前缀: 01_init_schema.sql
|
||||
// - 时间戳: 20240101000001_create_users.sql
|
||||
// - 带.up后缀: 20240101000001_create_users.up.sql
|
||||
func LoadMigrationsFromFiles(dir string, pattern string) ([]Migration, error) {
|
||||
files, err := filepath.Glob(filepath.Join(dir, pattern))
|
||||
if err != nil {
|
||||
@@ -313,19 +578,17 @@ func LoadMigrationsFromFiles(dir string, pattern string) ([]Migration, error) {
|
||||
migrations := make([]Migration, 0)
|
||||
for _, file := range files {
|
||||
baseName := filepath.Base(file)
|
||||
// 移除扩展名
|
||||
nameWithoutExt := strings.TrimSuffix(baseName, filepath.Ext(baseName))
|
||||
// 移除 .up 后缀（如果存在）
|
||||
nameWithoutExt = strings.TrimSuffix(nameWithoutExt, ".up")
|
||||
|
||||
// 解析版本号和描述
|
||||
parts := strings.SplitN(nameWithoutExt, "_", 2)
|
||||
if len(parts) < 2 {
|
||||
return nil, fmt.Errorf("invalid migration file name format: %s (expected: {version}_{description})", baseName)
|
||||
// 跳过 .down.sql 文件（会在处理 .up.sql 或 .sql 时自动加载）
|
||||
if strings.HasSuffix(baseName, ".down.sql") {
|
||||
continue
|
||||
}
|
||||
|
||||
version := parts[0]
|
||||
description := strings.Join(parts[1:], "_")
|
||||
// 解析版本号和描述
|
||||
version, description, err := parseMigrationFileName(baseName)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid migration file name format: %s: %w", baseName, err)
|
||||
}
|
||||
|
||||
// 读取文件内容
|
||||
content, err := os.ReadFile(file)
|
||||
@@ -343,26 +606,81 @@ func LoadMigrationsFromFiles(dir string, pattern string) ([]Migration, error) {
|
||||
downSQL = string(downContent)
|
||||
}
|
||||
|
||||
// 创建迁移，使用 SQL 分割功能
|
||||
migration := Migration{
|
||||
Version: version,
|
||||
Description: description,
|
||||
Up: func(db *gorm.DB) error {
|
||||
return db.Exec(sqlContent).Error
|
||||
// 分割 SQL 语句
|
||||
statements := splitSQL(sqlContent)
|
||||
if len(statements) == 0 {
|
||||
return nil // 空文件，跳过
|
||||
}
|
||||
|
||||
// 执行每个 SQL 语句
|
||||
// 注意：某些 DDL 语句（如 CREATE TABLE）在某些数据库中会隐式提交事务
|
||||
// 因此这里不使用事务，而是逐个执行
|
||||
for i, stmt := range statements {
|
||||
stmt = strings.TrimSpace(stmt)
|
||||
if stmt == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
if err := db.Exec(stmt).Error; err != nil {
|
||||
// 如果是表已存在的错误，记录警告但继续执行（向后兼容）
|
||||
errStr := err.Error()
|
||||
if strings.Contains(errStr, "already exists") ||
|
||||
strings.Contains(errStr, "Duplicate") ||
|
||||
strings.Contains(errStr, "duplicate") {
|
||||
fmt.Printf("Warning: SQL statement %d in migration %s: %v\n", i+1, version, err)
|
||||
continue
|
||||
}
|
||||
return fmt.Errorf("failed to execute SQL statement %d in migration %s: %w\nSQL: %s", i+1, version, err, stmt)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
if downSQL != "" {
|
||||
migration.Down = func(db *gorm.DB) error {
|
||||
return db.Exec(downSQL).Error
|
||||
// 分割 SQL 语句
|
||||
statements := splitSQL(downSQL)
|
||||
if len(statements) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
// 执行每个 SQL 语句
|
||||
for i, stmt := range statements {
|
||||
stmt = strings.TrimSpace(stmt)
|
||||
if stmt == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
if err := db.Exec(stmt).Error; err != nil {
|
||||
return fmt.Errorf("failed to execute SQL statement %d in rollback %s: %w\nSQL: %s", i+1, version, err, stmt)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
migrations = append(migrations, migration)
|
||||
}
|
||||
|
||||
// 按版本号排序
|
||||
// 按版本号排序（支持数字和时间戳混合排序）
|
||||
sort.Slice(migrations, func(i, j int) bool {
|
||||
return migrations[i].Version < migrations[j].Version
|
||||
vi, vj := migrations[i].Version, migrations[j].Version
|
||||
// 尝试按数字排序（如果是数字前缀）
|
||||
if viNum, err1 := strconv.Atoi(vi); err1 == nil {
|
||||
if vjNum, err2 := strconv.Atoi(vj); err2 == nil {
|
||||
return viNum < vjNum
|
||||
}
|
||||
}
|
||||
// 否则按字符串排序
|
||||
return vi < vj
|
||||
})
|
||||
|
||||
return migrations, nil
|
||||
|
||||
273
sms/sms.go
273
sms/sms.go
@@ -16,59 +16,6 @@ import (
|
||||
"git.toowon.com/jimmy/go-common/config"
|
||||
)
|
||||
|
||||
// SMS 短信发送器
|
||||
type SMS struct {
|
||||
config *config.SMSConfig
|
||||
}
|
||||
|
||||
// NewSMS 创建短信发送器
|
||||
func NewSMS(cfg *config.SMSConfig) (*SMS, error) {
|
||||
if cfg == nil {
|
||||
return nil, fmt.Errorf("SMS config is nil")
|
||||
}
|
||||
|
||||
if cfg.AccessKeyID == "" {
|
||||
return nil, fmt.Errorf("AccessKeyID is required")
|
||||
}
|
||||
|
||||
if cfg.AccessKeySecret == "" {
|
||||
return nil, fmt.Errorf("AccessKeySecret is required")
|
||||
}
|
||||
|
||||
if cfg.SignName == "" {
|
||||
return nil, fmt.Errorf("SignName is required")
|
||||
}
|
||||
|
||||
// 设置默认值
|
||||
if cfg.Region == "" {
|
||||
cfg.Region = "cn-hangzhou"
|
||||
}
|
||||
if cfg.Timeout == 0 {
|
||||
cfg.Timeout = 10
|
||||
}
|
||||
|
||||
return &SMS{
|
||||
config: cfg,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// SendRequest 发送短信请求
|
||||
type SendRequest struct {
|
||||
// PhoneNumbers 手机号列表
|
||||
PhoneNumbers []string
|
||||
|
||||
// TemplateCode 模板代码（如果为空，使用配置中的模板代码）
|
||||
TemplateCode string
|
||||
|
||||
// TemplateParam 模板参数（可以是map或JSON字符串）
|
||||
// 如果是map，会自动转换为JSON字符串
|
||||
// 如果是string，直接使用（必须是有效的JSON字符串）
|
||||
TemplateParam interface{}
|
||||
|
||||
// SignName 签名（如果为空，使用配置中的签名）
|
||||
SignName string
|
||||
}
|
||||
|
||||
// SendResponse 发送短信响应
|
||||
type SendResponse struct {
|
||||
// RequestID 请求ID
|
||||
@@ -84,48 +31,123 @@ type SendResponse struct {
|
||||
BizID string `json:"BizId"`
|
||||
}
|
||||
|
||||
// SendRaw 发送原始请求（允许外部完全控制请求参数）
|
||||
// params: 请求参数map，工具只负责添加必要的系统参数（如签名、时间戳等）并发送
|
||||
func (s *SMS) SendRaw(params map[string]string) (*SendResponse, error) {
|
||||
if params == nil {
|
||||
params = make(map[string]string)
|
||||
// SMS 短信发送器
|
||||
type SMS struct {
|
||||
config *config.SMSConfig
|
||||
}
|
||||
|
||||
// 确保必要的系统参数存在
|
||||
if params["Action"] == "" {
|
||||
// NewSMS 创建短信发送器
|
||||
func NewSMS(cfg *config.Config) *SMS {
|
||||
if cfg == nil || cfg.SMS == nil {
|
||||
return &SMS{config: nil}
|
||||
}
|
||||
return &SMS{config: cfg.SMS}
|
||||
}
|
||||
|
||||
// getSMSConfig 获取短信配置（内部方法）
|
||||
func (s *SMS) getSMSConfig() (*config.SMSConfig, error) {
|
||||
if s.config == nil {
|
||||
return nil, fmt.Errorf("SMS config is nil")
|
||||
}
|
||||
|
||||
if s.config.AccessKeyID == "" {
|
||||
return nil, fmt.Errorf("AccessKeyID is required")
|
||||
}
|
||||
|
||||
if s.config.AccessKeySecret == "" {
|
||||
return nil, fmt.Errorf("AccessKeySecret is required")
|
||||
}
|
||||
|
||||
if s.config.SignName == "" {
|
||||
return nil, fmt.Errorf("SignName is required")
|
||||
}
|
||||
|
||||
// 设置默认值
|
||||
if s.config.Region == "" {
|
||||
s.config.Region = "cn-hangzhou"
|
||||
}
|
||||
if s.config.Timeout == 0 {
|
||||
s.config.Timeout = 10
|
||||
}
|
||||
|
||||
return s.config, nil
|
||||
}
|
||||
|
||||
// SendSMS 发送短信
|
||||
// phoneNumbers: 手机号列表
|
||||
// templateParam: 模板参数（map或JSON字符串）
|
||||
// templateCode: 模板代码（可选，如果为空使用配置中的模板代码）
|
||||
func (s *SMS) SendSMS(phoneNumbers []string, templateParam interface{}, templateCode ...string) (*SendResponse, error) {
|
||||
cfg, err := s.getSMSConfig()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(phoneNumbers) == 0 {
|
||||
return nil, fmt.Errorf("phone numbers are required")
|
||||
}
|
||||
|
||||
// 使用配置中的模板代码（如果请求中未指定）
|
||||
templateCodeValue := ""
|
||||
if len(templateCode) > 0 && templateCode[0] != "" {
|
||||
templateCodeValue = templateCode[0]
|
||||
} else {
|
||||
templateCodeValue = cfg.TemplateCode
|
||||
}
|
||||
if templateCodeValue == "" {
|
||||
return nil, fmt.Errorf("template code is required")
|
||||
}
|
||||
|
||||
signName := cfg.SignName
|
||||
|
||||
// 处理模板参数
|
||||
var templateParamJSON string
|
||||
if templateParam != nil {
|
||||
switch v := templateParam.(type) {
|
||||
case string:
|
||||
// 直接使用字符串（必须是有效的JSON）
|
||||
templateParamJSON = v
|
||||
case map[string]string:
|
||||
// 转换为JSON字符串
|
||||
paramBytes, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal template param: %w", err)
|
||||
}
|
||||
templateParamJSON = string(paramBytes)
|
||||
default:
|
||||
// 尝试JSON序列化
|
||||
paramBytes, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal template param: %w", err)
|
||||
}
|
||||
templateParamJSON = string(paramBytes)
|
||||
}
|
||||
} else {
|
||||
templateParamJSON = "{}"
|
||||
}
|
||||
|
||||
// 构建请求参数
|
||||
params := make(map[string]string)
|
||||
params["Action"] = "SendSms"
|
||||
}
|
||||
if params["Version"] == "" {
|
||||
params["Version"] = "2017-05-25"
|
||||
}
|
||||
if params["RegionId"] == "" {
|
||||
params["RegionId"] = s.config.Region
|
||||
}
|
||||
if params["AccessKeyId"] == "" {
|
||||
params["AccessKeyId"] = s.config.AccessKeyID
|
||||
}
|
||||
if params["Format"] == "" {
|
||||
params["RegionId"] = cfg.Region
|
||||
params["AccessKeyId"] = cfg.AccessKeyID
|
||||
params["Format"] = "JSON"
|
||||
}
|
||||
if params["SignatureMethod"] == "" {
|
||||
params["SignatureMethod"] = "HMAC-SHA1"
|
||||
}
|
||||
if params["SignatureVersion"] == "" {
|
||||
params["SignatureVersion"] = "1.0"
|
||||
}
|
||||
if params["SignatureNonce"] == "" {
|
||||
params["SignatureNonce"] = fmt.Sprint(time.Now().UnixNano())
|
||||
}
|
||||
if params["Timestamp"] == "" {
|
||||
params["Timestamp"] = time.Now().UTC().Format("2006-01-02T15:04:05Z")
|
||||
}
|
||||
params["PhoneNumbers"] = strings.Join(phoneNumbers, ",")
|
||||
params["SignName"] = signName
|
||||
params["TemplateCode"] = templateCodeValue
|
||||
params["TemplateParam"] = templateParamJSON
|
||||
|
||||
// 计算签名
|
||||
signature := s.calculateSignature(params, "POST")
|
||||
signature := s.calculateSignature(params, "POST", cfg.AccessKeySecret)
|
||||
params["Signature"] = signature
|
||||
|
||||
// 构建请求URL
|
||||
endpoint := s.config.Endpoint
|
||||
endpoint := cfg.Endpoint
|
||||
if endpoint == "" {
|
||||
endpoint = "https://dysmsapi.aliyuncs.com"
|
||||
}
|
||||
@@ -145,7 +167,7 @@ func (s *SMS) SendRaw(params map[string]string) (*SendResponse, error) {
|
||||
httpReq.Header.Set("Accept", "application/json")
|
||||
|
||||
client := &http.Client{
|
||||
Timeout: time.Duration(s.config.Timeout) * time.Second,
|
||||
Timeout: time.Duration(cfg.Timeout) * time.Second,
|
||||
}
|
||||
|
||||
resp, err := client.Do(httpReq)
|
||||
@@ -174,70 +196,8 @@ func (s *SMS) SendRaw(params map[string]string) (*SendResponse, error) {
|
||||
return &sendResp, nil
|
||||
}
|
||||
|
||||
// Send 发送短信（使用SendRequest结构）
|
||||
// 注意：如果需要完全控制请求参数，请使用SendRaw方法
|
||||
func (s *SMS) Send(req *SendRequest) (*SendResponse, error) {
|
||||
if req == nil {
|
||||
return nil, fmt.Errorf("request is nil")
|
||||
}
|
||||
|
||||
if len(req.PhoneNumbers) == 0 {
|
||||
return nil, fmt.Errorf("phone numbers are required")
|
||||
}
|
||||
|
||||
// 使用配置中的模板代码和签名（如果请求中未指定）
|
||||
templateCode := req.TemplateCode
|
||||
if templateCode == "" {
|
||||
templateCode = s.config.TemplateCode
|
||||
}
|
||||
if templateCode == "" {
|
||||
return nil, fmt.Errorf("template code is required")
|
||||
}
|
||||
|
||||
signName := req.SignName
|
||||
if signName == "" {
|
||||
signName = s.config.SignName
|
||||
}
|
||||
|
||||
// 处理模板参数
|
||||
var templateParamJSON string
|
||||
if req.TemplateParam != nil {
|
||||
switch v := req.TemplateParam.(type) {
|
||||
case string:
|
||||
// 直接使用字符串（必须是有效的JSON）
|
||||
templateParamJSON = v
|
||||
case map[string]string:
|
||||
// 转换为JSON字符串
|
||||
paramBytes, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal template param: %w", err)
|
||||
}
|
||||
templateParamJSON = string(paramBytes)
|
||||
default:
|
||||
// 尝试JSON序列化
|
||||
paramBytes, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal template param: %w", err)
|
||||
}
|
||||
templateParamJSON = string(paramBytes)
|
||||
}
|
||||
} else {
|
||||
templateParamJSON = "{}"
|
||||
}
|
||||
|
||||
// 构建请求参数
|
||||
params := make(map[string]string)
|
||||
params["PhoneNumbers"] = strings.Join(req.PhoneNumbers, ",")
|
||||
params["SignName"] = signName
|
||||
params["TemplateCode"] = templateCode
|
||||
params["TemplateParam"] = templateParamJSON
|
||||
|
||||
// 使用SendRaw发送
|
||||
return s.SendRaw(params)
|
||||
}
|
||||
|
||||
// calculateSignature 计算签名
|
||||
func (s *SMS) calculateSignature(params map[string]string, method string) string {
|
||||
func (s *SMS) calculateSignature(params map[string]string, method, accessKeySecret string) string {
|
||||
// 对参数进行排序
|
||||
keys := make([]string, 0, len(params))
|
||||
for k := range params {
|
||||
@@ -260,31 +220,10 @@ func (s *SMS) calculateSignature(params map[string]string, method string) string
|
||||
stringToSign := method + "&" + url.QueryEscape("/") + "&" + url.QueryEscape(queryString)
|
||||
|
||||
// 计算HMAC-SHA1签名
|
||||
mac := hmac.New(sha1.New, []byte(s.config.AccessKeySecret+"&"))
|
||||
mac := hmac.New(sha1.New, []byte(accessKeySecret+"&"))
|
||||
mac.Write([]byte(stringToSign))
|
||||
signature := base64.StdEncoding.EncodeToString(mac.Sum(nil))
|
||||
|
||||
return signature
|
||||
}
|
||||
|
||||
// SendSimple 发送简单短信（便捷方法）
|
||||
// phoneNumbers: 手机号列表
|
||||
// templateParam: 模板参数
|
||||
func (s *SMS) SendSimple(phoneNumbers []string, templateParam map[string]string) (*SendResponse, error) {
|
||||
return s.Send(&SendRequest{
|
||||
PhoneNumbers: phoneNumbers,
|
||||
TemplateParam: templateParam,
|
||||
})
|
||||
}
|
||||
|
||||
// SendWithTemplate 使用指定模板发送短信（便捷方法）
|
||||
// phoneNumbers: 手机号列表
|
||||
// templateCode: 模板代码
|
||||
// templateParam: 模板参数
|
||||
func (s *SMS) SendWithTemplate(phoneNumbers []string, templateCode string, templateParam map[string]string) (*SendResponse, error) {
|
||||
return s.Send(&SendRequest{
|
||||
PhoneNumbers: phoneNumbers,
|
||||
TemplateCode: templateCode,
|
||||
TemplateParam: templateParam,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -43,31 +43,29 @@ func NewUploadHandler(cfg UploadHandlerConfig) *UploadHandler {
|
||||
// 表单字段: file (文件)
|
||||
// 可选字段: prefix (对象键前缀，会覆盖配置中的前缀)
|
||||
func (h *UploadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
handler := commonhttp.NewHandler(w, r)
|
||||
|
||||
if r.Method != http.MethodPost {
|
||||
handler.Error(4001, "Method not allowed")
|
||||
commonhttp.Error(w, 4001, "Method not allowed")
|
||||
return
|
||||
}
|
||||
|
||||
// 解析multipart表单
|
||||
err := r.ParseMultipartForm(h.maxFileSize)
|
||||
if err != nil {
|
||||
handler.Error(4002, fmt.Sprintf("Failed to parse form: %v", err))
|
||||
commonhttp.Error(w, 4002, fmt.Sprintf("Failed to parse form: %v", err))
|
||||
return
|
||||
}
|
||||
|
||||
// 获取文件
|
||||
file, header, err := r.FormFile("file")
|
||||
if err != nil {
|
||||
handler.Error(4003, fmt.Sprintf("Failed to get file: %v", err))
|
||||
commonhttp.Error(w, 4003, fmt.Sprintf("Failed to get file: %v", err))
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
// 检查文件大小
|
||||
if h.maxFileSize > 0 && header.Size > h.maxFileSize {
|
||||
handler.Error(1001, fmt.Sprintf("File size exceeds limit: %d bytes", h.maxFileSize))
|
||||
commonhttp.Error(w, 1001, fmt.Sprintf("File size exceeds limit: %d bytes", h.maxFileSize))
|
||||
return
|
||||
}
|
||||
|
||||
@@ -82,7 +80,7 @@ func (h *UploadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
}
|
||||
}
|
||||
if !allowed {
|
||||
handler.Error(1002, fmt.Sprintf("File extension not allowed. Allowed: %v", h.allowedExts))
|
||||
commonhttp.Error(w, 1002, fmt.Sprintf("File extension not allowed. Allowed: %v", h.allowedExts))
|
||||
return
|
||||
}
|
||||
}
|
||||
@@ -110,14 +108,14 @@ func (h *UploadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
ctx := r.Context()
|
||||
err = h.storage.Upload(ctx, objectKey, file, contentType)
|
||||
if err != nil {
|
||||
handler.SystemError(fmt.Sprintf("Failed to upload file: %v", err))
|
||||
commonhttp.SystemError(w, fmt.Sprintf("Failed to upload file: %v", err))
|
||||
return
|
||||
}
|
||||
|
||||
// 获取文件URL
|
||||
fileURL, err := h.storage.GetURL(objectKey, 0)
|
||||
if err != nil {
|
||||
handler.SystemError(fmt.Sprintf("Failed to get file URL: %v", err))
|
||||
commonhttp.SystemError(w, fmt.Sprintf("Failed to get file URL: %v", err))
|
||||
return
|
||||
}
|
||||
|
||||
@@ -130,7 +128,7 @@ func (h *UploadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
UploadTime: time.Now(),
|
||||
}
|
||||
|
||||
handler.SuccessWithMessage("Upload successful", result)
|
||||
commonhttp.Success(w, result, "Upload successful")
|
||||
}
|
||||
|
||||
// generateUniqueFilename 生成唯一文件名
|
||||
|
||||
@@ -24,11 +24,11 @@ import (
|
||||
// ./migrate down # 回滚最后一个迁移
|
||||
//
|
||||
// Docker 中使用：
|
||||
// # 方式1：挂载配置文件
|
||||
// # 方式1：挂载配置文件（推荐）
|
||||
// docker run -v /host/config.json:/app/config.json myapp ./migrate up
|
||||
//
|
||||
// # 方式2：使用环境变量
|
||||
// docker run -e DATABASE_URL="mysql://..." myapp ./migrate up
|
||||
// # 方式2：使用环境变量指定配置文件路径
|
||||
// docker run -e CONFIG_FILE=/etc/app/config.json myapp ./migrate up
|
||||
//
|
||||
// # 方式3：指定容器内的配置文件路径
|
||||
// docker run myapp ./migrate up -config /etc/app/config.json
|
||||
@@ -41,8 +41,7 @@ import (
|
||||
// 配置优先级（从高到低）：
|
||||
// 1. 命令行参数 -config 和 -dir
|
||||
// 2. 环境变量 CONFIG_FILE 和 MIGRATIONS_DIR
|
||||
// 3. 环境变量 DATABASE_URL（直接连接，无需配置文件）
|
||||
// 4. 默认值（config.json 和 migrations）
|
||||
// 3. 默认值（config.json 和 migrations）
|
||||
|
||||
var (
|
||||
configFile string
|
||||
@@ -69,6 +68,9 @@ func main() {
|
||||
}
|
||||
|
||||
// 获取命令（默认up）
|
||||
// 支持两种方式：
|
||||
// 1. 位置参数：./migrate up
|
||||
// 2. 标志参数：./migrate -cmd=up（向后兼容）
|
||||
command := "up"
|
||||
args := flag.Args()
|
||||
if len(args) > 0 {
|
||||
@@ -83,16 +85,18 @@ func main() {
|
||||
}
|
||||
|
||||
// 获取配置文件路径（优先级：命令行 > 环境变量 > 默认值）
|
||||
// 如果未指定，RunMigrationsFromConfigWithCommand 会自动查找
|
||||
if configFile == "" {
|
||||
configFile = getEnv("CONFIG_FILE", "config.json")
|
||||
configFile = getEnv("CONFIG_FILE", "")
|
||||
}
|
||||
|
||||
// 获取迁移目录（优先级：命令行 > 环境变量 > 默认值）
|
||||
// 如果未指定，RunMigrationsFromConfigWithCommand 会使用默认值 "migrations"
|
||||
if migrationsDir == "" {
|
||||
migrationsDir = getEnv("MIGRATIONS_DIR", "migrations")
|
||||
migrationsDir = getEnv("MIGRATIONS_DIR", "")
|
||||
}
|
||||
|
||||
// 执行迁移
|
||||
// 执行迁移（黑盒模式：内部自动处理所有细节）
|
||||
if err := migration.RunMigrationsFromConfigWithCommand(configFile, migrationsDir, command); err != nil {
|
||||
fmt.Fprintf(os.Stderr, "错误: %v\n", err)
|
||||
os.Exit(1)
|
||||
@@ -132,16 +136,14 @@ func printHelp() {
|
||||
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(" CONFIG_FILE=/etc/app/config.json migrate up")
|
||||
fmt.Println()
|
||||
fmt.Println(" # Docker 中使用")
|
||||
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）")
|
||||
fmt.Println(" 3. 默认值（config.json 和 migrations）")
|
||||
}
|
||||
|
||||
|
||||
85
tools/crypto.go
Normal file
85
tools/crypto.go
Normal file
@@ -0,0 +1,85 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"crypto/rand"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"math/big"
|
||||
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
)
|
||||
|
||||
// HashPassword 使用bcrypt加密密码
|
||||
func HashPassword(password string) (string, error) {
|
||||
bytes, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
|
||||
return string(bytes), err
|
||||
}
|
||||
|
||||
// CheckPassword 验证密码
|
||||
func CheckPassword(password, hash string) bool {
|
||||
err := bcrypt.CompareHashAndPassword([]byte(hash), []byte(password))
|
||||
return err == nil
|
||||
}
|
||||
|
||||
// MD5 计算MD5哈希值
|
||||
func MD5(text string) string {
|
||||
hash := md5.Sum([]byte(text))
|
||||
return hex.EncodeToString(hash[:])
|
||||
}
|
||||
|
||||
// SHA256 计算SHA256哈希值
|
||||
func SHA256(text string) string {
|
||||
hash := sha256.Sum256([]byte(text))
|
||||
return hex.EncodeToString(hash[:])
|
||||
}
|
||||
|
||||
// GenerateRandomString 生成指定长度的随机字符串
|
||||
func GenerateRandomString(length int) string {
|
||||
const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
|
||||
b := make([]byte, length)
|
||||
for i := range b {
|
||||
num, _ := rand.Int(rand.Reader, big.NewInt(int64(len(charset))))
|
||||
b[i] = charset[num.Int64()]
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
// GenerateRandomNumber 生成指定长度的随机数字字符串
|
||||
func GenerateRandomNumber(length int) string {
|
||||
const charset = "0123456789"
|
||||
b := make([]byte, length)
|
||||
for i := range b {
|
||||
num, _ := rand.Int(rand.Reader, big.NewInt(int64(len(charset))))
|
||||
b[i] = charset[num.Int64()]
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
// GenerateSMSCode 生成短信验证码
|
||||
func GenerateSMSCode() string {
|
||||
return GenerateRandomNumber(6)
|
||||
}
|
||||
|
||||
// GenerateOrderNo 生成订单号
|
||||
func GenerateOrderNo(prefix string) string {
|
||||
timestamp := GetTimestamp()
|
||||
random := GenerateRandomNumber(6)
|
||||
return fmt.Sprintf("%s%d%s", prefix, timestamp, random)
|
||||
}
|
||||
|
||||
// GeneratePaymentNo 生成支付单号
|
||||
func GeneratePaymentNo() string {
|
||||
return GenerateOrderNo("PAY")
|
||||
}
|
||||
|
||||
// GenerateRefundNo 生成退款单号
|
||||
func GenerateRefundNo() string {
|
||||
return GenerateOrderNo("RF")
|
||||
}
|
||||
|
||||
// GenerateTransferNo 生成调拨单号
|
||||
func GenerateTransferNo() string {
|
||||
return GenerateOrderNo("TF")
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
package datetime
|
||||
package tools
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
173
tools/money.go
Normal file
173
tools/money.go
Normal file
@@ -0,0 +1,173 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"math"
|
||||
)
|
||||
|
||||
// MoneyCalculator 金额计算工具（以分为单位）
|
||||
type MoneyCalculator struct{}
|
||||
|
||||
// NewMoneyCalculator 创建金额计算器
|
||||
func NewMoneyCalculator() *MoneyCalculator {
|
||||
return &MoneyCalculator{}
|
||||
}
|
||||
|
||||
// YuanToCents 元转分
|
||||
func (m *MoneyCalculator) YuanToCents(yuan float64) int64 {
|
||||
return int64(math.Round(yuan * 100))
|
||||
}
|
||||
|
||||
// CentsToYuan 分转元
|
||||
func (m *MoneyCalculator) CentsToYuan(cents int64) float64 {
|
||||
return float64(cents) / 100
|
||||
}
|
||||
|
||||
// FormatYuan 格式化显示金额（分转元，保留2位小数）
|
||||
func (m *MoneyCalculator) FormatYuan(cents int64) string {
|
||||
return fmt.Sprintf("%.2f", m.CentsToYuan(cents))
|
||||
}
|
||||
|
||||
// Add 金额相加
|
||||
func (m *MoneyCalculator) Add(amount1, amount2 int64) int64 {
|
||||
return amount1 + amount2
|
||||
}
|
||||
|
||||
// Subtract 金额相减
|
||||
func (m *MoneyCalculator) Subtract(amount1, amount2 int64) int64 {
|
||||
return amount1 - amount2
|
||||
}
|
||||
|
||||
// Multiply 金额乘法（金额 * 数量）
|
||||
func (m *MoneyCalculator) Multiply(amount int64, quantity int) int64 {
|
||||
return amount * int64(quantity)
|
||||
}
|
||||
|
||||
// MultiplyFloat 金额乘法（金额 * 浮点数，如折扣）
|
||||
func (m *MoneyCalculator) MultiplyFloat(amount int64, rate float64) int64 {
|
||||
return int64(math.Round(float64(amount) * rate))
|
||||
}
|
||||
|
||||
// Divide 金额除法（平均分配）
|
||||
func (m *MoneyCalculator) Divide(amount int64, count int) int64 {
|
||||
if count <= 0 {
|
||||
return 0
|
||||
}
|
||||
return amount / int64(count)
|
||||
}
|
||||
|
||||
// CalculateDiscount 计算折扣金额
|
||||
func (m *MoneyCalculator) CalculateDiscount(originalAmount int64, discountRate float64) int64 {
|
||||
if discountRate <= 0 || discountRate >= 1 {
|
||||
return 0
|
||||
}
|
||||
return int64(math.Round(float64(originalAmount) * discountRate))
|
||||
}
|
||||
|
||||
// CalculatePercentage 计算百分比金额
|
||||
func (m *MoneyCalculator) CalculatePercentage(amount int64, percentage float64) int64 {
|
||||
return int64(math.Round(float64(amount) * percentage / 100))
|
||||
}
|
||||
|
||||
// Max 取最大金额
|
||||
func (m *MoneyCalculator) Max(amounts ...int64) int64 {
|
||||
if len(amounts) == 0 {
|
||||
return 0
|
||||
}
|
||||
max := amounts[0]
|
||||
for _, amount := range amounts[1:] {
|
||||
if amount > max {
|
||||
max = amount
|
||||
}
|
||||
}
|
||||
return max
|
||||
}
|
||||
|
||||
// Min 取最小金额
|
||||
func (m *MoneyCalculator) Min(amounts ...int64) int64 {
|
||||
if len(amounts) == 0 {
|
||||
return 0
|
||||
}
|
||||
min := amounts[0]
|
||||
for _, amount := range amounts[1:] {
|
||||
if amount < min {
|
||||
min = amount
|
||||
}
|
||||
}
|
||||
return min
|
||||
}
|
||||
|
||||
// IsPositive 判断是否为正数
|
||||
func (m *MoneyCalculator) IsPositive(amount int64) bool {
|
||||
return amount > 0
|
||||
}
|
||||
|
||||
// IsZero 判断是否为零
|
||||
func (m *MoneyCalculator) IsZero(amount int64) bool {
|
||||
return amount == 0
|
||||
}
|
||||
|
||||
// IsNegative 判断是否为负数
|
||||
func (m *MoneyCalculator) IsNegative(amount int64) bool {
|
||||
return amount < 0
|
||||
}
|
||||
|
||||
// Equal 判断金额是否相等
|
||||
func (m *MoneyCalculator) Equal(amount1, amount2 int64) bool {
|
||||
return amount1 == amount2
|
||||
}
|
||||
|
||||
// Greater 判断第一个金额是否大于第二个
|
||||
func (m *MoneyCalculator) Greater(amount1, amount2 int64) bool {
|
||||
return amount1 > amount2
|
||||
}
|
||||
|
||||
// Less 判断第一个金额是否小于第二个
|
||||
func (m *MoneyCalculator) Less(amount1, amount2 int64) bool {
|
||||
return amount1 < amount2
|
||||
}
|
||||
|
||||
// Sum 计算金额总和
|
||||
func (m *MoneyCalculator) Sum(amounts ...int64) int64 {
|
||||
var total int64
|
||||
for _, amount := range amounts {
|
||||
total += amount
|
||||
}
|
||||
return total
|
||||
}
|
||||
|
||||
// SplitAmount 金额分摊（处理分摊不均的情况）
|
||||
func (m *MoneyCalculator) SplitAmount(totalAmount int64, count int) []int64 {
|
||||
if count <= 0 {
|
||||
return []int64{}
|
||||
}
|
||||
|
||||
baseAmount := totalAmount / int64(count)
|
||||
remainder := totalAmount % int64(count)
|
||||
|
||||
amounts := make([]int64, count)
|
||||
for i := 0; i < count; i++ {
|
||||
amounts[i] = baseAmount
|
||||
if int64(i) < remainder {
|
||||
amounts[i]++
|
||||
}
|
||||
}
|
||||
|
||||
return amounts
|
||||
}
|
||||
|
||||
// 全局金额计算器实例
|
||||
var Money = NewMoneyCalculator()
|
||||
|
||||
// 便捷函数
|
||||
func YuanToCents(yuan float64) int64 {
|
||||
return Money.YuanToCents(yuan)
|
||||
}
|
||||
|
||||
func CentsToYuan(cents int64) float64 {
|
||||
return Money.CentsToYuan(cents)
|
||||
}
|
||||
|
||||
func FormatYuan(cents int64) string {
|
||||
return Money.FormatYuan(cents)
|
||||
}
|
||||
186
tools/time.go
Normal file
186
tools/time.go
Normal file
@@ -0,0 +1,186 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// TimeInfo 详细时间信息结构
|
||||
type TimeInfo struct {
|
||||
UTC string `json:"utc"` // UTC时间
|
||||
Local string `json:"local"` // 用户时区时间
|
||||
Unix int64 `json:"unix"` // Unix时间戳
|
||||
Timezone string `json:"timezone"` // 时区名称
|
||||
Offset int `json:"offset"` // 时区偏移量（小时）
|
||||
RFC3339 string `json:"rfc3339"` // RFC3339格式
|
||||
DateTime string `json:"datetime"` // 日期时间格式
|
||||
Date string `json:"date"` // 日期格式
|
||||
Time string `json:"time"` // 时间格式
|
||||
}
|
||||
|
||||
// GetTimestamp 获取当前时间戳（秒）
|
||||
func GetTimestamp() int64 {
|
||||
return time.Now().Unix()
|
||||
}
|
||||
|
||||
// GetMillisTimestamp 获取当前时间戳（毫秒）
|
||||
func GetMillisTimestamp() int64 {
|
||||
return time.Now().UnixMilli()
|
||||
}
|
||||
|
||||
// FormatTimeWithLayout 格式化时间（自定义格式）
|
||||
func FormatTimeWithLayout(t time.Time, layout string) string {
|
||||
if layout == "" {
|
||||
layout = "2006-01-02 15:04:05"
|
||||
}
|
||||
return t.Format(layout)
|
||||
}
|
||||
|
||||
// ParseTime 解析时间字符串
|
||||
func ParseTime(timeStr, layout string) (time.Time, error) {
|
||||
if layout == "" {
|
||||
layout = "2006-01-02 15:04:05"
|
||||
}
|
||||
return time.Parse(layout, timeStr)
|
||||
}
|
||||
|
||||
// GetCurrentTime 获取当前时间字符串
|
||||
func GetCurrentTime() string {
|
||||
return FormatTimeWithLayout(time.Now(), "")
|
||||
}
|
||||
|
||||
// 注意：GetBeginOfDay、GetEndOfDay 已在 datetime.go 中实现为 StartOfDay、EndOfDay
|
||||
// datetime.go 中的方法支持时区参数，功能更强大，建议使用 datetime.go 中的方法
|
||||
|
||||
// GetBeginOfWeek 获取某周的开始时间（周一）
|
||||
func GetBeginOfWeek(t time.Time) time.Time {
|
||||
weekday := t.Weekday()
|
||||
if weekday == time.Sunday {
|
||||
weekday = 7
|
||||
}
|
||||
// 使用 datetime.go 中的 StartOfDay 方法（需要时区，这里使用时间对象本身的时区）
|
||||
beginDay := t.AddDate(0, 0, int(1-weekday))
|
||||
return time.Date(beginDay.Year(), beginDay.Month(), beginDay.Day(), 0, 0, 0, 0, beginDay.Location())
|
||||
}
|
||||
|
||||
// GetEndOfWeek 获取某周的结束时间（周日）
|
||||
func GetEndOfWeek(t time.Time) time.Time {
|
||||
beginOfWeek := GetBeginOfWeek(t)
|
||||
endDay := beginOfWeek.AddDate(0, 0, 6)
|
||||
return time.Date(endDay.Year(), endDay.Month(), endDay.Day(), 23, 59, 59, 999999999, endDay.Location())
|
||||
}
|
||||
|
||||
// 注意：GetBeginOfMonth、GetEndOfMonth、GetBeginOfYear、GetEndOfYear 已在 datetime.go 中实现
|
||||
// datetime.go 中的方法（StartOfMonth、EndOfMonth、StartOfYear、EndOfYear）支持时区参数，功能更强大
|
||||
// 建议使用 datetime.go 中的方法
|
||||
|
||||
// AddHours 增加小时数
|
||||
func AddHours(t time.Time, hours int) time.Time {
|
||||
return t.Add(time.Duration(hours) * time.Hour)
|
||||
}
|
||||
|
||||
// AddMinutes 增加分钟数
|
||||
func AddMinutes(t time.Time, minutes int) time.Time {
|
||||
return t.Add(time.Duration(minutes) * time.Minute)
|
||||
}
|
||||
|
||||
// 注意：DiffDays、DiffHours、DiffMinutes、DiffSeconds 方法已在 datetime.go 中实现
|
||||
// 请使用 datetime.go 中的方法，它们支持更精确的计算和统一的返回类型
|
||||
|
||||
// IsToday 判断是否为今天
|
||||
func IsToday(t time.Time) bool {
|
||||
now := time.Now()
|
||||
tBegin := time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())
|
||||
nowBegin := time.Date(now.Year(), now.Month(), now.Day(), 0, 0, 0, 0, now.Location())
|
||||
return tBegin.Equal(nowBegin)
|
||||
}
|
||||
|
||||
// GenerateTimeInfoWithTimezone 生成详细时间信息（指定时区）
|
||||
func GenerateTimeInfoWithTimezone(t time.Time, timezone string) TimeInfo {
|
||||
// 加载时区
|
||||
loc, err := time.LoadLocation(timezone)
|
||||
if err != nil {
|
||||
loc = time.UTC
|
||||
timezone = "UTC"
|
||||
}
|
||||
|
||||
// 转换为指定时区时间
|
||||
localTime := t.In(loc)
|
||||
|
||||
// 计算时区偏移量
|
||||
_, offset := localTime.Zone()
|
||||
offsetHours := offset / 3600
|
||||
|
||||
// 预先计算格式化结果，避免重复调用
|
||||
utcRFC3339 := t.UTC().Format(time.RFC3339)
|
||||
localRFC3339 := localTime.Format(time.RFC3339)
|
||||
localDateTime := localTime.Format("2006-01-02 15:04:05")
|
||||
localDate := localTime.Format("2006-01-02")
|
||||
localTimeOnly := localTime.Format("15:04:05")
|
||||
|
||||
return TimeInfo{
|
||||
UTC: utcRFC3339,
|
||||
Local: localRFC3339,
|
||||
Unix: t.Unix(),
|
||||
Timezone: timezone,
|
||||
Offset: offsetHours,
|
||||
RFC3339: localRFC3339,
|
||||
DateTime: localDateTime,
|
||||
Date: localDate,
|
||||
Time: localTimeOnly,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUTCTimestamp 获取UTC时间戳
|
||||
func GetUTCTimestamp() int64 {
|
||||
return time.Now().UTC().Unix()
|
||||
}
|
||||
|
||||
// GetUTCTimestampFromTime 从指定时间获取UTC时间戳
|
||||
func GetUTCTimestampFromTime(t time.Time) int64 {
|
||||
return t.UTC().Unix()
|
||||
}
|
||||
|
||||
// FormatTimeUTC 格式化时间为UTC字符串（ISO 8601格式）
|
||||
func FormatTimeUTC(t time.Time) string {
|
||||
return t.UTC().Format(time.RFC3339)
|
||||
}
|
||||
|
||||
// IsYesterday 判断是否为昨天
|
||||
func IsYesterday(t time.Time) bool {
|
||||
yesterday := time.Now().AddDate(0, 0, -1)
|
||||
tBegin := time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())
|
||||
yesterdayBegin := time.Date(yesterday.Year(), yesterday.Month(), yesterday.Day(), 0, 0, 0, 0, yesterday.Location())
|
||||
return tBegin.Equal(yesterdayBegin)
|
||||
}
|
||||
|
||||
// IsTomorrow 判断是否为明天
|
||||
func IsTomorrow(t time.Time) bool {
|
||||
tomorrow := time.Now().AddDate(0, 0, 1)
|
||||
tBegin := time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())
|
||||
tomorrowBegin := time.Date(tomorrow.Year(), tomorrow.Month(), tomorrow.Day(), 0, 0, 0, 0, tomorrow.Location())
|
||||
return tBegin.Equal(tomorrowBegin)
|
||||
}
|
||||
|
||||
// GenerateTimeInfoFromContext 从gin.Context中获取用户时区并生成时间信息
|
||||
func GenerateTimeInfoFromContext(t time.Time, c interface{}) TimeInfo {
|
||||
// 尝试从context中获取时区
|
||||
timezone := ""
|
||||
|
||||
// 如果传入的是gin.Context，尝试获取时区
|
||||
if ginCtx, ok := c.(interface {
|
||||
Get(key string) (value interface{}, exists bool)
|
||||
}); ok {
|
||||
if tz, exists := ginCtx.Get("user_timezone"); exists {
|
||||
if tzStr, ok := tz.(string); ok && tzStr != "" {
|
||||
timezone = tzStr
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 如果没有获取到时区，使用默认时区（东8区）
|
||||
if timezone == "" {
|
||||
timezone = "Asia/Shanghai"
|
||||
}
|
||||
|
||||
return GenerateTimeInfoWithTimezone(t, timezone)
|
||||
}
|
||||
26
tools/version.go
Normal file
26
tools/version.go
Normal file
@@ -0,0 +1,26 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
"os"
|
||||
)
|
||||
|
||||
// Version 版本号 - 在这里修改版本号（默认值）
|
||||
const DefaultVersion = "1.0.1"
|
||||
|
||||
// GetVersion 获取版本号
|
||||
// 优先从环境变量 DOCKER_TAG 或 VERSION 中读取
|
||||
// 如果没有设置环境变量，则使用默认版本号
|
||||
func GetVersion() string {
|
||||
// 优先从 Docker 标签环境变量读取
|
||||
if dockerTag := os.Getenv("DOCKER_TAG"); dockerTag != "" {
|
||||
return dockerTag
|
||||
}
|
||||
|
||||
// 从通用版本环境变量读取
|
||||
if version := os.Getenv("VERSION"); version != "" {
|
||||
return version
|
||||
}
|
||||
|
||||
// 使用默认版本号
|
||||
return DefaultVersion
|
||||
}
|
||||
Reference in New Issue
Block a user