猿创征文｜Apache ShenYu网关插件介绍

雨点打透心脏的1/2处 2024-04-08 13:25 67阅读 0赞

> 相关文章：
> 
> 1.  [Apache ShenYu网关初体验][Apache ShenYu]

#### 文章目录 ####

*  前言
 *  插件
 *   *  Http Process
     *   *  ContextPath插件
         *  ModifyResponse插件
         *  ParamMapping插件
         *  Redirect插件
         *  Request插件
         *  Rewrite插件
     *  Proxy
     *   *  Divide插件
         *  Dubbo插件
         *  gRPC插件
         *  Motan插件
         *  Mqtt插件
         *  Sofa插件
         *  Spring Cloud插件
         *  Tars插件
         *  Websocket插件
     *  熔断限流
     *   *  Hystrix插件
         *  RateLimiter插件
         *  Resilience4j插件
         *  Sentinel插件
     *  权限认证
     *   *  CryptorRequest插件
         *  CryptorResponse插件
         *  JWT插件
         *  OAuth2插件
         *  Sign插件
         *  Waf插件
     *  可观测性
     *   *  Logging插件
         *  Logging-RocketMQ插件
         *  Metrics插件
     *  通用组件
     *   *  GeneralContext插件
     *  Cache
     *   *  缓存插件

## 前言 ##

在上节我们把Apache ShenYu网关集成到了微服务中，并简单使用了一下。网关的主要作用是进行流量控制和请求分发，而Apache ShenYu网关的流量控制是通过插件、选择器和规则来完成的，因此这节我们一起来学习下ShenYu网关的众多插件。

## 插件 ##

### Http Process ###

#### ContextPath插件 ####

**插件名称：**  
上下文插件  
**适用场景：**  
不同的服务可以通过设置不同的上下文路径来做服务的流量治理  
**插件功能：**

*  设置服务的上下文路径
 *  在接口调用的时候插件统一给服务的接口地址加上前缀

**插件使用：**  
![image.png][]

> 使用详见官方文档：插件合集-> Http Process-> [Context Path 插件][Context Path]

#### ModifyResponse插件 ####

**插件名称：**  
响应修改插件  
**适用场景：**  
用来对响应进行修改  
**插件功能：**  
用来对响应进行修改  
**插件使用：**  
![image.png][image.png 1]

> 使用详见官方文档：插件合集-> Http Process-> [ModifyResponse插件][ModifyResponse]

#### ParamMapping插件 ####

**插件名称：**  
请求参数修改插件  
**插件功能：**  
用来对请求参数进行修改  
**插件使用：**  
![image.png][image.png 2]

> 使用详见官方文档：插件合集-> Http Process-> [ModifyResponse插件][ModifyResponse 1]

#### Redirect插件 ####

**插件名称：**  
重定向插件  
**插件功能：**  
网关在对目标服务进行代理调用的时候，允许用户使用`redirect`插件来重定向请求  
**插件使用：**  
![image.png][image.png 3]

> 使用详见官方文档：插件合集-> Http Process-> [Redirect插件][Redirect]

#### Request插件 ####

**插件功能：**  
允许用户使用`request`插件对请求参数、请求头以及`Cookie`来添加、修改、移除请求头  
**插件使用：**  
![image.png][image.png 4]

> 使用详见官方文档：插件合集-> Http Process-> [Request插件][Request]

#### Rewrite插件 ####

**插件功能：**  
允许用户使用`rewrite`重写请求路径  
**插件使用：**  
![image.png][image.png 5]

> 使用详见官方文档：插件合集-> Http Process-> [Rewrite插件][Rewrite]

### Proxy ###

#### Divide插件 ####

**插件功能：**  
处理http协议请求；支持流量治理，如A/B测试、灰度测试；服务负载均衡；接口超时时间设置  
**插件使用：**  
![image.png][image.png 6]  
![image.png][image.png 7]

> 使用详见官方文档：插件合集-> Proxy-> [Rewrite插件][Rewrite]

