ShenYu is High-Performance Java API Gateway.

Clone this repo:
  1. b9458df refactor remove redundant code (#1854) by hoobiee · 6 hours ago master
  2. 01a891b [ISSUE#1852] remove MapStruct package dependency.(#1852) (#1853) by YuI · 7 hours ago
  3. 1eb8d09 [ISSUE #1844] Optimze code about dubbo async call (#1845) by Kevin Clair · 29 hours ago
  4. a4471c9 [ISSUE #1824] Improve test coverage of org.apache.shenyu.admin.service.* (#1846) by Kunshuai Zhu · 29 hours ago
  5. 38b63d2 #1824 Add test for org.apache.shenyu.common.exception.* (#1848) by lahmxu · 2 days ago

Architecture


Mind maps


Modules

  • shenyu-admin : plugins and other configuration information management background

  • shenyu-bootstrap : with the startup project, users can refer to

  • shenyu-client : user fast access with Spring MVC, Dubbo, Spring Cloud.

  • shenyu-common : framework common class

  • shenyu-disruptor : based on disruptor Enclosure

  • shenyu-register-center : rpc type register for shenyu-client

  • shenyu-dist : build project

  • shenyu-metrics : metrics impl by prometheus.

  • shenyu-plugin : ShenYu provider plugin collection.

  • shenyu-spi : ShenYu spi define.

  • shenyu-spring-boot-starter : support for the spring boot starter

  • shenyu-sync-data-center : provider ZooKeeper, HTTP, WebSocket, Nacos to sync data

  • shenyu-examples : the RPC examples project

  • shenyu-web : core processing packages including plugins, request routing and forwarding, and so on


Features

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


Plugin

Whenever a request comes in, ShenYu will execute it by all enabled plugins through the chain of responsibility.

As the heart of ShenYu, 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, ShenYu wiil dynamically updates its cache by listening to the ZooKeeper node, WebSocket push, HTTP longPull.


Prerequisite

  • JDK 1.8+

About

ShenYu 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, ShenYu 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/apache/incubator-shenyu/issues/68 (For open source users only)

All Users : Known Users