【Spring Cloud】 Gateway 网关配置说明与网关接入
Spring Cloud Gateway 为 SpringBoot 应用提供了 API 网关支持,具有强大的智能路由与过滤器功能。
Gateway 简介
Gateway 是在 Spring 生态系统之上构建的 API 网关服务,基于 Spring 5,Spring Boot 2 和 Project Reactor 等技术。
Gateway 旨在提供一种简单而有效的方式来对 API 进行路由,以及提供一些强大的过滤器功能, 例如:熔断、限流、重试等。
Spring Cloud Gateway 具有如下特性:
- 基于Spring Framework 5, Project Reactor 和 Spring Boot 2.0 进行构建;
- 动态路由:能够匹配任何请求属性;
- 可以对路由指定 Predicate(断言)和 Filter(过滤器);
- 集成 Hystrix 的断路器功能;
- 集成 Spring Cloud 服务发现功能;
- 易于编写的 Predicate(断言)和 Filter(过滤器);
- 请求限流功能;
- 支持路径重写。
相关概念
- Route(路由):路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由;
- Predicate(断言):指的是Java 8 的 Function Predicate。 输入类型是Spring框架中的ServerWebExchange。 这使开发人员可以匹配HTTP请求中的所有内容,例如请求头或请求参数。如果请求与断言相匹配,则进行路由;
- Filter(过滤器):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前后对请求进行修改。
两种不同的配置路由方式
Gateway 提供了两种不同的方式用于配置路由,一种是通过 yml 文件来配置,另一种是通过 Java Bean 来配置,下面我们分别介绍下。
使用yml配置
在application.yml中进行配置:
- 启动eureka-server,user-service和api-gateway服务,并调用该地址测试:http://localhost:9201/user/1
- 我们发现该请求被路由到了user-service的该路径上:http://localhost:8201/user/1
使用Java Bean配置
添加相关配置类,并配置一个RouteLocator对象:
- 重新启动api-gateway服务,并调用该地址测试:http://localhost:9201/user/getByUsername?username=macro
- 我们发现该请求被路由到了user-service的该路径上:http://localhost:8201/user/getByUsername?username=macro
Route Predicate 的使用
Spring Cloud Gateway 包括许多内置的 Route Predicate 。 所有这些 Predicate 都与 HTTP 请求的不同属性匹配。 多个 Route Predicate 可以进行组合,下面我们来介绍下一些常用的Route Predicate。
本文都是在 application-predicate.yml 文件中进行 Predicate 配置,并用该配置启动 api-gateway 服务。
After Route Predicate
在指定时间之后的请求会匹配该路由。
Before Route Predicate
在指定时间之前的请求会匹配该路由。
Between Route Predicate
在指定时间区间内的请求会匹配该路由。
Cookie Route Predicate
带有指定Cookie的请求会匹配该路由。
使用 curl 工具发送带有 cookie 为 username=macro 的请求可以匹配该路由。
Header Route Predicate
带有指定请求头的请求会匹配该路由。
使用curl工具发送带有请求头为 X-Request-Id:123 的请求可以匹配该路由。
Host Route Predicate
带有指定Host的请求会匹配该路由。
使用curl工具发送带有请求头为Host:www.macrozheng.com的请求可以匹配该路由。
Method Route Predicate
发送指定方法的请求会匹配该路由。
使用curl工具发送GET请求可以匹配该路由。
使用curl工具发送POST请求无法匹配该路由。
Path Route Predicate
发送指定路径的请求会匹配该路由。
使用curl工具发送/user/1路径请求可以匹配该路由。
使用curl工具发送/abc/1路径请求无法匹配该路由。
Query Route Predicate
带指定查询参数的请求可以匹配该路由。
使用 curl 工具发送带 username=jhj 查询参数的请求可以匹配该路由。
使用curl工具发送带不带查询参数的请求无法匹配该路由。
RemoteAddr Route Predicate
从指定远程地址发起的请求可以匹配该路由。
使用curl工具从192.168.1.1发起请求可以匹配该路由。
Weight Route Predicate
使用权重来路由相应请求,以下表示有80%的请求会被路由到localhost:8201,20%会被路由到localhost:8202。
Route Filter 的使用
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用。
Spring Cloud Gateway 内置了多种路由过滤器,他们都由GatewayFilter的工厂类来产生,下面我们介绍下常用路由过滤器的用法。
AddRequestParameter GatewayFilter
给请求添加参数的过滤器。
以上配置会对GET请求添加 username=jhj 的请求参数,通过 curl 工具使用以下命令进行测试。
相当于发起该请求:
StripPrefix GatewayFilter
对指定数量的路径前缀进行去除的过滤器。
以上配置会把以 /user-service/ 开头的请求的路径去除两位,通过curl工具使用以下命令进行测试。
相当于发起该请求:
PrefixPath GatewayFilter
与StripPrefix过滤器恰好相反,会对原有路径进行增加操作的过滤器。
以上配置会对所有GET请求添加/user路径前缀,通过curl工具使用以下命令进行测试。
相当于发起该请求:
Hystrix GatewayFilter
Hystrix 过滤器允许你将断路器功能添加到网关路由中,使你的服务免受级联故障的影响,并提供服务降级处理。
要开启断路器功能,我们需要在pom.xml中添加Hystrix的相关依赖:
然后添加相关服务降级的处理类:
在application-filter.yml中添加相关配置,当路由出错时会转发到服务降级处理的控制器上:
关闭user-service,调用该地址进行测试:http://localhost:9201/user/1 ,发现已经返回了服务降级的处理信息。
RequestRateLimiter GatewayFilter
RequestRateLimiter 过滤器可以用于限流,使用 RateLimiter 实现来确定是否允许当前请求继续进行。
在pom.xml中添加相关依赖:
添加限流策略的配置类,这里有两种策略一种是根据请求参数中的 username 进行限流,另一种是根据访问 IP 进行限流;
我们使用Redis来进行限流,所以需要添加 Redis 和 RequestRateLimiter 的配置,这里对所有的 GET 请求都进行了按 IP 来限流的操作;
多次请求该地址:http://localhost:9201/user/1 ,会返回状态码为429的错误;
Retry GatewayFilter
对路由请求进行重试的过滤器,可以根据路由请求返回的HTTP状态码来确定是否进行重试。
修改配置文件:
当调用返回500时会进行重试,访问测试地址:http://localhost:9201/user/111
结合注册中心使用
Gateway 结合注册中心,一般使用默认的动态路由和过滤器。
使用动态路由
在pom.xml中添加相关依赖:
添加application.yml配置文件:
在结合注册中心使用过滤器的时候,我们需要注意的是uri的协议为lb,这样才能启用Gateway的负载均衡功能。
将 Spring Cloud Gateway 注册到服务中心之后,网关会自动代理所有的在注册中心的服务,访问这些服务的语法为:
按照上面的语法我们通过网关来访问:
这个例子中:使用 application.yml 配置文件启动 api-gateway 服务,访问 http://localhost:9201/1 ,可以路由到 user-service 的 http://localhost:8201/user/1 处。
我们将 user-service 复制一份为 user-service-1,将/user/1 服务的返回值改一下,修改端口号为 8202 ,修完完成后重启,这时候访问注册中心后台会发现有两个名为 user-service 的服务。
多次访问,返回的数据是不一样的,说明后端服务自动进行了均衡负载。
原文链接:https://piterjia.github.io/2020/06/16/spring-cloud-gateway/
版权声明:
作者:白纸画
链接:https://www.fanyicloud.cn/article-32.fan
来源:白纸画的博客
文章版权归作者所有,未经允许请勿转载。
全部评论