/soul

High-Performance Java API Gateway

Primary LanguageJavaApache License 2.0Apache-2.0

Scalable,High Performance,Responsive API Gateways

https://dromara.org/

English | 简体中文

gitee stars github forks github stars github contributors



Architecture


Execution Flow


Modules

  • soul-admin : plugins and other information configuration 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-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 plugins such as current limiting, fusing, forwarding, routing monitoring and so on.

  • Seamless docking with HTTP, RESTful, WebSocket, Dubbo and Spring Cloud.

  • 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 executes all open 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 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 have been cached using 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.


Prerequisite

  • JDK 1.8+

  • MySQL


About

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

EN doc CN doc


Stargazers over time

Stargazers over time


Videos


Known Users

In order of registration, More access companies are welcome to register at apache#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

Support

WeChat QQ Taro Source
微信公众号 QQ 交流群 芋道源码