#### Dubbo插件 ####

**插件功能：**  
顾名思义，用来处理apache dubbo和alibaba dubbo协议  
**插件使用：**  
![image.png][image.png 8]

> 使用详见官方文档：插件合集-> Proxy-> [Dubbo插件][Dubbo]

#### gRPC插件 ####

**插件功能：**  
顾名思义，用来gRPC协议请求的插件  
**插件使用：**  
![image.png][image.png 9]

> 使用详见官方文档：插件合集-> Proxy-> [gRPC插件][gRPC]

#### Motan插件 ####

**插件功能：**  
处理motan协议的插件  
**插件使用：**  
![image.png][image.png 10]

> 使用详见官方文档：插件合集-> Proxy-> [Motan插件][Motan]

#### Mqtt插件 ####

**插件功能：**  
处理mqtt协议的插件  
**插件使用：**

*  当前 MQTT 协议实现为 3.1 版本，实现的标识值为 connect、publish、subscribe、unsubscribe、disconnect，以及 QoS 0。
 *  缺少 retain、Qos（1，2） 实现，以及集群模式。

> 使用详见官方文档：插件合集-> Proxy-> [Mqtt插件][Mqtt]

#### Sofa插件 ####

**插件功能：**  
处理sofa协议的插件  
**插件使用：**  
![image.png][image.png 11]

> 使用详见官方文档：插件合集-> Proxy-> [Sofa插件][Sofa]

#### Spring Cloud插件 ####

**插件功能：**  
处理Spring Cloud 框架的http协议；灰度流量控制  
**插件使用：**  
![image.png][image.png 12]

> 使用详见官方文档：插件合集-> Proxy-> [Spring Cloud插件][Spring Cloud]

#### Tars插件 ####

**插件功能：**  
处理tars协议的插件  
**插件使用：**  
![image.png][image.png 13]

> 使用详见官方文档：插件合集-> Proxy-> [Tars插件][Tars]

#### Websocket插件 ####

**插件功能：**  
处理websocket协议的插件  
**插件使用：**  
![image.png][image.png 14]

> 使用详见官方文档：插件合集-> Proxy-> [Websocket插件][Websocket]

### 熔断限流 ###

#### Hystrix插件 ####

**插件功能：**

*  熔断流量
 *  保护网关代理的服务
 *  隔离模式支持 thread 和 semaphore

**插件使用：**  
![image.png][image.png 15]

> 使用详见官方文档：插件合集-> 熔断限流-> [Hystrix插件][Hystrix]

#### RateLimiter插件 ####

**插件功能：**  
基于redis进行流量控制  
**插件使用：**  
![image.png][image.png 16]

> 使用详见官方文档：插件合集-> 熔断限流-> [RateLimiter插件][RateLimiter]

#### Resilience4j插件 ####

**插件功能：**  
使用Resilience4j为网关提供限流与熔断  
**插件使用：**  
![image.png][image.png 17]

> 使用详见官方文档：插件合集-> 熔断限流-> [Resilience4j插件][Resilience4j]

#### Sentinel插件 ####

**插件功能：**  
使用sentinel为网关提供限流与熔断  
**插件使用：**  
![image.png][image.png 18]

> 使用详见官方文档：插件合集-> 熔断限流-> [Sentinel插件][Sentinel]

### 权限认证 ###

#### CryptorRequest插件 ####

**插件功能：**  
cryptorRequest 插件通过 fieldNames 去匹配 requestBody 里面的参数进行 解密 处理，替换当前 requestBody 内容  
**插件使用：**  
![image.png][image.png 19]

> 使用详见官方文档：插件合集-> 权限认证-> [CryptorRequest插件][CryptorRequest]

#### CryptorResponse插件 ####

**插件功能：**  
CryptorResponse 插件通过 fieldNames 去匹配 responseBody 里面的参数进行 加密 处理，替换当前 fieldNames 对应内容  
**插件使用：**  
![image.png][image.png 20]

