gox

module
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2026 License: MIT

README

gox

对常用 Go 第三方库的二次封装，提供统一的 API 风格和开箱即用的配置。专注于提升开发效率和代码一致性。

安装

只需安装一次，即可使用所有包：

go get github.com/f2xme/gox

然后在代码中按需导入具体的包：

import "github.com/f2xme/gox/captcha"
import "github.com/f2xme/gox/encrypt"
import "github.com/f2xme/gox/redis"
// ... 其他包

项目结构

每个顶层目录都是一个独立的包，可以单独导入使用：

github.com/f2xme/gox/<package>
可用包
  • cache - 缓存操作封装
    • adapter/memadapter - 内存缓存适配器
    • adapter/redisadapter - Redis 缓存适配器
  • captcha - 验证码生成和验证
  • config - 配置管理封装
    • adapter/viperadapter - Viper 适配器
  • database - 数据库操作封装
    • adapter/mysqldb - MySQL 适配器
    • adapter/pgsqldb - PostgreSQL 适配器
    • adapter/sqlitedb - SQLite 适配器
  • encrypt - 加密工具封装
  • errorx - 错误处理增强
  • graceful - 优雅关闭封装
  • httpx - HTTP 工具封装
    • adapter/ginadapter - Gin 框架适配器
  • idgen - ID 生成器
  • jwt - JWT 令牌处理
  • logx - 日志封装
    • adapter/zapadapter - Zap 日志适配器
  • metrics - 指标监控封装
  • email - 邮件服务封装
  • oss - 对象存储封装
  • pager - 分页工具
  • payment - 支付服务封装
  • queue - 队列封装
    • adapter/memadapter - 内存队列适配器
  • ratelimit - 限流工具
  • sms - 短信服务封装
    • aliyun - 阿里云短信适配器
    • tencent - 腾讯云短信适配器
    • volcengine - 火山引擎短信适配器
  • timex - 时间工具
  • trace - 链路追踪封装
  • validator - 数据验证封装

Directories

Path Synopsis
Package cache 提供统一的缓存操作抽象层。
 Package cache 提供统一的缓存操作抽象层。
adapter/memory
Package memory 提供基于内存的缓存实现。
 Package memory 提供基于内存的缓存实现。
adapter/redis module
Package captcha 提供验证码生成、存储、验证和消费能力。
 Package captcha 提供验证码生成、存储、验证和消费能力。
adapter/cache
Package cache 提供基于 gox/cache 的验证码存储适配器。
 Package cache 提供基于 gox/cache 的验证码存储适配器。
adapter/memory
Package memory 提供验证码内存存储适配器。
 Package memory 提供验证码内存存储适配器。
generator/base64
Package base64 提供基于 base64Captcha 库的验证码生成器。
 Package base64 提供基于 base64Captcha 库的验证码生成器。
Package collection 提供泛型集合工具函数，类似 lodash 的功能。
 Package collection 提供泛型集合工具函数，类似 lodash 的功能。
Package config 提供统一的配置读取抽象层。
 Package config 提供统一的配置读取抽象层。
adapter/viper module
adapter/viperadapter module
crypto module
Package database 提供统一的数据库连接管理抽象层。
 Package database 提供统一的数据库连接管理抽象层。
adapter/internal/gormbase
adapter/pgsqldb module
adapter/sqlitedb module
Package email 提供通过 SMTP 发送邮件的客户端。
 Package email 提供通过 SMTP 发送邮件的客户端。
encrypt module
Package errorx 提供增强的错误处理功能，支持错误码、堆栈跟踪和错误分类。
 Package errorx 提供增强的错误处理功能，支持错误码、堆栈跟踪和错误分类。
Package graceful 提供应用程序的优雅关闭管理功能。
 Package graceful 提供应用程序的优雅关闭管理功能。
Package httpx 提供统一的 HTTP 框架抽象层。
 Package httpx 提供统一的 HTTP 框架抽象层。
middleware/auth
Package auth 提供基于 Bearer Token 的 HTTP 认证中间件。
 Package auth 提供基于 Bearer Token 的 HTTP 认证中间件。
