sponge

English | 简体中文

Sponge 是一个强大的开发框架，集成了自动代码生成、Gin和GRPC。Sponge拥有丰富的代码生成命令集，生成的不同功能代码可以组合成一个完整的服务（类似于人为破碎的海绵细胞可以自动重组成新的完整海绵）。Sponge提供一站式项目开发（代码生成、开发、测试、API文档、部署），它极大地提高了开发效率并降低了开发难度，以"低代码方式"开发高质量项目。

如果您正在开发带有CRUD API的Web或gRPC服务，无需编写任何Go代码即可编译并部署到Linux服务器、Docker、K8s，只需连接到数据库（mysql、mongodb、postgresql、tidb、sqlite）即可生成完整的后端服务Go代码。

如果您开发通用的Web或gRPC服务，只需专注于在数据库中定义表、在proto文件中定义API描述信息、在生成的模板文件中填写业务逻辑代码这三个核心部分，其余的Go代码都由sponge自动生成。

Sponge生成的代码框架

Sponge主要基于SQL和Protobuf两种方式生成代码，每种方式都可以生成不同功能的代码。SQL支持mysql、mongodb、postgresql、tidb、sqlite数据库。

生成代码框架

生成代码框架对应的UI界面

微服务框架

Sponge也是一个微服务框架，框架图如下所示，这是一个典型的微服务分层结构，具有高性能、高可扩展性，包含常用的服务治理功能，您可以轻松替换或添加自己的服务治理功能。

微服务框架创建的http和grpc服务代码的性能测试：50并发，总请求100万。

grpc-server

点击查看测试代码。

主要特性

Web框架 gin
RPC框架 grpc
配置解析 viper
配置中心 nacos
日志组件 zap
数据库ORM组件 gorm, mongo-go-driver
缓存组件 go-redis, ristretto
自动化API文档 swagger, protoc-gen-openapiv2
认证 jwt
Websocket gorilla/websocket
消息队列 rabbitmq, kafka
分布式事务管理器 dtm
参数验证 validator
自适应限流 ratelimit
自适应熔断 circuitbreaker
分布式链路追踪 opentelemetry
指标监控 prometheus, grafana
服务注册与发现 etcd, consul, nacos
自适应采集 profile
资源统计 gopsutil
代码质量检查 golangci-lint
持续集成和部署 jenkins, docker, kubernetes

项目代码目录结构

sponge创建的项目代码目录结构遵循project-layout，结构如下。支持的仓库类型有单体应用单仓库(monolith)、微服务多仓库(multi-repo)、微服务单仓库(mono-repo)。

.
├── api            # 对外暴露API接口的目录，通常包含proto文件和生成的*.pb.go文件。目录结构通常为api/xxx/v1的形式，其中v1表示版本。
├── assets         # 存放各种静态资源，如图片、markdown文件等。
├── cmd            # 程序入口目录
│    └── serviceName
│         ├── initial     # 程序初始化，由三个文件组成：initApp初始化配置，registerServers注册服务（HTTP或grpc），registerClose注册资源清理。
│         └── main.go     # 程序入口文件
├── configs        # 配置文件目录
├── deployments    # 部署脚本目录，支持裸机、Docker和Kubernetes部署。
├─ docs            # API接口Swagger文档目录。
├── i(I)nternal       # 业务逻辑代码目录，如果首字母小写(internal)，表示私有代码，如果首字母大写(Internal)，表示可以被其他代码复用。
│    ├── cache        # 封装业务逻辑的缓存目录。
│    ├── config       # Go结构配置文件目录。
│    ├── dao          # 数据访问目录。
│    ├── ecode        # 系统错误码和自定义业务错误码目录。
│    ├── handler      # 实现HTTP业务功能的目录（特定于web服务）。
│    ├── model        # 数据库模型目录。
│    ├── routers      # HTTP路由目录。
│    ├── rpcclient    # 连接grpc服务的客户端代码目录。
│    ├── server       # 创建服务的目录，包括HTTP和grpc。
│    ├── service      # 实现grpc业务功能的目录（特定于grpc服务）。
│    └── types        # 定义HTTP请求和响应参数结构的目录。
├── pkg            # 共享库目录。
├── scripts        # 脚本目录，包括编译、执行、代码生成和部署脚本。
├── test           # 测试服务所需的脚本目录和测试SQL。
└── third_party    # 外部辅助程序、分叉代码和其他第三方工具的目录。