11 KiB
English | 简体中文
简介
Sponge 是一款强大且易用的 Go 开发框架。它基于 "Definition is Code" (定义即代码) 的核心理念，致力于通过自动生成技术重塑后端开发体验，解放生产力，大幅提升开发效率。
Sponge 深度集成了 代码生成引擎、 Gin (Web 框架) 与 gRPC (微服务框架)，涵盖了从项目生成、开发、测试、API 文档到部署的软件全生命周期。
核心特性：
- 定义驱动开发：自动解析 SQL、Protobuf 和 JSON 配置文件，生成高质量的模块化代码。
- 积木式组装：以松耦合的方式灵活组合代码模块，支持快速构建 单体应用、微服务集群 及 网关服务，包括
RESTful API、gRPC、HTTP+gRPC、gRPC Gateway等。 - 低代码，高效率：彻底消除从底层框架搭建、CRUD开发到路由配置、服务治理等一系列繁琐的重复性工作。开发者只需专注于核心业务逻辑，即可快速交付标准化、高质量的后端服务。
为什么选择 Sponge？
- 极致的开发效率：一键生成可直接线上部署的完整后端服务，包括 CRUD、路由、文档及服务框架代码等，开发效率成倍提升。
- 开箱即用的工具链：提供完整的开发工具链（生成 → 填充业务 → 测试 → 部署 → 监控），无需拼凑碎片化工具。
- 行业最佳实践：基于 Go 社区主流技术栈（Gin/GORM/gRPC/Protobuf 等）构建，架构规范，降低技术选型风险。
- 极低的学习门槛：上手简单，对新手友好，同时满足资深开发者的定制需求。
- 适合团队协作：统一项目结构，提升团队协作效率和代码可维护性。
- 灵活可扩展：支持自定义模板，不仅限于 Go，还可扩展前端、测试脚本等任意代码生成。
- AI 驱动开发 (AI-Native)：
- Sponge： 自动构建标准化的基础设施（API、数据层、服务框架）。
- AI 助手： 基于项目上下文，智能填充核心业务逻辑，实现“基建自动化，业务智能化”。
适用场景
Sponge 适用于构建高性能、可维护的后端系统，特别适合：
- 快速开发 RESTful API 服务。
- 构建大规模微服务架构。
- 云原生应用开发。
- 旧有项目的快速重构与迁移。
- Go 语言初学者或团队的标准化工程模板。
在线体验
无需安装，直接在浏览器中体验代码生成功能：Code Generation
注：若需在本地运行下载的服务代码，需先完成 Sponge 的本地安装。
快速上手
-
安装 Sponge：支持 Windows、macOS、Linux 及 Docker 环境，查看 Sponge 安装指南。
-
打开生成代码 UI 页面
sponge run在本地浏览器访问
http://localhost:24631生成代码。 -
示例：基于 SQL 一键生成 Web 服务后端代码
- 操作流程：
- 填写参数：在 UI 中连接数据库并选择表。
- 下载代码：点击生成并下载完整项目包。
- 生成 swagger 文档：在项目根目录执行
make docs。 - 启动服务：执行
make run。 - 测试接口：在浏览器中访问
http://localhost:8080/swagger/index.html通过 Swagger 界面进行 API 测试。
- 操作流程：
技术栈与组件
Sponge 遵循“电池内置”原则，集成了 30+ 个 Go 生态主流组件，按需加载：
| 类别 | 组件 |
|---|---|
| 框架 | Gin, gRPC |
| 数据库 | GORM (MySQL, PostgreSQL, SQLite等), MongoDB |
| 缓存/消息 | Redis, Kafka, RabbitMQ |
| 服务治理 | Etcd, Consul, Nacos, Jaeger, Prometheus, OpenTelemetry |
| 其他 | DTM (分布式事务), WebSocket, Swagger, PProf |
| ... | ... |
架构与原理
代码生成引擎
Sponge 提供多种代码生成引擎，支持内置模板、自定义模板以及AI 辅助生成。
- 基于内置模板的代码生成引擎，如下图所示：
- 基于自定义模板代码生成引擎，如下图所示：
- AI 辅助业务逻辑代码生成引擎，如下图所示：
微服务架构
Sponge 生成的代码遵循典型的分层架构，内置服务治理能力，结构清晰，易于维护。Sponge 的微服务框架结构如下图所示：
性能基准测试
基于 50 并发、100 万次请求的测试结果显示，Sponge 生成的服务具有优异的性能表现：
-
HTTP 服务
-
gRPC 服务
👉 查看详细测试代码与环境。
目录结构
Sponge 创建的服务代码目录结构遵循 project-layout，支持 Monolith (单体)、Multi-Repo (多仓微服务) 及 Mono-Repo (单仓微服务) 模式。
1. Monolith / Multi-Repo 结构详解。
.
├── api # protobuf文件和生成的*pb.go目录
├── assets # 其他与资源库一起使用的资产(图片、logo等)目录
├── cmd # 程序入口目录
├── configs # 配置文件的目录
├── deployments # 裸机、docker、k8s部署脚本目录
├── docs # 设计文档和界面文档目录
├── internal # 项目内部代码目录
│ ├── cache # 基于业务包装的缓存目录
│ ├── config # Go结构的配置文件目录
│ ├── dao # 数据访问目录
│ ├── database # 数据库目录
│ ├── ecode # 自定义业务错误代码目录
│ ├── handler # http的业务功能实现目录
│ ├── model # 数据库模型目录
│ ├── routers # http路由目录
│ ├── rpcclient # 连接grpc服务的客户端目录
│ ├── server # 服务入口，包括http、grpc等
│ ├── service # grpc的业务功能实现目录
│ └── types # http的请求和响应类型目录
├── pkg # 外部应用程序可以使用的库目录
├── scripts # 执行脚本目录
├── test # 额外的外部测试程序和测试数据
├── third_party # 依赖第三方protobuf文件或其他工具的目录
├── Makefile # 开发、测试、部署相关的命令集合
├── go.mod # go 模块依赖关系和版本控制文件
└── go.sum # go 模块依赖项的密钥和校验文件
2. Mono-Repo (大仓) 结构详解。
.
├── api
│ ├── server1 # 服务1的protobuf文件和生成的*pb.go目录
│ ├── server2 # 服务2的protobuf文件和生成的*pb.go目录
│ ├── server3 # 服务3的protobuf文件和生成的*pb.go目录
│ └── ...
├── server1 # 服务1的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
├── server2 # 服务2的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
├── server3 # 服务3的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
├── ...
├── third_party # 依赖的第三方protobuf文件
├── go.mod # go 模块依赖关系和版本控制文件
└── go.sum # go 模块依赖项的密钥和校验和文件
文档
点击查看 Sponge 官方文档，完整涵盖了开发指南、组件、服务配置与部署方案等核心内容。
示例项目
基础示例
- Web 服务 (基于 SQL, 含 CRUD)
- gRPC 微服务 (基于 SQL, 含 CRUD)
- Web 服务 (基于 Protobuf)
- gRPC 微服务 (基于 Protobuf)
- gRPC 网关服务 (Gateway)
- gRPC+HTTP 微服务 (基于 Protobuf)
进阶实战
社区与贡献
欢迎 Issue/PR！贡献指南。
欢迎加入go sponge微信群交流，加微信(备注sponge)进群。
如果 Sponge 对您有帮助，请给个 ⭐ Star！这将是我们持续更新的动力。