【Hoxton.SR1版本】SpringCloudGateway网关初体验

目录

一、简介

二、Gateway三大概念

三、Spring Cloud Gateway整体流程图

四、Gateway入门配置

五、Gateway路由配置方式

六、Gateway动态路由

七、总结

一、简介

在SpringCloud旧版本中&＃xff0c;我们使用的微服务网关是Zuul网关&＃xff0c;笔者之前也做了有关Zuul网关的详解&＃xff0c;有兴趣的小伙伴可以通过下面的链接进行学习&＃xff1a;https://blog.csdn.net/Weixiaohuai/article/details/82717679。在SpringCloud新版本中&＃xff0c;新推出了Spring Cloud Gateway新一代网关&＃xff0c;它取代了Zuul&＃xff0c;所以我们有必要花一点时间去学习Gateway。

Spring Cloud Gateway官网地址为&＃xff1a;

https://spring.io/projects/spring-cloud-gateway

https://docs.spring.io/spring-cloud-gateway/docs/2.2.4.RELEASE/reference/html/

• Spring Cloud Gateway是什么&＃xff1f;

Spring Cloud全家桶中&＃xff0c;有个很重要的组件就是网关&＃xff0c;在1.x版本中都是采用的Zuul网关&＃xff0c;但是在2.x版本中&＃xff0c;zuul的升级一直跳票&＃xff0c;SpringCloud最后自己研发了一个网关替换Zuul&＃xff0c;那就是SpringCloud Gateway&＃xff0c;一句话&＃xff0c;gateway是原zuul1.x版本的替代。

SpringCloud Gateway项目提供了一个在Spring生态系统之上构建的API网关&＃xff0c;包括&＃xff1a;Spring 5&＃xff0c;Spring Boot 2和Project Reactor。Spring Cloud Gateway旨在提供一种简单而有效的方法来路由到API&＃xff0c;例如&＃xff1a;安全性&＃xff0c;监视/指标和限流。

SpringCloud Gateway作为Spring Cloud生态系统中的网关&＃xff0c;目标是替代Zuul,在Spring Cloud2.0以上版本中&＃xff0c;没有对新版本的Zuul 2.0以上最新高性能版本进行集成&＃xff0c;仍然还是使用的Zuul 1.x非Reactor模式的老版本。为了提升网关的性能&＃xff0c;SpringCloud Gateway是基于WebFlux框架实现的&＃xff0c;而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

• Gateway能干嘛&＃xff1f;

1. 反向代理
2. 鉴权
3. 熔断
4. 流量控制
5. 日志监控
6. ...........

• Gateway的特性&＃xff1f;

1. 基于Spring 5&＃xff0c;Spring Boot 2和Project Reactor进行构建&＃xff1b;
2. 动态路由&＃xff1a;能够匹配任何请求属性&＃xff1b;
3. 可以对路由指定Predicate(断言)和Filter&＃xff08;过滤器&＃xff09;&＃xff1b;
4. 集成Hystrix的断路器功能&＃xff1b;
5. 集成Spring Cloud服务发现功能&＃xff1b;
6. 易于编写的Predicate(断言)和Filter&＃xff08;过滤器&＃xff09;&＃xff1b;
7. 请求限流功能&＃xff1b;
8. 支持路径重写&＃xff1b;

• Spring Cloud Gateway和Zuul的区别&＃xff1f;

1. zuul 1.x是一个基于阻塞I/O的API Gateway&＃xff1b;
2. zuul 1.x基于Servlet 2.5使用阻塞框架&＃xff0c;它不支持任何长连接(如WebSocket)&＃xff0c;Zuul的设计模式和Nginx较像&＃xff0c;每次I/O操作都是从工作线程中选择一个执行&＃xff0c;请求线程被阻塞到工作线程完成&＃xff0c;但是差别就是Nginx用C&＃43;&＃43;实现&＃xff0c;Zuul是用Java实现&＃xff0c;而JVM本身会有第一次加载比较慢的情况&＃xff0c;使得Zuul的性能相对较差&＃xff1b;
3. Zuul 2.x版本理念更先进&＃xff0c;想基于Netty非阻塞和支持长连接&＃xff0c;但Spring Cloud目前还没有整合&＃xff0c;Zuul 2.x的性能较1.x有较大提升。在性能方面&＃xff0c;根据官方提供的基准测试&＃xff0c;Spring Cloud Gateway的RPS(每秒请求数量)是Zuul的1.6倍。
4. Spring Cloud Gateway建立在Spring 5&＃xff0c;Spring Boot 2和Project Reactor之上&＃xff0c;使用非阻塞API&＃xff1b;
5. Spring Cloud Gateway还支持WebSocket&＃xff0c;并且与Spring紧密集成拥有更好的开发体验&＃xff1b;