> 使用详见官方文档：插件合集-> 权限认证-> [CryptorResponse插件][CryptorResponse]

#### JWT插件 ####

**插件功能：**  
提供网关统一鉴权，兼容 OAuth2.0  
**插件使用：**  
![image.png][image.png 21]

> 使用详见官方文档：插件合集-> 权限认证-> [JWT插件][JWT]

#### OAuth2插件 ####

**插件功能：**  
OAuth2 插件使用 Webflux OAuth2 实现，用于支持 OAuth 协议  
**插件使用：**  
![image.png][image.png 22]

> 使用详见官方文档：插件合集-> 权限认证-> [OAuth2插件][OAuth2]

#### Sign插件 ####

**插件功能：**  
用来对请求进行签名认证  
**插件使用：**  
![image.png][image.png 23]  
![image.png][image.png 24]

> 使用详见官方文档：插件合集-> 权限认证-> [Sign插件][Sign]

#### Waf插件 ####

**插件功能：**  
Waf 插件，是网关的用来对流量实现防火墙功能的核心实现  
**插件使用：**  
![image.png][image.png 25]

> 使用详见官方文档：插件合集-> 权限认证-> [Waf插件][Waf]

### 可观测性 ###

#### Logging插件 ####

**插件功能：**  
请求日志记录插件，通过logback或者log4j收集请求的url，请求头，请求体，响应信息和响应体，并将请求信息存储在本地。  
**适用场景：**  
开发时调试或者线上排查问题等情况下，需要在网关侧查看本次请求在转发过程中的相关信息，如请求头、请求参数或响应头、响应体等。  
**插件使用：**  
![image.png][image.png 26]

> 使用详见官方文档：插件合集-> 可观测性-> [Logging插件][Logging]

#### Logging-RocketMQ插件 ####

**插件功能：**  
Apache ShenYu 网关接收客户端请求，向服务端转发请求，并将服务端结果返回给客户端.网关可以记录下每次请求对应的详细信息。比如： 请求时间、请求参数、请求路径、响应结果、响应状态码、耗时、上游IP、异常信息等待。Logging-RocketMQ插件便是记录访问日志并将访问日志发送到RocketMQ集群的插件。  
**插件使用：**  
![image.png][image.png 27]  
![image.png][image.png 28]

> 使用详见官方文档：插件合集-> 可观测性-> [Logging-RocketMQ插件][Logging-RocketMQ]

#### Metrics插件 ####

**插件功能：**  
Metrics插件插件是网关用来监控自身运行状态（JVM相关），请求的响应迟延，QPS、TPS等相关metrics。  
**插件使用：**  
![image.png][image.png 29]  
![image.png][image.png 30]

> 使用详见官方文档：插件合集-> 可观测性-> [Metrics插件][Metrics]

### 通用组件 ###

#### GeneralContext插件 ####

**插件功能：**  
Apache ShenYu 网关在对目标服务调用的时候，还容许用户使用 generalContext 插件在本次请求中通过读取header，进行服务上下文参数传递。  
**插件使用：**  
![image.png][image.png 31]

> 使用详见官方文档：插件合集-> 通用组件-> [GeneralContext插件][GeneralContext]

### Cache ###

#### 缓存插件 ####

**插件功能：**  
Cache插件能够缓存目标服务的结果，允许用户配置缓存结果的失效时间。  
**适用场景：**

*  数据不会频繁更新，而且需要大量调用的场景。
 *  对于数据一致性要求不高的场景。

**插件使用：**  
![image.png][image.png 32]  
![image.png][image.png 33]

> 使用详见官方文档：插件合集-> Cache-> [缓存插件][Link 1]

