修改包名

This commit is contained in:
2025-11-30 13:43:43 +08:00
parent 23d3840050
commit a655640ab2
38 changed files with 729 additions and 104 deletions

View File

@@ -31,6 +31,9 @@
### 9. 工厂工具 (factory)
提供从配置直接创建已初始化客户端对象的功能,避免调用方重复实现创建逻辑。
### 10. 日志工具 (logger)
提供统一的日志记录功能支持多种日志级别和输出方式使用Go标准库实现。
## 安装
### 1. 配置私有仓库(重要)
@@ -50,7 +53,7 @@ go env GOPRIVATE
### 2. 安装模块
```bash
go get git.toowon.com/jimmy/go-commom
go get git.toowon.com/jimmy/go-common
```
## 使用示例
@@ -65,12 +68,13 @@ go get git.toowon.com/jimmy/go-commom
- [邮件工具文档](./docs/email.md)
- [短信工具文档](./docs/sms.md)
- [工厂工具文档](./docs/factory.md)
- [日志工具文档](./docs/logger.md)
### 快速示例
#### 数据库迁移
```go
import "git.toowon.com/jimmy/go-commom/migration"
import "git.toowon.com/jimmy/go-common/migration"
migrator := migration.NewMigrator(db)
migrator.AddMigration(migration.Migration{
@@ -85,7 +89,7 @@ migrator.Up()
#### 日期转换
```go
import "git.toowon.com/jimmy/go-commom/datetime"
import "git.toowon.com/jimmy/go-common/datetime"
datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
now := datetime.Now()
@@ -94,7 +98,7 @@ str := datetime.FormatDateTime(now)
#### HTTP响应
```go
import "git.toowon.com/jimmy/go-commom/http"
import "git.toowon.com/jimmy/go-common/http"
http.Success(w, data)
http.SuccessPage(w, list, total, page, pageSize)
@@ -104,8 +108,8 @@ http.Error(w, 1001, "业务错误")
#### 中间件
```go
import (
"git.toowon.com/jimmy/go-commom/middleware"
"git.toowon.com/jimmy/go-commom/http"
"git.toowon.com/jimmy/go-common/middleware"
"git.toowon.com/jimmy/go-common/http"
)
// CORS + 时区中间件
@@ -121,7 +125,7 @@ timezone := http.GetTimezone(r)
#### 配置管理
```go
import "git.toowon.com/jimmy/go-commom/config"
import "git.toowon.com/jimmy/go-common/config"
// 从文件加载配置
cfg, err := config.LoadFromFile("./config.json")
@@ -134,7 +138,7 @@ corsConfig := cfg.GetCORS()
#### 文件上传和查看
```go
import "git.toowon.com/jimmy/go-commom/storage"
import "git.toowon.com/jimmy/go-common/storage"
// 创建存储实例
storage, _ := storage.NewStorage(storage.StorageTypeOSS, cfg)
@@ -152,7 +156,7 @@ proxyHandler := storage.NewProxyHandler(storage)
#### 邮件发送
```go
import "git.toowon.com/jimmy/go-commom/email"
import "git.toowon.com/jimmy/go-common/email"
// 从配置创建邮件发送器
mailer, _ := email.NewEmail(cfg.GetEmail())
@@ -167,7 +171,7 @@ mailer.SendSimple(
#### 短信发送
```go
import "git.toowon.com/jimmy/go-commom/sms"
import "git.toowon.com/jimmy/go-common/sms"
// 从配置创建短信发送器
smsClient, _ := sms.NewSMS(cfg.GetSMS())
@@ -182,8 +186,8 @@ smsClient.SendSimple(
#### 使用工厂直接获取客户端(推荐)
```go
import (
"git.toowon.com/jimmy/go-commom/config"
"git.toowon.com/jimmy/go-commom/factory"
"git.toowon.com/jimmy/go-common/config"
"git.toowon.com/jimmy/go-common/factory"
)
// 加载配置并创建工厂
@@ -197,6 +201,11 @@ smsClient, _ := fac.GetSMSClient()
// 直接使用
emailClient.SendSimple(...)
smsClient.SendSimple(...)
// 获取日志记录器(已初始化,可直接使用)
logger, _ := fac.GetLogger()
logger.Info("Application started")
logger.Error("Error occurred: %v", err)
```
更多示例请查看 [examples](./examples/) 目录。