修改包依赖名称
This commit is contained in:
36
README.md
36
README.md
@@ -30,8 +30,24 @@
|
||||
|
||||
## 安装
|
||||
|
||||
### 1. 配置私有仓库(重要)
|
||||
|
||||
由于本项目使用私有 Git 仓库,需要先配置 `GOPRIVATE` 环境变量:
|
||||
|
||||
```bash
|
||||
go get github.com/go-common
|
||||
# 使用 go env 命令配置(推荐,永久生效)
|
||||
go env -w GOPRIVATE=git.toowon.com
|
||||
|
||||
# 验证配置
|
||||
go env GOPRIVATE
|
||||
```
|
||||
|
||||
**详细配置说明请参考 [SETUP.md](./SETUP.md)**
|
||||
|
||||
### 2. 安装模块
|
||||
|
||||
```bash
|
||||
go get git.toowon.com/jimmy/go-commom
|
||||
```
|
||||
|
||||
## 使用示例
|
||||
@@ -50,7 +66,7 @@ go get github.com/go-common
|
||||
|
||||
#### 数据库迁移
|
||||
```go
|
||||
import "github.com/go-common/migration"
|
||||
import "git.toowon.com/jimmy/go-commom/migration"
|
||||
|
||||
migrator := migration.NewMigrator(db)
|
||||
migrator.AddMigration(migration.Migration{
|
||||
@@ -65,7 +81,7 @@ migrator.Up()
|
||||
|
||||
#### 日期转换
|
||||
```go
|
||||
import "github.com/go-common/datetime"
|
||||
import "git.toowon.com/jimmy/go-commom/datetime"
|
||||
|
||||
datetime.SetDefaultTimeZone(datetime.AsiaShanghai)
|
||||
now := datetime.Now()
|
||||
@@ -74,7 +90,7 @@ str := datetime.FormatDateTime(now)
|
||||
|
||||
#### HTTP响应
|
||||
```go
|
||||
import "github.com/go-common/http"
|
||||
import "git.toowon.com/jimmy/go-commom/http"
|
||||
|
||||
http.Success(w, data)
|
||||
http.SuccessPage(w, list, total, page, pageSize)
|
||||
@@ -84,8 +100,8 @@ http.Error(w, 1001, "业务错误")
|
||||
#### 中间件
|
||||
```go
|
||||
import (
|
||||
"github.com/go-common/middleware"
|
||||
"github.com/go-common/http"
|
||||
"git.toowon.com/jimmy/go-commom/middleware"
|
||||
"git.toowon.com/jimmy/go-commom/http"
|
||||
)
|
||||
|
||||
// CORS + 时区中间件
|
||||
@@ -101,7 +117,7 @@ timezone := http.GetTimezone(r)
|
||||
|
||||
#### 配置管理
|
||||
```go
|
||||
import "github.com/go-common/config"
|
||||
import "git.toowon.com/jimmy/go-commom/config"
|
||||
|
||||
// 从文件加载配置
|
||||
cfg, err := config.LoadFromFile("./config.json")
|
||||
@@ -114,7 +130,7 @@ corsConfig := cfg.GetCORS()
|
||||
|
||||
#### 文件上传和查看
|
||||
```go
|
||||
import "github.com/go-common/storage"
|
||||
import "git.toowon.com/jimmy/go-commom/storage"
|
||||
|
||||
// 创建存储实例
|
||||
storage, _ := storage.NewStorage(storage.StorageTypeOSS, cfg)
|
||||
@@ -132,7 +148,7 @@ proxyHandler := storage.NewProxyHandler(storage)
|
||||
|
||||
#### 邮件发送
|
||||
```go
|
||||
import "github.com/go-common/email"
|
||||
import "git.toowon.com/jimmy/go-commom/email"
|
||||
|
||||
// 从配置创建邮件发送器
|
||||
mailer, _ := email.NewEmail(cfg.GetEmail())
|
||||
@@ -147,7 +163,7 @@ mailer.SendSimple(
|
||||
|
||||
#### 短信发送
|
||||
```go
|
||||
import "github.com/go-common/sms"
|
||||
import "git.toowon.com/jimmy/go-commom/sms"
|
||||
|
||||
// 从配置创建短信发送器
|
||||
smsClient, _ := sms.NewSMS(cfg.GetSMS())
|
||||
|
||||
Reference in New Issue
Block a user