sponge

sponge 中文

sponge is a microservice framework, a tool to quickly generate web and 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 limiter, circuit breaker, trace, metrics monitoring, pprof performance analysis, statistics, caching, CICD. Code decoupling modular design, including the complete project from development to deployment, common code and scripts are automatically generated, only in accordance with the code template to write business logic code, making the development efficiency improved a lot.

sponge generates the code framework

The generated code is based on three approaches Yaml, SQL DDL and Protocol buffers, 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

Installation

(1) install sponge

go install github.com/zhufuyi/sponge/cmd/sponge@latest

(2) install dependency plugins and tools

sponge init

If there is a dependency tool installation error(except protoc), execute the command to retry sponge tools --install

(3) install protoc

Download it from https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.3 and add the directory where the protoc file is located under system path.

💡 NOTICE:

If you are using windows environment, you need to install some additional dependency tools, see windows dependency tools for installation steps.

Quick start

Once you have installed sponge and the dependencies, you are ready to go, start the ui service from the command line:

sponge run

Visit http://localhost:24631 in your browser.

💡 NOTICE:

Do not execute the "sponge run" in the directory where the sponge file is located, as this will result in an error:

exec: "sponge": cannot run executable found relative to current directory

A sample web project code generated from sql:

After download the web project code, execute the command to start the service.

# Update swagger documentation
make docs

# Compile and run the service
make run

Generate other types of code you can try yourself.

Documentation

sponge usage documentation

License

See the LICENSE file for licensing information.