微服务网关实践 Spring Cloud Alibaba GateWay

阳光穿透心脏的1/2处 2023-01-08 07:25 193阅读 0赞

> 本文主要内容是:为什么要使用网关,整合Gateway,Gateway核心学习:Route,Predicate,Filter,最后使用Gateway聚合微服务请求

先总结至此的架构

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70][]

# 1 网关的价值 #

不使用网关行嘛?

*  各个请求直接打在各个微服务

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 1][]

小规模看起来还行,如果微服务很多呢?上百个呢?带来哪些问题呢

1.  认证复杂,要对每个服务中每个接口做认证处理!
2.  客户端难以重构,随着架构迭代,很可能要重新划分微服务,由于拆分是动态进行的,客户端如果直接就与微服务通信的话,重构就很实现咯,很可能重新拆分微服务后域名都变了,客户端就需要做大量的改动
3.  其他微服务使用了浏览器不友好的协议,比如Thrift协议,直接访问的话没法的呀!

要解决以上这些问题,业界普遍做法就是构建一个网关,外部请求经过网关转发再打到相应的微服务,有以下好处

1.  简化了登录认证,而不需在每个服务都认证一遍
2.  对外暴露的永远是一个域名,不管内部的微服务如何拆分,域名都不会变,客户端重构的成本大大降低

# 2 Spring Cloud Gateway简介 #

◆ 是Spring Cloud的网关(第二代) , 未来会取代Zuul(第一代)

◆ 基于Netty、 Reactor以及WebFlux构建

## 2.1 优点 ##

◆ 性能强劲

是第一代网关Zuul 1.x的1.6倍!性能PK :

*  推荐阅读

[纠错帖：Zuul & Spring Cloud Gateway & Linkerd性能对比][Zuul _ Spring Cloud Gateway _ Linkerd]

◆ 功能强大

*  内置了很多实用功能,比如转发、监控、限流等

◆ 设计优雅,易扩展

## 2.1 缺点 ##

◆ 依赖Netty与Webflux ,不是Servlet编程模型,有一定的学习成本

◆ 不能在Servlet容器下工作,也不能构建成WAR包

◆ 不支持Spring Boot 1.x,至少都得2.x版本

# 3 编写Spring Cloud Gateway #

*  新建项目并启动

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 2][]

## 3.1 转发规律 ##

*  访问$\{GATEWAY\_ URL\}/\{微服务X\}/xx 会转发到微服务X的/xx路径

# 4 核心概念 #

◆ Route(路由)

*  Spring. Cloud. Gateway的基础元素,可简单理解成一条转发的规则。

包含: ID、目标URL、Predicate集合以及 Filter集合。

◆Predicate (谓词)

*  即java.util.function.Predicate , Spring Cloud Gateway使用

Predicate实现路由的匹配条件。

◆ Filter (过滤器)

*  修改请求以及响应

## 路由配置示例 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 3][]

然而我们并未如此配置路由哦!而是如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 4][]

# 5 架构剖析 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 5][]

对应源码

*  Gateway Handler Mapping :

org.springframework.cloud.gateway.handler.RoutePredicateHandlerMapping

*  Gateway Web Handler :

org.springframework.cloud.gateway.handler.FilteringWebHandler

# 6 路由谓词工厂（Route Predicate Factories） #

## 6.1 内置 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 6][]

*  推荐阅读

[Spring Cloud Gateway-路由谓词工厂详解（Route Predicate Factories）][Spring Cloud Gateway-_Route Predicate Factories]

## 6.2 自定义路由谓词工厂 ##

*  路由规则

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 7][]

*  配置类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 8][]

*  自定义谓词工厂

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 9][]

# 7 过滤器工厂（GatewayFilter Factories） #

## 7.1 内置 ##

*  推荐阅读

[Spring Cloud Gateway-过滤器工厂详解（GatewayFilter Factories）][Spring Cloud Gateway-_GatewayFilter Factories]

*  添加配置,访问getway/\*\*会增加一个header前缀哦,zai’ch

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 10][]

*  打断点

![20191211001604708.png][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 11][]

## 7.2 自定义过滤器工厂 ##

### 7.2.1 生命周期 ###

*  pre : Gateway转发请求之前
 *  post : Gateway转发请求之后

### 7.2.2 自定义 ###

方式1

◆ 继承: AbstractGatewayFilterFactory

◆ 参考示例:

`org.springframework.cloud.gateway.filter.factory.RequestSizeGatewayFilterFactory`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 12][]

*  配置形式

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 13][]

方式2

◆ 继承 : AbstractNameValueGatewayFilterFactory

◆ 参考示例:

`org.springframework.cloud.gateway.filter.factory.AddRequestHeaderGatewayFilterFactory`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 14][]

*  配置形式

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 15][]

`这种方式其实是第一种的简化版`

### 7.2.3 核心API ###

◆ exchange.getRequest().mutate().xxx //修改request

◆ exchange.mutate().xxx //修改exchange

◆ chain.filter(exchange) //传递给下一个过滤器处理

◆ exchange.getResponse() //拿到响应

