markdown-body entry-content container-lg" itemprop="text">

English | 简体中文

Sponge is a powerful golang productivity tool that integrates automatic code generation, web and microservices frameworks, basic development framework. sponge has a wealth of generating code commands, generating different functional code can be combined into a complete service (similar to the way that artificially broken sponge cells can automatically recombine into a new sponge). The code is decoupled and modularly designed, it is easy to build a complete project from development to deployment, so that you develop web or microservices project easily, golang can also be "low-code development".

If you are developing a RESTful web or microservice with a simple CRUD API interface, you don't need to write a single line of golang code to compile and deploy to servers, dockers, k8s, and the complete service code is generated by sponge.

If you develop a generic RESTful web or microservice, you need to manually write code in addition to defining the data table, defining the api interface in the proto file, and filling in the specific business logic code in the generated template file. Other golang codes are generated by sponge.

sponge generates the code framework

sponge is mainly based on SQL and Protobuf two ways to generate code, each way has to generate code for different functions.

Generate code framework:

Generate code framework corresponding UI interface:

Services framework

sponge generated microservice code framework is shown in the figure below, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.

Egg model of a web service code generated by sponge

The sponge separates the two major parts of code during the process of generating web service code. It isolates the business logic from the non-business logic. For example, consider the entire web service code as an egg. The eggshell represents the web service framework code, while both the albumen and yolk represent the business logic code. The yolk is the core of the business logic (manually written code). It includes defining MySQL tables, defining API interfaces, and writing specific logic code.On the other hand, the albumen acts as a bridge connecting the core business logic code to the web framework code (automatically generated, no manual writing needed). This includes the registration of route code generated from proto files, handler method function code, parameter validation code, error codes, Swagger documentation, and more.

Egg model profiling diagram for ⓷Web services created based on protobuf:

This is the egg model for web service code, and there are egg models for microservice (grpc) code, and grpc gateway service code described in sponge documentation.

Key Features

User-friendly UI for code generation commands.
Automatic merging of template code for "low-code development" of API interfaces.
Modular and decoupled code design with rich functional components readily available, you can also easily use their own components.
Web framework gin
RPC framework grpc
Configuration parsing viper
Configuration center nacos
Logging component zap
Database ORM component gorm
Cache component go-redis, ristretto
Automated API documentation swagger, protoc-gen-openapiv2
Authentication jwt
Message Queue rabbitmq
Distributed Transaction Manager dtm
Parameter validation validator
Adaptive rate limiting ratelimit
Adaptive circuit breaking circuitbreaker
Distributed Tracing opentelemetry
Metrics monitoring prometheus, grafana
Service registration and discovery etcd, consul, nacos
Adaptive collecting profile
Resource statistics gopsutil
Code quality checking golangci-lint
Continuous integration and deployment jenkins, docker, kubernetes

Project Code Directory Structure

The project code directory structure created by sponge follows the project-layout convention and is structured as follows:

.
├── api            # Directory for exposing external API interfaces, typically containing proto files and generated *.pb.go files. The directory structure is typically in the form `api/xxx/v1`, where v1 indicates the version.
├── assets         # Store various static resources, such as images, markdown files, etc.
├── cmd            # Program entry directory
│    └── serviceName
│         ├── initial     # Program initialization, consisting of three files: initApp initializes configurations, registerServers registers services (HTTP or grpc), and registerClose registers resource cleanup.
│         └── main.go     # Program entry file
├── configs        # Directory for configuration files
├── deployments    # Directory for deployment scripts, supporting binary, Docker, and Kubernetes deployments.
├─ docs            # Directory for API interface Swagger documentation.
├── internal       # Directory for code of private applications and libraries.
│    ├── cache        # Cache directory wrapped around business logic.
│    ├── config       # Directory for Go structure configuration files.
│    ├── dao          # Data access directory, e.g., interfaces for CRUD operations on MySQL tables.
│    ├── ecode        # Directory for system error codes and custom business error codes.
│    ├── handler      # Directory for implementing HTTP business functionality (specific to web services).
│    ├── model        # Database model directory.
│    ├── routers      # HTTP routing directory.
│    ├── rpcclient    # Directory for client-side code that connects to grpc services.
│    ├── server       # Directory for creating services, including HTTP and grpc.
│    ├── service      # Directory for implementing grpc business functionality (specific to microservices).
│    └── types        # Directory for defining request and response parameter structures for HTTP.
├── pkg            # Directory for shared libraries.
├── scripts        # Directory for scripts, including compilation, execution, code generation, and deployment scripts.
├── test           # Directory for scripts required for testing services, such as scripts to start dependencies (e.g., MySQL, Redis) and test data (SQL).
└── third_party    # Directory for external helper programs, forked code, and other third-party tools.

Quick start

Installation sponge

sponge can be installed on Windows, macOS, Linux and Docker environments. Click here for instructions on installing sponge.

Starting UI service

After installing the sponge, start the UI service:

sponge run

Access http://localhost:24631 in a local browser and manipulate the generated code on the UI page.

If you want to access it on a cross-host browser, you need to specify the host ip or domain name when starting the UI, example sponge run -a http://your_host_ip:24631. It is also possible to start the UI service on docker to support cross-host access, Click for instructions on starting the sponge UI service in docker.

Sponge Development Documentation

Detailed instructions for operating, configuring, and deploying a project using sponge development, Click here to view the sponge development documentation

Examples of use

Simple examples

No specific business logic code is included.

Complete project examples

Distributed transaction examples

9_order-system

License

See the LICENSE file for licensing information.

How to contribute

You are more than welcome to join us, raise an Issue or Pull Request.

Pull Request instructions.

Fork the code
Create your own branch: git checkout -b feat/xxxx
Commit your changes: git commit -am 'feat: add xxxxx'
Push your branch: git push origin feat/xxxx
Commit your pull request

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

License

zhufuyi/sponge

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 28

Packages 0

Contributors 3

Languages

Packages