Scalable, High Performance, Responsive API Gateway Solution for all MicroSerivces

English | 简体中文

Architecture

Mind maps

Modules

soul-admin : plugins and other configuration information management background
soul-bootstrap : with the startup project, users can refer to
soul-client : user fast access with Spring MVC, Dubbo, Spring Cloud.
soul-common : framework common class
soul-disruptor : based on disruptor Enclosure
soul-register-center : rpc type register for soul-client
soul-dist : build project
soul-metrics : metrics impl by prometheus.
soul-plugin : Soul provider plugin collection.
soul-spi : Soul spi define.
soul-spring-boot-starter : support for the spring boot starter
soul-sync-data-center : provider ZooKeeper, HTTP, WebSocket, Nacos to sync data
soul-examples : the RPC examples project
soul-web : core processing packages including plugins, request routing and forwarding, and so on

Features

Soul provides ability such as current limiting, fusing, forwarding, routing monitoring and so on by its plugins.
Support HTTP, RESTFul, WebSocket, Dubbo, GRPC, Tars and Spring Cloud Proxy.
Plug-in hot plug, users can customize the development.
Selectors and rules are dynamically configured for flexible matching.
Support for cluster deployment.
Support A/B test and grayscale publishing.

Plugin

Whenever a request comes in, Soul will execute it by all enabled plugins through the chain of responsibility.

As the heart of Soul, plugins are extensible and hot-pluggable.

Different plugins do different things.

Of course, users can also customize plugins to meet their own needs.

If you want to customize, see custom-plugin

Selector & rule

According to your HTTP request headers, selectors and rules are used to route your requests.

Selector is your first route, It is coarser grained, for example, at the module level.

Rule is your second route and what do you think your request should do. For example a method level in a module.

The selector and the rule match only once, and the match is returned. So the coarsest granularity should be sorted last.

Data Caching & Data Sync

Since all data have been cached using ConcurrentHashMap in the JVM, it's very fast.

When user have changed the configuration in the background management, Soul wiil dynamically updates its cache by listening to the ZooKeeper node, WebSocket push, HTTP longPull.

Prerequisite

JDK 1.8+

About

Soul has been used widely in more and more systems in many companies, and it's simple and convenient to integrate Services/APIs with the high performance and flexibility.

In double eleven online shopping carnival of China, Soul clusters successfully supported a large volume of internet business.