Watch 209 Star 710 Fork 270

GVPdromara / soulJavaApache-2.0

Join us
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
异步的,高性能的,跨语言的,反应式的API网关。我们希望能够有一样东西像灵魂一样,保护您的微服务 spread retract

  • Java 98.9%
  • Shell 0.6%
  • Lua 0.3%
  • HTML 0.1%
  • Dockerfile 0.1%
Clone or download
Notice: Creating folder will generate an empty file .keep, because not support in Git


Codacy Badge Total lines License Build Status Maven Central QQ群

Reactive gateway based on webflux


Execution Flow


  • soul-admin : Plug-in and other information configuration management background

  • soul-bootstrap : With the startup project, users can refer to

  • soul-common : Framework common class

  • soul-configuration : zookeeper configuration project

  • soul-spring-boot-starter : Support for the spring boot starter

  • soul-web : Core processing packages include plug-ins, request routing and forwarding, and so on

  • soul-extend-demo : Demo of the extension point

  • soul-test : the rpc test project


  • It provides plugins such as current limiting, fusing, forwarding, routing monitoring and so on.

  • Seamless docking with HTTP,Restful,websocket,dubbo and springcloud.

  • 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。


Whenever a request comes in ,Soul Execute all open plug-ins through the chain of responsibility.

Plugins are the heart of soul And plug-ins are extensible and hot-pluggable.

Different plug-ins do different things

Of course, users can also customize plug-ins to meet their own needs.

If you want to customize, see plugin-extend

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

All data is cached ConcurrentHashMap in the JVM So it's very fast.

When the user is managing changes in the background,

Soul dynamically updates the cache by listening to the zookeeper node, websocket push,http longPull.

Data Sync

Sync Flow

Quick Start

  • get soul-admin.jar
> wget
  • start soul-admin.jar
java -jar soul-admin.jar -Dspring.datasource.url="your mysql url"  
-Dspring.datasource.username='you username'  -Dspring.datasource.password='you password'
> wget
  • start soul-bootstrap.jar
 java -jar soul-bootstrap.jar


  • JDK 1.8+

  • Mysql

About & Document

Soul Has been used in our production environment,Its performance and flexibility allow us to use up very cool.

In double 11, we deployed 6 clusters, which supported a large volume of our business.

If you want to use it, you can see Document

Stargazers over time

Stargazers over time



芋道源码 JetBrains

Comments ( 59 )

Sign in for post a comment


Help Search