二、Gateway三大概念

• 路由&＃xff1a;网关的基本构建块。它由ID&＃xff0c;目标URI、断言和过滤器集合定义。如果断言为true&＃xff0c;则匹配路由。

• 断言&＃xff1a;输入类型是Spring Framework ServerWebExchange。开发人员可以匹配HTTP请求中的所有内容&＃xff0c;例如请求头或请求参数&＃xff0c;如果请求与断言相匹配则进行路由。

• Filter&＃xff1a;指的是使用特定工厂构造的Spring Framework GatewayFilter实例。可以在请求被路由之前或者之后对请求进行修改。

三、Spring Cloud Gateway整体流程图

• DispatcherHandler&＃xff1a;所有请求的调度器&＃xff0c;负载请求分发&＃xff1b;
• RoutePredicateHandlerMapping:路由谓语匹配器&＃xff0c;用于路由的查找&＃xff0c;以及找到路由后返回对应的WebHandler&＃xff0c;DispatcherHandler会依次遍历HandlerMapping集合进行处理&＃xff1b;
• FilteringWebHandler : 使用Filter链表处理请求的WebHandler&＃xff0c;RoutePredicateHandlerMapping找到路由后返回对应的FilteringWebHandler对请求进行处理&＃xff0c;FilteringWebHandler负责组装Filter链表并调用链表处理请求&＃xff1b;

客户端向Spring Cloud Gateway发出请求&＃xff0c;如果网关处理程序映射确定请求与路由匹配&＃xff0c;则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链运行请求。筛选器由虚线分隔的原因是&＃xff0c;筛选器可以在发送代理请求之前&＃xff08;"pre"&＃xff09;和之后&＃xff08;"post"&＃xff09;运行逻辑。所有“前置”过滤器逻辑均被执行&＃xff0c;然后发出代理请求。发出代理请求后&＃xff0c;将运行“后”过滤器逻辑。

四、Gateway入门配置

下面我们新建一个module【springcloud-apigateway-gateway9527】&＃xff0c;这里面去集成Gateway新一代网关。

【a】pom.xml&＃xff0c;注意添加spring-cloud-starter-gateway依赖

注意&＃xff1a;【spring-cloud-starter-gateway不需要spring-cloud-starter-web&＃xff0c;需要将 web 模块移除&＃xff0c;否则启动会报错】


springcloud2020com.wsh.springcloud1.0-SNAPSHOT4.0.0springcloud-apigateway-gateway9527org.springframework.cloudspring-cloud-starter-gatewayorg.springframework.cloudspring-cloud-starter-netflix-eureka-clientcom.wsh.springcloudspringcloud-api-commons${project.version}org.projectlomboklomboktrueorg.springframework.bootspring-boot-starter-testtest

【b】application.yml配置文件&＃xff1a;最主要的就是网关URL映射的配置&＃xff0c;由上可知&＃xff0c;gateway网关三要素&＃xff1a; 路由ID、断言Predicate、过滤器(可有可无)&＃xff0c;所以我们作出如下配置&＃xff1a;

server:port: 9527
spring:application:name: springcloud-gatewaycloud:gateway:routes:#如下配置表示,当浏览器URL访问localhost:9527/gatewaySimple/**的时候,gateway网关会帮忙转发到http://localhost:8001/gatewaySimple/**去.- id: payment8001_gatewaySimple #路由的ID&＃xff0c;没有固定规则但要求唯一&＃xff0c;建议配合服务名uri: http://localhost:8001 #指定payment8001的访问地址,即匹配后提供服务的路由地址predicates:- Path&＃61;/gatewaySimple/** # 断言&＃xff0c;路径相匹配的进行路由
eureka:instance:hostname: springcloud-gateway-serviceclient:service-url:register-with-eureka: truefetch-registry: truedefaultZone: http://springcloud-eureka7001.com:7001/eureka/,http://springcloud-eureka7002.com:7002/eureka/ #集群版Eureka注册中心

如上路由转发配置说明&＃xff1a;