[Apache ShenYu]: https://itsaysay.blog.csdn.net/article/details/126535531?spm=1001.2014.3001.5502
[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/eb6fd3b6fbcd40dd8f3a0fbedb85ae4a.png
[Context Path]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/contextpath-plugin
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d441b85307b1442086313f176c2af0fd.png
[ModifyResponse]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/modifyresponse-plugin
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/994dccdb335b409ea7eab6579767143b.png
[ModifyResponse 1]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/parammapping-plugin
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0bc7d66308294348a148eda4ca97047d.png
[Redirect]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/redirect-plugin
[image.png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/5409a1847cf745d2987a625e02f65ed2.png
[Request]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/request-plugin
[image.png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6b8b21d2533f4c909a07a7143ea509dd.png
[Rewrite]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/http-process/rewrite-plugin
[image.png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/02613c9f8dfe4f80b175921e4ce16a3f.png
[image.png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a9c4e0e8782149ab93b405705bdabde3.png
[image.png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/b1b18ce218ea4805befcf3a6355b22a8.png
[Dubbo]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/dubbo-plugin
[image.png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4ff8720b45a54b55937427683eadd898.png
[gRPC]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/grpc-plugin
[image.png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/5126c814c72946a4b31c0bba6080abbf.png
[Motan]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/motan-plugin
[Mqtt]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/mqtt-plugin
[image.png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/692d1dcee6d549b9ad204862326b10be.png
[Sofa]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/sofa-plugin
[image.png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/478814c6231749df857f2de88ef241ba.png
[Spring Cloud]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/spring-cloud-plugin
[image.png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4078ceb6a9a64abcbea0ae31327a1074.png
[Tars]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/tars-plugin
[image.png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/76f2a36133414f619c83a0e619e93e78.png
[Websocket]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/proxy/websocket-plugin
[image.png 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7e634422152e49f4817e83acc7094519.png
[Hystrix]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/fault-tolerance/hystrix-plugin
[image.png 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e383438706b14447bf0af7445ed44525.png
[RateLimiter]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/fault-tolerance/rate-limiter-plugin
[image.png 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/adeeaaf050514115948994aa093a0078.png
[Resilience4j]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/fault-tolerance/resilience4j-plugin
[image.png 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/93ea5208c94a42fe888ef4c5b33ad484.png
[Sentinel]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/fault-tolerance/sentinel-plugin
[image.png 19]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/14d55d3e11ec462884076d9d30d87f30.png
[CryptorRequest]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/cryptor-request-plugin
[image.png 20]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/3d3b2439549248ec8ada60e7572cf44c.png
[CryptorResponse]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/cryptor-response-plugin
[image.png 21]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4f5d0f30acf74cd2aa5c518b6e6c6064.png
[JWT]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/jwt-plugin
[image.png 22]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d40276b31d254f1db069e39308f2e0bb.png
[OAuth2]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/oauth2-plugin
[image.png 23]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/76946acb07164e659324b0484eadfd12.png
[image.png 24]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ebee57c18b10417088d0c8bf3e1e9e40.png
[Sign]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/sign-plugin
[image.png 25]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7b31319fa7334223bc413146bc1519b1.png
[Waf]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/authority-and-certification/waf-plugin
[image.png 26]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/64691971e9764d9180bd8e67c9c5f70e.png
[Logging]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/observability/logging-plugin
[image.png 27]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1393bac04d3640a3a3a7301030e89cdf.png
[image.png 28]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4339cc4c1f5d4582b3d53585302e623d.png
[Logging-RocketMQ]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/observability/logging-rocketmq
[image.png 29]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/3c72e21738ba4e608a12f46f338f6b3e.png
[image.png 30]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6b9dbb70c3b941b9ab41c9669746e15b.png
[Metrics]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/observability/metrics-plugin
[image.png 31]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/5250b7002df941b5b99d8911a5a4fcde.png
[GeneralContext]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/common/general-context-plugin
[image.png 32]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e080bbc3030d4deda4f4e00379b6715c.png
[image.png 33]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a03766b45174492b9ec05f11f902e782.png
[Link 1]: https://shenyu.apache.org/zh/docs/2.4.3/plugin-center/cache/cache-plugin