.profile/README.zh-CN.md

[English](README.md) | [简体中文](README.zh-CN.md)

# @go 开发指引 (INDEX)

## 设计哲学与原则

本项目致力于构建一套**极致精简、消除摩擦、安全可靠、高性能**的 Go 开发基础设施。我们的核心设计理念包括：

*   **统一性**: 提供一套标准化的工具集，减少跨库切换的认知负担。
*   **易用性**: 极简 API 设计，降低门槛，加速开发。
*   **可靠与安全**: 预置安全最佳实践（如加密、内存擦除），确保代码稳健。
*   **高性能**: 深度利用 Go 特性，追求卓越的运行效率。
*   **解决痛点**: 专注于消除类型转换、错误处理、服务发现等过程中的摩擦。

---

## 模块清单与 API 参考

详细文档: https://apigo.cc/go/

### go/cast v1.2.10
语义化类型强转与泛型工具。
- **API**: `To`, `Convert`, `As`, `ToMap`, `ToSlice`, `FillMap`, `FillSlice`, `ToJSON`, `FromJSON`, `UnmarshalJSON`, `ParseTime`, `FormatTime`, `Int`, `String`, `Bool`, `Duration`

### go/rand v1.0.6
高并发场景下的随机数与字节生成。
- **API**: `Int`, `FastInt`, `Float`, `Byte`, `Bytes`, `Perm`, `Shuffle`

### go/timer v1.0.7
高性能时间流管控与退避重试。
- **API**: `Retry`, `Start`, `WithBackoff`, `WithMaxRetries`, `NewDebouncer`, `NewThrottler`, `NewTimeWheel`

### go/safe v1.0.7
内存保护、安全擦除与防核心转储。
- **API**: `NewSafeBuf`, `NewSafeString`, `LockMemory`, `UnlockMemory`, `DisableCoreDump`, `ZeroMemory`, `EncryptChaCha20`, `DecryptChaCha20`

### go/encoding v1.1.2
标准及整数填充编解码。
- **API**: `Hex`, `Base64`, `UrlEncode`, `HtmlEscape`, `NewIntEncoder`, `EncodeInt`, `DecodeInt`, `HashInt`

### go/crypto v1.1.1
主流加解密算法与混合加密体系。
- **API**: `NewAESGCM`, `NewRSA`, `NewECDSA`, `NewED25519`, `NewX25519`, `EncryptBytes`, `DecryptBytes`, `Sign`, `Verify`, `MD5`, `Sha256`, `HmacSha256`

### go/crypto-sm v1.1.1
国密 (SM2/3/4) 标准实现。
- **API**: `NewSM2`, `Sm3`, `Sm3ToHex`, `NewSM4CBC`, `NewSM4GCM`, `Encrypt`, `Decrypt`

### go/id v1.0.7
分布式与数据库性能优化的 ID 生成。
- **API**: `NewIDMaker`, `Get8Bytes4KPerSecond`, `Get12BytesUltraPerSecond`, `GetForMysql`

### go/file v1.0.8
高性能磁盘 IO 与嵌入式内存文件。
- **API**: `Exists`, `Read`, `Write`, `Copy`, `Move`, `Remove`, `Search`, `UnmarshalFile`, `MarshalFile`, `Archive`, `Compress`, `LoadFileToMemory`

### go/shell v1.0.6
终端样式美化与命令链管道执行。
- **API**: `Run`, `Pipeline`, `Style`, `Red`, `Green`, `Blue`, `Yellow`

### go/config v1.0.8
支持环境变量覆盖的配置文件加载。
- **API**: `Load`

### go/log v1.3.2
高性能 Meta 驱动的异步脱敏日志。
- **API**: `Debug`, `Info`, `Warning`, `Error`, `As`, `New`, `SetLevel`, `Viewable`, `GetEntry`, `PutEntry`

### go/http v1.0.11
极致精简的高性能 HTTP 客户端。
- **API**: `NewClient`, `NewClientH2C`, `Get`, `Post`, `Put`, `Delete`, `Do`, `Result`, `Multipart`

### go/redis v1.0.9
集成 Pub/Sub 的高性能 Redis 客户端。
- **API**: `GetRedis`, `NewRedis`, `Do`, `Subscribe`, `PUBLISH`, `NewIDMaker`

### go/db v1.0.11
意图优先的极简数据库抽象层。
- **API**: `GetDB`, `Sync`, `Insert`, `Update`, `Delete`, `Query`, `Exec`, `Begin`

### go/discover v1.0.11
极简的服务发现与负载均衡调用。
- **API**: `Start`, `NewCaller`, `Get`, `Post`, `SetLoadBalancer`, `SetRoute`

### go/service v1.1.1
核心微服务框架，支持自动注入与路由映射。
- **API**: `Start`, `AsyncStart`, `Register`, `Restful`, `RegisterWebsocket`, `Static`, `Proxy`, `VerifyStruct`

### go/watch v1.1.2
高性能、AI 友好的文件变动监听。
- **API**: `Start`, `EasyStart`, `Watcher`

### go/vision v1.0.0
高性能图像处理、验证码、二维码与感知哈希工具。
- **API**: `New`, `Load`, `Save`, `Resize`, `Fit`, `Fill`, `Rotate`, `Blur`, `Grayscale`, `SetFont`, `DrawText`, `GenerateCaptcha`, `GenerateQRCode`, `PHash`, `Distance`

### go/keys v1.0.1
密钥管理与跨语言加固加密工具。
- **API**: `GenerateKey`, `Encrypt`, `Decrypt`, `ExportGo`, `ExportJS`, `ExportPython`, `ExportJava`, `ExportPHP`

### go/starter v1.0.0
服务生命周期与后台运行管控。
- **API**: `SetInfo`, `SetPidFile`, `SetLogFile`, `OnStart`, `OnStop`, `OnReload`, `Run`, `AddCmd`

### go/api v1.0.4
第三方 API 调度引擎，消除 SDK 摩擦。
- **API**: `Call[T]`, `Load`, `RegisterSigner`, `GetSigner`, `Action`

### go/mail v1.0.0
极致精简的高性能邮件客户端。
- **API**: `Send`, `MustSend`, `Recv`, `MustRecv`, `New`, `MustNew`, `NewWithConfig`, `ParseAddr`, `FormatAddr`

### go/document v1.0.3
极简、高效的 Office 文档桥梁，支持 Excel/Word/PPT/PDF 与 JSON/Markdown 互转。
- **API**: `Open`, `Create`, `Save`, `ToJSON`, `ToMarkdown`

### go/gateway v2.0.0
基于 @go/service 和 Redis 的高性能、事件驱动动态 API 网关。
- **API**: `NewGatewayApp`, `GatewayApp.Init`, `GatewayApp.Stop`