Skip to content

stickeeper/soul

 
 

Repository files navigation

Codacy Badge Total lines License Maven Central QQ群

Reactive gateway based on webflux

Architecture

Execution Flow

Modules

  • 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-client : User fast access, automatic new metadata, rule selector

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

  • soul-test : the rpc test project

Features

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

Plugin

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  https://yu199195.github.io/jar/soul-admin.jar
  • start soul-admin.jar
> java -jar soul-admin.jar --spring.datasource.url="jdbc:mysql://your ip:3306/soul?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=CONVERT_TO_NULL&failOverReadOnly=false&autoReconnect=true&useSSL=false"  
  --spring.datasource.username="you username"  --spring.datasource.password="you password"
> wget  https://yu199195.github.io/jar/soul-bootstrap.jar
  • start soul-bootstrap.jar
 java -jar soul-bootstrap.jar

Prerequisite

  • 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

Videos

Known Users

按照登记顺序排序,更多接入公司,欢迎在apache#68登记(仅供开源用户参考)

广州思埠集团有限公司 上海凯京信达科技集团有限公司 上海彩贝壳科技有限公司 江苏永钢集团有限公司
思埠集团 凯京集团 彩贝壳 江苏永钢集团
上海方付通科技有限公司 上海理想信息产业集团有限公司 北京开普云科技有限公司 武汉颂大教育科技股份有限公司
上海方付通科技有限公司 上海理想信息产业集团有限公司 彩贝壳 江苏永钢集团
浙江翱游科技有限公司 车易拍(北京)汽车技术服务有限公司 上海草帽科技 深圳竹云科技有限公司
浙江翱游科技有限公司 车易拍(北京)汽车技术服务有限公司 上海草帽科技 深圳竹云科技有限公司
深圳盒知科技 杭州奇点云科技 深圳万威科技 武汉物易云通网络科技有限公司
深圳盒知科技 杭州奇点云科技 万威科技 武汉物易云通网络科技有限公司

Support

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

About

High-Performance Java API Gateway

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 96.9%
  • TSQL 2.4%
  • Other 0.7%