sponge 介绍
sponge 是一个集成了 自动生成代码
、Gin和GRPC
的基础开发框架。sponge拥有丰富的生成代码命令,生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。代码解耦模块化设计,很容易构建出从开发到部署的完整工程项目,只需在生成的模板代码上填充业务逻辑代码,极大的提高了开发效率和降低了开发难度。
github地址: https://github.com/zhufuyi/sponge
主要特性
sponge 是一个比较全面的综合开发框架,旨在简化和加速开发过程。它提供了一系列强大的功能和特性,帮助开发人员克服常见的瓶颈并显著提高效率。
界面化操作 | 生成代码命令UI界面化,简单易用。 |
数据库支持 | 支持 MySQL、MongoDB、PostgreSQL、TiDB 和 SQLite 等主流数据库。 |
自动生成代码 | 根据数据库表自动生成代码、合并代码,节省大量时间和精力。 |
服务类型丰富 | 支持web服务、grpc服务、grpc网关服务开发。 |
高可靠高性能 | 服务代码解耦模块化设计,代码经过严格的测试,并遵循良好的编码规范,自带缓存轻松应对高并发。 |
部署自动化 | 提供二进制、docker、kubernetes一站式自动化部署,快速将应用程序部署到生产环境。 |
团队协作 | 代码统一规范化,团队协作更高效。 |
优势
sponge提供了以下优势:
提升开发效率 | 自动生成代码、合并代码等特性显著提高了开发速度。 |
降低开发难度 | 低代码开发使开发人员无需编写大量代码即可创建应用程序。 |
缩短上线时间 | 部署自动化功能减少了部署时间,使应用程序更快地投入生产使用。 |
提高代码质量 | 自动生成的单元测试确保应用程序的高质量和可维护性。 |
降低开发成本 | 通过大幅提高效率和减少开发人员投入,降低了应用程序的总体开发成本。 |
使用场景
sponge适用于各种业务的后端服务开发场景,包括:
- 高性能 Web 服务
- 微服务
- grpc网关服务
生成代码框架
sponge主要基于SQL
和Protobuf
两种方式生成代码,每种方式拥有生成不同用途的代码。其中SQL
支持数据库mysql、mongodb、postgresql、tidb、sqlite。
生成代码的框架图:
生成代码框架对应的UI界面:
生成服务代码的鸡蛋模型
生成服务代码对应的框架图
主要功能
sponge包含丰富的组件(按需使用):
- Web 框架 gin
- RPC 框架 grpc
- 配置解析 viper
- 配置中心 nacos
- 日志 zap
- 数据库组件 gorm
- 缓存组件 go-redis, ristretto
- 自动化api接口文档 swagger, protoc-gen-openapiv2
- 鉴权 jwt
- 校验 validator
- 消息组件 rabbitmq
- 分布式事务管理器 dtm
- 自适应限流 ratelimit
- 自适应熔断 circuitbreaker
- 链路跟踪 opentelemetry
- 监控 prometheus, grafana
- 服务注册与发现 etcd, consul, nacos
- 自适应采集 profile
- 资源统计 gopsutil
- 代码质量检查 golangci-lint
- 持续集成部署 CICD jenkins, docker, kubernetes
目录结构
生成的服务代码目录结构遵循 project-layout,代码目录结构如下所示:
.
├── api # proto文件和生成的*pb.go目录
├── assets # 其他与资源库一起使用的资产(图片、logo等)目录
├── cmd # 程序入口目录
├── configs # 配置文件的目录
├── deployments # IaaS、PaaS、系统和容器协调部署的配置和模板目录
├── docs # 设计文档和界面文档目录
├── internal # 私有应用程序和库的代码目录
│ ├── cache # 基于业务包装的缓存目录
│ ├── config # Go结构的配置文件目录
│ ├── dao # 数据访问目录
│ ├── ecode # 自定义业务错误代码目录
│ ├── handler # http的业务功能实现目录
│ ├── model # 数据库模型目录
│ ├── routers # http路由目录
│ ├── rpcclient # 连接grpc服务的客户端目录
│ ├── server # 服务入口,包括http、grpc等
│ ├── service # grpc的业务功能实现目录
│ └── types # http的请求和响应类型目录
├── pkg # 外部应用程序可以使用的库目录
├── scripts # 用于执行各种构建、安装、分析等操作的脚本目录
├── test # 额外的外部测试程序和测试数据
└── third_party # 外部帮助程序、分叉代码和其他第三方工具
快速开始
安装sponge:
支持在windows、mac、linux、docker环境下安装sponge,点击查看安装说明。
安装完成sponge后,启动UI服务:
sponge run
在浏览器访问 http://localhost:24631
,在页面上填写参数生成代码。
sponge开发示例
一天开发完成一个简单版的社区web后端服务 | 本示例演示如何使用 Sponge 为社区快速开发一个简单的网络后台服务。该服务包括用户注册、登录和发帖等基本功能。 |
单体web服务无缝快速迁移到微服务 | 本示例展示了如何使用 sponge 以最小的代价将单体web服务迁移到微服务,示例涵盖了将服务拆分成多个独立服务并实现它们之间通信的过程。 |
从0开始快速搭建一个包含分布式事务的简单版订单系统 | 本示例演示如何使用 sponge 建立一个具有分布式交易功能的简单订单系统,该系统包括订单创建、优惠券、付款和库存管理等功能。 |
开发文档
视频介绍
- 01 sponge的形成过程
- 02 sponge的框架介绍
- 03 一键生成web服务完整项目代码
- 04 批量生成CRUD接口代码到web服务
- 05 一键生成通用的web服务项目代码
- 06 批量生成任意API接口代码到web服务
- 07 一键生成rpc服务完整项目代码
- 08 批量生成CRUD代码到rpc服务
- 09 一键生成通用的rpc服务完整项目代码
- 10 批量生成rpc方法代码到rpc服务
- 11 rpc测试神器,简单便捷
- 12 一键生成rpc网关服务完整项目代码
- 13 十分钟搭建一个微服务集群示例
总结
sponge 是一个帮助你大幅提高开发效率、降低开发成本的开发框架,通过支持主流数据库、低代码开发和自动化功能,它为各种后端服务开发场景提供了无与伦比的价值。如果您正在寻找一种方法来显著提高开发效率并缩短上线时间,那么sponge绝对值得一试。
专题「golang相关」的其它文章 »
- 使用开发框架sponge快速把单体web服务拆分为微服务 (Sep 18, 2023)
- 使用开发框架sponge一天多开发完成一个简单版社区后端服务 (Jul 30, 2023)
- go test命令 (Apr 15, 2022)
- go应用程序性能分析 (Mar 29, 2022)
- channel原理和应用 (Mar 22, 2022)
- go runtime (Mar 14, 2022)
- go调试工具 (Mar 13, 2022)
- cobra (Mar 10, 2022)
- grpc使用实践 (Nov 27, 2020)
- 配置文件viper库 (Nov 22, 2020)
- 根据服务名称查看golang程序的profile信息 (Sep 03, 2019)
- go语言开发规范 (Aug 28, 2019)
- goroutine和channel应用——处理队列 (Sep 06, 2018)
- golang中的context包 (Aug 28, 2018)