今日目标
- 掌握Gateway服务网关
在当今的微服务架构中,一个高性能、可扩展的网关是至关重要的。而Spring Cloud Gateway作为Spring Cloud生态系统的一部分,成为许多开发者选择的首选网关解决方案。本文将为您提供一个简单易懂的Spring Cloud Gateway入门指南,帮助您快速上手并开始构建强大的微服务网关。
一.Gateway服务网关介绍
Spring Cloud Gateway,它是一个基于Spring Framework 5、Project Reactor和Spring Boot 2的非阻塞(响应式编程和事件技术流)API网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。相比传统的Zuul网关,Spring Cloud Gateway具有更高的性能和更灵活的配置选项。
为什么需要网关
在微服务架构中,系统可能由多个服务组成。网关可以作为请求的入口,根据事先配置的路由规则将请求转发到相应的服务实例。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
简单架构图:
核心功能作用:权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
二.Gateway快速入门
接下来我们演示Gateway网关基本路由功能,步骤如下:
- 1.创建微服务gateway-cloud-server,引入网关依赖
- 2.编写网关启动类
- 3.编写基础配置和路由
- 4.启动Gateway网关进行测试
【步骤一】:创建gateway-cloud-server服务,并引入依赖
在这里需要创建一个项目进行演示,和之前的项目区别不大,可是为了区分,我还是重新创建了新的项目day32-cloud-gateway,不具体演示如何创建项目,大家可以去github地址查看
在pom.xml中引入Gateway依赖
【步骤二】:编写Gateway网关启动类
【步骤三】:编写基础配置和路由
在resuorces目录下创建application.yml文件,内容如下:
我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
本案例中,我们将 /user/**开头的请求,代理到lb://user-service,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
【步骤四】:启动Gateway网关进行测试
重启网关,访问http://localhost:9999/user/1时,符合/user/**规则,请求转发到uri:http://user-service/user/1,得到了结果:
Gateway网关路由配置图
请求访问流程如下:
网关搭建步骤:
1.创建项目,引入nacos服务发现和gateway依赖
2.配置application.yml,包括服务基本信息、nacos地址、路由
路由配置:
1.路由id:路由的唯一标示
2.路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
3.路由断言(predicates):判断路由的规则,
4.路由过滤器(filters):对请求或响应做处理
三.Gateway断言工厂(PredicateFactory)
配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个:只需要掌握Path这种路由工程就可以了
可以访问Gateway官网查看每一个的具体说明
名称 | 说明 | 示例 |
After | 是某个时间点后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 是某个时间点之前的请求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 是某两个时间点之前的请求 | - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-Id, \d+ |
Host | 请求必须是访问某个host(域名) | - Host=.somehost.org,.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合指定规则 | - Path=/red/{segment},/blue/** |
Query | 请求参数必须包含指定参数 | - Query=name, Jack或者- Query=name |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 |
标头路由谓词工厂实例:
如果请求具有名为 X-Request-Id 其值与 \d+正则表达式匹配的标头(即,它的值为一个或多个数字),则此路由匹配。
四.过滤器工厂( GatewayFilter Factory)
Spring提供了31种不同的路由过滤器工厂,具体每一种过滤器的使用方式,你也可以去其官网查看,这边我们只介绍记住常用的过滤器
名称 | 说明 |
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
4.1. 请求头过滤器(AddRequestHeader)
下面我们以AddRequestHeader 为例来讲解。
需求:给所有进入user-service的请求添加一个请求头:Learn=跟着 springboot葵花宝典一起学习开发!
【步骤一】:Gateway网关添加请求头配置
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
注意:AddRequestHeader=Learn, learn springboot:
- 请求头格式: key:value
- Learn:表示请求头的key
- learn springboot:表示value 当前过滤器写在user-service路由下,因此仅仅对访问user-service的请求有效。
【步骤二】:修改user-service控制器获取请求头
【步骤三】:测试
使用浏览器访问http://localhost:9999/user/2,查看控制台
图片
思考:刚才我们展示的是user-service单个微服务的过滤器,如何可以写一个过滤器对所有的路由都生效?
默认过滤器
总结
1.过滤器的作用是什么?
对路由的请求或响应做加工处理,比如添加请求头
配置在路由下的过滤器只对当前路由的请求生效
2.defaultFilters的作用是什么?
对所有路由都生效的过滤器
5.全局过滤器
学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。那就需要全局过滤器。
5.1. 全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
5.2.实现方式
定义方式是实现GlobalFilter接口。
在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
5.3 自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求头中是否有满足下面条件:
- 请求头key是否有authorization,
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
测试
使用postman访问http://localhost:9999/user/1,并在请求头添加authorizatinotallow=admin
错误展示请求头添加authorizatinotallow=admin1
5.4. 过滤器执行顺序
请求进入网关会碰到三类过滤器:
- 当前路由的过滤器
- DefaultFilter
- GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
排序的规则是什么呢?
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链
总结
本文针对微服务中另一重要组件:网关 进行了实战性演练,网关作为分布式架构中的重要中间件,不仅承担着路由分发(重点关注Path规则配置),同时可根据自身负载均衡策略,对多个注册服务实例进行均衡调用。我们借助GateWay实现的网关只是技术实现的方案之一,后续大家可能会接触像:Zuul、Kong等,其实现细节或有差异,但整体目标是一致的。