当浏览器URL访问 localhost:9527/gatewaySimple/** 的时候&＃xff0c;gateway网关会帮忙转发到http://localhost:8001/gatewaySimple/**去。

【c】主启动类

package com.wsh.springcloud;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;&＃64;SpringBootApplication
&＃64;EnableEurekaClient
public class GateWayServiceApplication9527 {public static void main(String[] args) {SpringApplication.run(GateWayServiceApplication9527.class, args);}
}


【d】服务提供方【springcloud-provider-payment8001】增加如下接口&＃xff0c;很简单&＃xff0c;这里就不过多叙述。

/*** 测试gateway网关转发请求简单示例*/&＃64;GetMapping("/gatewaySimple/{name}")public String testGateway(&＃64;PathVariable("name") String name) {return "hello, the name is :" &＃43; name;}

【e】测试

启动项目&＃xff0c;我们首先访问http://localhost:8001/gatewaySimple/weixiaohuai&＃xff0c;运行结果如下图&＃xff1a;

可见&＃xff0c;服务提供方的gatewaySimple接口是通的&＃xff0c;下面&＃xff0c;我们使用网关地址来访问&＃xff1a;http://localhost:9527/gatewaySimple/weixiaohuai

可以看到&＃xff0c;gateway成功转发请求。

五、Gateway路由配置方式

Gateway网关路由配置方式主要有两种&＃xff1a;

• application.yml文件中配置&＃xff1b;
• 代码中注入RouteLocator的bean&＃xff1b;

上面我们已经学习了如何在yml配置文件中配置的方法&＃xff0c;接下来我们使用第二种方式进行配置。

官网案例&＃xff1a;https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#configuration

【a】服务提供方增加如下方法

/*** 测试gateway网关转发请求简单示例 - RouteLocator方式*/&＃64;GetMapping("/gatewaySimpleRouteLocator/{name}")public String gatewaySimpleRouteLocator(&＃64;PathVariable("name") String name) {return "hello, [RouteLocator] the name is :" &＃43; name;}

【b】定义RouteLocator的配置类

