go-common/docs/README.md

GoCommon 工具类库文档

目录

• 数据库迁移工具 - 数据库版本管理和迁移
• 日期转换工具 - 日期时间处理和时区转换
• HTTP Restful工具 - HTTP请求响应处理和分页
• 中间件工具 - CORS和时区处理中间件
• 配置工具 - 外部配置文件加载和管理
• 存储工具 - 文件上传和查看（OSS、MinIO）
• 邮件工具 - SMTP邮件发送
• 短信工具 - 阿里云短信发送
• 工厂工具 - 从配置直接创建已初始化客户端对象
• 日志工具 - 统一的日志记录功能

快速开始

安装

go get git.toowon.com/jimmy/go-common

使用示例

数据库迁移

import "git.toowon.com/jimmy/go-common/migration"

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 users ...").Error
    },
})
migrator.Up()

日期转换

import "git.toowon.com/jimmy/go-common/datetime"

datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
now := datetime.Now()
str := datetime.FormatDateTime(now)

HTTP响应（Handler黑盒模式）

import (
    "net/http"
    commonhttp "git.toowon.com/jimmy/go-common/http"
)

func GetUser(h *commonhttp.Handler) {
    id := h.GetQueryInt64("id", 0)
    h.Success(data)
}

http.HandleFunc("/user", commonhttp.HandleFunc(GetUser))

中间件

import (
    "net/http"
    "git.toowon.com/jimmy/go-common/middleware"
    commonhttp "git.toowon.com/jimmy/go-common/http"
)

// CORS + 时区中间件
chain := middleware.NewChain(
    middleware.CORS(),
    middleware.Timezone,
)

handler := chain.ThenFunc(func(w http.ResponseWriter, r *http.Request) {
    h := commonhttp.NewHandler(w, r)
    // 在Handler中获取时区
    timezone := h.GetTimezone()
    h.Success(data)
})

配置管理

import "git.toowon.com/jimmy/go-common/config"

// 从文件加载配置
cfg, err := config.LoadFromFile("./config.json")

// 获取各种配置
dsn, _ := cfg.GetDatabaseDSN()
redisAddr := cfg.GetRedisAddr()
corsConfig := cfg.GetCORS()

版本

v1.0.0

许可证

MIT