sponge

README

sponge 中文文档

sponge is a powerful tool for generating web and microservice code, as well as a microservice framework based on gin and grpc encapsulation. Sponge has a wealth of code generation commands, and different functional codes can be combined to form a complete service (similar to artificially scattered sponge cells that can automatically recombine into a new sponge). Microservice code functions include logging, service registration and discovery, registration center, flow control, fuse, link tracking, metric monitoring, pprof performance analysis, statistics, cache, CICD and other functions. The code is decoupled and modularly designed, making it easy to build complete engineering code from development to deployment, making it more convenient, easy and efficient to develop with Go language.

sponge generates the code framework

The generated code is based on three approaches Yaml, SQL and Protobuf, each possessing different functional code generation, and the framework diagram of the generated code is shown in Figure 1-1.

Figure 1-1 sponge generation code framework diagram

Microservices framework

The microservice code framework created by sponge is shown in Figure 1-2, this is a typical microservice hierarchy with high performance, high scalability, and includes common service governance features.

Figure 1-2 Microservices framework diagram

Supported code types for generation

• Generate complete web service project code based on MySQL table
• Generate handler code based on MySQL tables, including CRUD code
• Generate dao code based on MySQL tables, including CRUD code
• Generate gorm model code based on MySQL tables
• Generate complete rpc service project code based on MySQL table
• Generate service code based on MySQL tables, including CRUD code
• Generate protobuf code based on MySQL tables
• Generate generic web service project code based on protobuf
• Generate generic rpc service project code based on protobuf
• Generate rpc gateway service project code based on protobuf
• Generate corresponding go structure code based on yaml
• Generate rpc connection code according to parameters
• Generate cache code according to parameters

The generated code can be combined into actual project web or microservice code, and the developer only needs to focus on writing the business logic code, online UI interface demo: https://go-sponge.com/ui

Installation

• Install sponge in linux or macOS
• Install sponge in windows

Quick start

After installing the sponge, start the UI service:

sponge run

Visit http://localhost:24631 in your browser, generate code by manipulating it on the page.

Examples of use

• 1_web-gin-CRUD
• 2_web-gin-protobuf
• 3_micro-grpc-CRUD
• 4_micro-grpc-protobuf
• 5_micro-gin-rpc-gateway
• 6_micro-cluster

Documentation

sponge usage documentation

If it's help to you, give it a star ⭐.

License

See the LICENSE file for licensing information.

Documentation

Overview

Package sponge is a microservice framework, a tool for quickly creating microservice code. sponge has a rich generating code commands, a total of 12 different functional code, these functional code can be combined into a complete service (similar to artificially broken sponge cells can be automatically reorganized into a new sponge ). Microservice code features include logging, service registration and discovery, registry, rate limit, circuit breaker, trace, metrics monitoring, pprof performance analysis, statistics, caching, CICD. The code uses a decoupled layered structure and it's easy to add or replace functional code. As an efficiency-enhancing tool, commonly repeated code is basically generated automatically and only business logic code needs to be populated based on the generated template code examples.

https://github.com/zhufuyi/sponge/blob/main/README.md

sponge -h
sponge a microservice framework, a tool for quickly creating microservice code.

Usage:
sponge [command]

Available Commands:
completion  Generate the autocompletion script for the specified shell
config         Generate go config codes from yaml file
help           Help about any command
init            Initialize sponge
micro        Generate proto, model, dao, service, rpc, rpc-gw, rpc-cli codes
tools         Managing sponge dependency tools
update      Update sponge to the latest version
web          Generate model, dao, handler, http codes