321 Star 1.5K Fork 632

GVPdromara / soul

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Notice: Creating folder will generate an empty file .keep, because not support in Git

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


English | 简体中文

gitee stars github forks github stars github contributors


Mind maps


  • 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


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


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.


  • JDK 1.8+


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.

Document & Website

EN doc CN doc

Stargazers over time

Stargazers over time

Known Users

In order of registration, More access companies are welcome to register at https://github.com/Dromara/soul/issues/68 (For open source users only)

yy mihoyo kk group shansong
sibu group guojiadianwang caibeike jiangsuyonggang
fangfutong lixiang kaipuyun songda
aoyou cheyipai caomao zuyun
hezhi qidianyun wanwei wuyiyuntong
haokangzaijia caissa deepBule anka
jd minglamp webuy cass
songguo lianlian dasouche weimai


WeChat QQ Taro Source JetBrains
WeChat QQ group yuNai Jetbrains

Comments ( 134 )

Sign in for post a comment


JAVA语言中高性能,可插拔,响应式API网关 spread retract

Releases (1)


Gitee Metrics




load more
can not load any more


101046 36f486cf 1899542 101055 4cb66026 1899542