MoG

Mooko Go Web 基础框架。基于 Gin、Gorm 等开源项目构建，用于快速开发 Web 应用。

特性

• Web 框架: 基于 Gin 的高性能 HTTP 路由
• ORM: 使用 Gorm 进行数据库操作
• 数据库支持: MySQL、PostgreSQL、SQLite3
• 认证: 基于 JWT 的认证系统，支持 Token 撤销
• 缓存: 支持 Redis、Badger、内存缓存
• 对象存储: MinIO 客户端集成
• 邮件: 邮件发送功能
• 日志: 基于 zap 的结构化日志
• 配置: TOML 格式配置文件
• 中间件: 恢复、追踪、日志、认证等常用中间件
• 错误处理: 统一的错误处理和响应格式
• CRUD: 开箱即用的 CRUD 功能

快速开始

安装

go get github.com/puras/mog

构建和运行

# 克隆仓库
git clone https://github.com/puras/mog.git
cd mog

# 构建项目
go build

# 运行服务器（使用默认配置文件 conf/config.tom.toml）
./app start

# 指定配置文件运行
./app start --conf conf/config.toml

# 以守护进程模式运行
./app start --daemon

# 停止服务器
./app stop

项目结构

mog/
├── cachex/        # 缓存封装（Redis、Badger、Memory）
├── command/       # CLI 命令
├── config/        # 配置管理
├── contextx/      # 上下文封装
├── crud/          # CRUD 基础实现
├── crypto/        # 加密工具
├── dbx/           # 数据库扩展（GORM 封装、事务、分页）
├── errors/        # 错误处理
├── inject/        # 依赖注入
├── jwtx/          # JWT 认证
├── logger/        # 日志系统
├── mail/          # 邮件发送
├── middleware/    # Gin 中间件
├── model/         # 数据模型基类
├── module/        # 模块系统
├── oss/           # 对象存储（MinIO）
├── server/        # 服务器启动
├── utils/         # 工具函数
└── web/           # Web 响应封装

核心模块

配置管理

使用 TOML 格式配置文件：

[General]
AppName = "myapp"
DebugMode = true

[General.HTTP]
Addr = ":8000"

[Storage.DataBase]
Type = "sqlite3"
DSN = "data/sqlite/app.db"
AutoMigrate = true

[Middleware.Auth]
SkippedPathPrefixes = ["/health", "/api/v1/login"]

依赖注入

手动依赖注入，返回清理函数：

inj, cleanup, err := inject.InitInjector(ctx)
defer cleanup()

数据库操作

支持读写分离、事务管理、分页查询：

// 获取 DB 实例
db := dbx.GetDB(ctx, injector.DB)

// 分页查询
result, err := dbx.WrapPageQuery(ctx, db.Model(&User{}), pp, dbx.QueryOptions{}, &users)

// 事务
err := trans.Exec(ctx, func(ctx context.Context) error {
    db := dbx.GetDB(ctx, trans.DB)
    // 执行数据库操作
    return nil
})

认证中间件

基于 JWT 的认证，支持多种存储后端：

// 配置认证中间件
auth := middleware.Auth(inj.Auth, middleware.AuthConfig{
    SkippedPathPrefixes: []string{"/health", "/api/v1/login"},
})

统一响应格式

// 成功响应
web.ResOk(c)
web.ResSuccess(c, data)
web.ResPage(c, list, total)

// 错误响应
web.ResError(c, errors.BadRequest("无效参数"))

CRUD 功能

开箱即用的 CRUD 实现：

type UserModule struct {
    crud.BaseCRUD
}

func (m *UserModule) Init(ctx context.Context) error {
    m.SetModel(&User{})
    return nil
}

典型应用

package main

import (
    "context"
    "reflect"

    "github.com/puras/mog/command"
    "github.com/puras/mog/inject"
    "github.com/puras/mog/jwtx"
    "github.com/puras/mog/module"
    "github.com/puras/mog/server"
    "github.com/puras/mog/web"
    "github.com/urfave/cli/v2"
)

type App struct {
    inj *inject.Injector
}

func (a *App) Init(ctx context.Context) error {
    inj, cleanup, err := inject.InitInjector(ctx)
    if err != nil {
        return err
    }
    a.inj = inj
    return nil
}

func (a *App) GetInjector(ctx context.Context) *inject.Injector {
    return a.inj
}

func (a *App) RegistryRoutes(ctx context.Context, e *gin.Engine) error {
    return module.RegistryRoutes(ctx, e, reflect.ValueOf(*a))
}

func (a *App) ParseCurrentUser(c *gin.Context) (string, error) {
    token := web.GetToken(c)
    return a.inj.Auth.ParseSubject(c.Request.Context(), token)
}

func main() {
    app := cli.NewApp()
    app.Name = "myapp"
    app.Commands = []*cli.Command{
        command.StartCmd(&App{}),
        command.StopCmd(),
    }
    app.Run(os.Args)
}

依赖管理

# 下载依赖
go mod download

# 整理依赖
go mod tidy

测试

# 运行所有测试
go test ./...

# 运行特定包的测试
go test ./path/to/package

版本

查看 CHANGELOG.md 了解版本变更历史。

许可证

MIT License