package com.wsh.springcloud.config;import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** &＃64;version V1.0* &＃64;ClassName: com.wsh.springcloud.config.CustomRouteLocatorConfig.java* &＃64;Description: 自定义路由定位器配置* &＃64;author: weishihuai* &＃64;date: 2020/8/19 13:40*/
&＃64;Configuration
public class CustomRouteLocatorConfig {&＃64;Beanpublic RouteLocator routes(RouteLocatorBuilder routeLocatorBuilder) {RouteLocatorBuilder.Builder routes &＃61; routeLocatorBuilder.routes();routes.route("payment8001_gatewaySimpleRouteLocator", //路由IDr -> r.path("/gatewaySimpleRouteLocator/**") //路由路径正则表达式.uri("http://localhost:8001") //跳转目标服务地址).build();return routes.build();}}


参照application.yml配置文件的方式&＃xff0c;如上路由转发配置说明&＃xff1a;

当浏览器URL访问 localhost:9527/gatewaySimpleRouteLocator/** 的时候&＃xff0c;gateway网关会帮忙转发到http://localhost:8001/gatewaySimpleRouteLocator/**去。

【c】测试 

启动项目&＃xff0c;浏览器访问&＃xff1a;http://localhost:8001/gatewaySimpleRouteLocator/weixiaohuai

确保服务提供方的接口gatewaySimpleRouteLocator是通的&＃xff0c;然后我们使用网关路径去访问&＃xff1a;http://localhost:9527/gatewaySimpleRouteLocator/weixiaohuai

可见&＃xff0c;网关也成功了完成了路由转发&＃xff0c;以上就是用编码的方式实现gateway网关进行路由映射配置的方法。

六、Gateway动态路由

我们注意到&＃xff0c;上面访问的路由地址我们是写死的【uri: http://localhost:8001 #指定payment8001的访问地址,即匹配后提供服务的路由地址】&＃xff0c;在微服务架构中&＃xff0c;微服务提供者不可能是单机部署&＃xff0c;如果在集群环境下&＃xff0c;如果写死某个服务的话&＃xff0c;写死路由那肯定就不行了&＃xff0c;所以就需要使用动态路由。

• 实现原理&＃xff1a;默认情况下Gateway会根据注册中心注册的服务列表&＃xff0c;以注册中心上微服务名为路径创建动态路由进行转发&＃xff0c;从而实现动态路由的功能。

下面&＃xff0c;我们以一个简单的示例说明如何实现动态路由&＃xff0c;需要修改的地方如下&＃xff1a;

【a】修改Gateway网关服务的pom.xml&＃xff0c;将网关服务注册进Eureka中

org.springframework.cloudspring-cloud-starter-netflix-eureka-client

【b】服务提供方增加如下方法

/*** 测试gateway网关转发负载均衡转发*/&＃64;GetMapping("/gatewayLoadBalance/{name}")public String gatewayLoadBalance(&＃64;PathVariable("name") String name) {return "hello, [gatewayLoadBalance] the name is :" &＃43; name &＃43; ", the server port is " &＃43; serverPort;}

注意&＃xff1a;由于需要测试网关的负载均衡调用&＃xff0c;所以两个服务提供者payment8001、8002都需要加上此方法。

【c】修改application.yml&＃xff0c;需要注意的是uri的协议为lb&＃xff0c;表示启用Gateway的负载均衡功能。

• lb://serviceName是springcloud gateway在微服务中自动为我们创建的负载均衡uri。

具体修改的地方&＃xff1a;

• spring.cloud.gateway.discovery.locator.enabled&＃61;true   #开启从注册中心动态创建路由的功能&＃xff0c;利用微服务名进行路由
• lb://serviceName负载均衡配置

server:port: 9527
spring:application:name: springcloud-gatewaycloud:gateway:routes:#如下配置表示,当浏览器URL访问localhost:9527/gatewaySimple/**的时候,gateway网关会帮忙转发到http://localhost:8001/gatewaySimple/**去.- id: payment8001_gatewaySimple #路由的ID&＃xff0c;没有固定规则但要求唯一&＃xff0c;建议配合服务名uri: http://localhost:8001 #指定payment8001的访问地址,即匹配后提供服务的路由地址predicates:- Path&＃61;/gatewaySimple/** # 断言&＃xff0c;路径相匹配的进行路由#如下配置表示,当浏览器URL访问localhost:9527/gatewayLoadBalance/**的时候,gateway网关负载均衡地将请求分发到springcloud-payment-service服务中去.- id: payment_service_loadbalance #路由IDuri: lb://springcloud-payment-service #springcloud-payment-service为服务提供者注册到Eureka的应用名称(application name)predicates:- Path&＃61;/gatewayLoadBalance/** # 断言&＃xff0c;路径相匹配的进行路由discovery:locator:enabled: true #开启从注册中心动态创建路由的功能&＃xff0c;利用微服务名进行路由
eureka:instance:hostname: springcloud-gateway-serviceclient:service-url:register-with-eureka: truefetch-registry: truedefaultZone: http://springcloud-eureka7001.com:7001/eureka/,http://springcloud-eureka7002.com:7002/eureka/ #集群版Eureka注册中心

 【d】测试

启动两个服务提供者payment8001和payment8002、网关服务9527&＃xff0c;查看服务是否都正常注册进Eureka&＃xff1a;

&＃xff0c;浏览器访问&＃xff1a;http://localhost:9527/gatewayLoadBalance/weixiaohuai&＃xff0c;访问多几次&＃xff0c;观察运行结果&＃xff1a;

可见&＃xff0c;运行结果请求后端服务的端口号是8001、8002交替出现&＃xff0c;网关gateway成功帮我们完成了负载均衡转发请求到【springcloud-payment-service】 的功能&＃xff0c;以上就是关于gateway中动态路由的配置方法。

七、总结

本篇文章主要介绍了新一代网关Spring Cloud Gateway的概念&＃xff0c;优点以及与Zuul的比较&＃xff0c;并简单总结了一下gateway中路由配置的两种方式&＃xff0c;还通过一个简答的示例说明了如何配置动态路由&＃xff0c;当然gateway的内容远远不止这些&＃xff0c;还有一些Predicate断言、Filters过滤器等等&＃xff0c;我们在下篇文章进行介绍。

以上相关项目的代码我已经放在Gitee上&＃xff0c;有需要的小伙伴可以去拉取进行学习&＃xff1a;https://gitee.com/weixiaohuai/springcloud_Hoxton&＃xff0c;由于笔者水平有限&＃xff0c;如有不对之处&＃xff0c;还请小伙伴们指正&＃xff0c;相互学习&＃xff0c;一起进步。