### 7.2.4 实现一个过滤器工厂 ###

记录日志功能

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 16][]

*  配置文件,两个参数

![20191211003742372.png][]

## 7.3 全局过滤器 ##

有执行顺序哦!

*  推荐阅读

[Spring Cloud Gateway-全局过滤器（Global Filters）][Spring Cloud Gateway-_Global Filters]

悬念：如何为Spring Cloud Gateway整合Sentinel？

Sentinel在V1.6+才支持gateway!

## 7.4 过滤器执行顺序 ##

*  Order越小越靠前执行
 *  过滤器工厂的Order按配置顺序从1开始递增

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 17][]

*  如果配置了默认过滤器,则先执行相同Order的默认过滤器

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 18][]

## 核心代码 ##

*  org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator\#loadGatewayFilters :为过滤器设置了Order数值,从1开始

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 19][]

*  org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator\#getFilters :加载默认过滤器&路由过滤器,并对过滤器做了排序

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 20][]

*  org.springframework.cloud.gateway.handler. FilteringWebHandler\#handle :构建过滤器链并执行

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 21][]

# 8 监控Spring Cloud Gateway #

*  推荐阅读

[Spring Cloud Gateway监控][Spring Cloud Gateway]

# 9 排错、调试技巧 #

*  推荐阅读

[Spring Cloud Gateway排错、调试技巧总结][Spring Cloud Gateway 1]

# 10 限流 #

*  推荐阅读

[Spring Cloud Gateway限流详解][Spring Cloud Gateway 2]

# 11 总结 #

◆ 路由、路由谓词工厂、过滤器工厂、全局过滤器…

◆ 网关集大成

● 注册到Nacos

● 集成Ribbon

● 容错(默认Hystrix ,也可用Sentinel )

# 参考 #

*  [GateWay官方文档][GateWay]
 *  [面向未来微服务:Spring Cloud Alibaba从入门到进阶][Spring Cloud Alibaba]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70]: /images/20221119/4efe8d58a3014a78b1f61bf2c864d1b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 1]: /images/20221119/e0a0cefd9f234e78ac862971f745a2b7.png
[Zuul _ Spring Cloud Gateway _ Linkerd]: https://www.imooc.com/article/285068
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 2]: /images/20221119/688871b8ceaf4b09a7f7c2451bcaf2ca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 3]: /images/20221119/8fe1a41da2aa4887a6e30db8c87516d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 4]: /images/20221119/062384691716451d9edb648d91d25227.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 5]: /images/20221119/46a4589fa4c94bfd99f3953aec5c4644.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 6]: /images/20221119/dc68748ce66c49138e051c275bc3fd9e.png
[Spring Cloud Gateway-_Route Predicate Factories]: https://www.imooc.com/article/290804
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 7]: /images/20221119/7c2703753ebb4573901e0bd9e73dc8b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 8]: /images/20221119/507547756e3740648cbfc3f3454507b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 9]: /images/20221119/8a0fb63839b44acda677dcfc57c74544.png
[Spring Cloud Gateway-_GatewayFilter Factories]: https://www.imooc.com/article/290816
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 10]: /images/20221119/a5daf94a345044f2a2591232d1e7caba.png
[20191211001604708.png]: https://img-blog.csdnimg.cn/20191211001604708.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 11]: /images/20221119/0d5688507b71461984647c5670248fe7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 12]: /images/20221119/d544c934908f4925878fa75377c03d30.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 13]: /images/20221119/969aafdbe1ab458a9097a5fc0155ce4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 14]: /images/20221119/eaa856981fc942b6a2d7ee24b299869e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 15]: /images/20221119/3cb05ecc28cf4f2d88c8068864107521.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 16]: /images/20221119/a5d44fb274fa466eb7f30ca03b02b4b5.png
[20191211003742372.png]: /images/20221119/bc0b5ea934194df69a8db2243b2c1bf1.png
[Spring Cloud Gateway-_Global Filters]: https://www.imooc.com/article/290821
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 17]: /images/20221119/733b485a74044c338959b9c5f2873e5b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 18]: /images/20221119/d13832c64abe47809de8c0b2c15d9de9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 19]: /images/20221119/ef36f1eceafd44f6b6b5b4b2f5c69e7e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 20]: /images/20221119/745f6f3cfa044627ae71493dd2c293b5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYXZhZWRnZS5ibG9nLmNzZG4ubmV0_size_1_color_FFFFFF_t_70 21]: /images/20221119/9756e7cb2f4644b8a8db245e9f353ab4.png
[Spring Cloud Gateway]: https://www.imooc.com/article/290822
[Spring Cloud Gateway 1]: https://www.imooc.com/article/290824
[Spring Cloud Gateway 2]: https://www.imooc.com/article/290828
[GateWay]: https://cloud.spring.io/spring-cloud-static/Greenwich.SR1/single/spring-cloud.html#gateway-how-it-works
[Spring Cloud Alibaba]: https://coding.imooc.com/class/358.html?mc_marking=1f1eb391b59b3e4139718a46d8673049&mc_channel=syb10