65 files changed
tree: 2dd77876e8fef5a46eeffb9ce2a9c66a67a643fc
  1. doc/
  2. script/
  3. soul-admin/
  4. soul-bootstrap/
  5. soul-client/
  6. soul-common/
  7. soul-metrics/
  8. soul-plugin/
  9. soul-spi/
  10. soul-spring-boot-starter/
  11. soul-sync-data-center/
  12. soul-test/
  13. soul-web/
  14. .gitignore
  15. .travis.yml
  17. pom.xml
  18. README.md


Execution Flow


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

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

  • soul-client : User fast access with springMvc,dubbo,springCloud

  • soul-common : Framework common class

  • 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-test : the rpc test project

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


  • 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


  • JDK 1.8+

  • Mysql


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.

Document & Website

If you want to use it, you can see Website If you want to use it, you can see Document

Stargazers over time

Stargazers over time


Known Users