Spring Cloud Gateway 是 Spring 官方基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等技术开发的网关,旨在为微服务架构提供一种简单而有效的统一的 API 路由管理方式,统一访问接口。Spring Cloud Gateway 作为 Spring Cloud 生态系中的网关,目标是替代 Netflix ZUUL,其不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控/埋点,和限流等。它是基于Nttey的响应式开发模式。
微服务网关存在的意义
不同的微服务一般会有不同的网络地址,客户端在访问这些微服务时必须记住几十甚至几百个地址,这对于客户端方来说太复杂也难以维护,如果让客户端直接与各个微服务通讯,可能会有很多问题,比如如下问题
因此,我们需要一个微服务网关,介于客户端与服务器之间的中间层,所有的外部请求都会先经过微服 务网关。客户端只需要与网关交互,只知道一个网关地址即可,这样简化了开发还有以下优点:
项目案例:传送门
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
注意SpringCloud Gateway使用的web框架为webflux,和SpringMVC不兼容。引入的限流组件是 hystrix。redis底层不再使用jedis,而是lettuce。
@SpringBootApplication
spring:
application:
name: api-gateway #指定服务名
cloud:
gateway:
routes:
- id: product-service
uri: http://127.0.0.1:9002
predicates:
- Path=/item/**
参数解析
Spring Cloud Gateway 的功能很强大,上边只是使用了 predicates 进行了简单的条件匹配,其实 Spring Cloud Gataway 帮我们内置了很多 Predicates 功能。在 Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则,有通过 Header、请求参数等不同的条件来进行作为条件匹配到对应的路由。
//请求时间满足在配置时间之后
AfterRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求时间满足在配置时间之前
BeforeRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求时间满足在配置时间之间
BetweenRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求Headers是否包含指定名称
CloudFoundryRouteServiceRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求指定Cookie正则匹配指定值
CookieRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求指定Header正则匹配指定值
HeaderRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求指定Host匹配指定值
HostRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求指定Method匹配的Method
MethodRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求路径正则匹配指定值
PathRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求查询参数正则匹配指定值
QueryRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
ReadBodyPredicateFactory (org.springframework.cloud.gateway.handler.predicate)
//请求远程地址匹配匹配指定值
RemoteAddrRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
WeightRoutePredicateFactory (org.springframework.cloud.gateway.handler.predicate)
和zuul网关类似,在SpringCloud GateWay中也支持动态路由:即自动的从注册中心中获取服务列表并访问。
在工程的pom文件中添加注册中心的客户端依赖,具体添加什么依赖,看用的注册中心是什么
修改 application.yml 配置文件,添加eureka注册中心的相关配置,并修改访问映射的URL为服务名称
server:
port: 8080
spring:
application:
name: chenfu-gateway
cloud:
gateway:
routes:
- id: item-service
uri: lb://shop-service-item
predicates:
- Path=/item/**
filters:
# 从URL前面截图一个单词,在这里也就是item,之后的才是转发的URL
- StripPrefix=1
- id: client-service
uri: lb://client-service
predicates:
- Path=/client/**
filters:
- StripPrefix=1
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka/
# 获取服务列表的周期:5s
registry-fetch-interval-seconds: 5
instance:
prefer-ip-address: true
ip-address: localhost
在SpringCloud Gateway中,路由转发是直接将匹配的路由path直接拼接到映射路径(URI)之后,这在微服务开发中往往没有那么便利。此时可以通过RewritePath机制来进行路径重写。
Spring Cloud Gateway除了具备请求路由功能之外,也支持对请求的过滤。是通过过滤器的形式来实现的。
Spring Cloud Gateway 的 Filter 的生命周期不像 Zuul 的那么丰富,它只有两个:“pre” 和 “post”。
Spring Cloud Gateway 的 Filter 从作用范围可分为另外两种GatewayFilter 与 GlobalFilter。
由于内置过滤器太多,就不一一列举注释
局部过滤器(GatewayFilter),是针对单个路由的过滤器。可以对访问的URL过滤,进行切面处理。在 Spring Cloud Gateway中通过GatewayFilter的形式内置了很多不同类型的局部过滤器。
全局过滤器(GlobalFilter)作用于所有路由,Spring Cloud Gateway 定义了Global Filter接口,用户 可以自定义实现自己的Global Filter。通过全局过滤器可以实现对权限的统一校验,安全性验证等功 能,并且全局过滤器也是程序员使用比较多的过滤器
内置的过滤器已经可以完成大部分的功能,但是对于企业开发的一些业务功能处理,还是需要我们自己 编写过滤器来实现的,那么我们一起通过代码的形式自定义一个过滤器,去完成统一的权限校验。
开发中的鉴权逻辑:
对于验证用户是否已经登录鉴权的过程可以在网关层统一检验。检验的标准就是请求中是否携 带token凭证以及token的正确性