middleware/cors
Package cors 提供 CORS（跨域资源共享）中间件。
 Package cors 提供 CORS（跨域资源共享）中间件。
middleware/logger
Package logger 提供 HTTP 请求日志中间件。
 Package logger 提供 HTTP 请求日志中间件。
middleware/metrics
Package metrics 提供 HTTP 指标收集中间件。
 Package metrics 提供 HTTP 指标收集中间件。
middleware/ratelimit
Package ratelimit 提供 HTTP 请求限流中间件。
 Package ratelimit 提供 HTTP 请求限流中间件。
middleware/recovery
Package recovery 提供 HTTP 中间件，用于捕获 panic 并将其转换为错误。
 Package recovery 提供 HTTP 中间件，用于捕获 panic 并将其转换为错误。
middleware/requestid
Package requestid 提供 HTTP 请求 ID 中间件，用于追踪和关联请求。
 Package requestid 提供 HTTP 请求 ID 中间件，用于追踪和关联请求。
middleware/security
Package security 提供 HTTP 安全中间件，防护常见的 Web 攻击。
 Package security 提供 HTTP 安全中间件，防护常见的 Web 攻击。
middleware/timeout
Package timeout 提供 HTTP 请求超时中间件。
 Package timeout 提供 HTTP 请求超时中间件。
middleware/tracing
Package tracing 提供分布式追踪中间件，用于跟踪 HTTP 请求在服务间的流转。
 Package tracing 提供分布式追踪中间件，用于跟踪 HTTP 请求在服务间的流转。
middleware/validator
Package validator 提供 HTTP 请求验证中间件。
 Package validator 提供 HTTP 请求验证中间件。
mock
Package mock 提供用于测试 httpx 应用的 mock 对象。
 Package mock 提供用于测试 httpx 应用的 mock 对象。
adapter/gin module
adapter/ginadapter module
Package idgen 提供多种 ID 生成算法。
 Package idgen 提供多种 ID 生成算法。
Package jwt 提供 JWT 令牌的生成、解析和验证功能。
 Package jwt 提供 JWT 令牌的生成、解析和验证功能。
Package logx 提供统一的日志记录抽象层。
 Package logx 提供统一的日志记录抽象层。
adapter/zap module
adapter/zapadapter module
Package metrics 提供统一的指标监控抽象层，支持多种监控后端。
 Package metrics 提供统一的指标监控抽象层，支持多种监控后端。
adapter/prometheus
Package prometheus 提供 Prometheus 监控系统的 metrics 适配器实现。
 Package prometheus 提供 Prometheus 监控系统的 metrics 适配器实现。
oss
Package oss 提供统一的对象存储抽象。
 Package oss 提供统一的对象存储抽象。
adapter/aliyun module
Package pager 提供 API 和数据库的分页工具。
 Package pager 提供 API 和数据库的分页工具。
Package payment 提供统一的支付操作抽象层。
 Package payment 提供统一的支付操作抽象层。
adapter/alipay
Package alipay 为支付接口提供支付宝适配器。
 Package alipay 为支付接口提供支付宝适配器。
adapter/wechat
Package wechat 为支付接口提供微信支付适配器。
 Package wechat 为支付接口提供微信支付适配器。
queue module
adapter/mem module
adapter/memadapter module
adapter/rocketmq module
Package ratelimit 提供多种限流算法实现。
 Package ratelimit 提供多种限流算法实现。
Package serializer 提供统一的序列化接口和多种格式适配器。
 Package serializer 提供统一的序列化接口和多种格式适配器。
Package session 提供通用会话管理能力。
 Package session 提供通用会话管理能力。
adapter/memory
Package memory 提供基于内存的 session.Store 实现。
 Package memory 提供基于内存的 session.Store 实现。
adapter/redis module
sms
Package sms 提供统一的短信服务抽象层。
 Package sms 提供统一的短信服务抽象层。
adapter/aliyun module
Package timex 提供便捷的时间操作工具函数。
 Package timex 提供便捷的时间操作工具函数。
Package trace 提供轻量级链路追踪功能。
 Package trace 提供轻量级链路追踪功能。
validator module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.