codefans / incubator-shenyu Goto Github PK

View Code? Open in Web Editor NEW

This project forked from apache/shenyu

ShenYu is High-Performance Java API Gateway.

License: Apache License 2.0

Java 93.29% Lua 0.14% Shell 0.21% HTML 0.03% Dockerfile 0.15% Batchfile 0.06% PLpgSQL 6.13%

incubator-shenyu's Introduction

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

https://shenyu.apache.org/

English | 简体中文

Architecture

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