1 Gateway简介
- 在Spring Cloud中网关的实现包括两种
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而Spring Cloud Gateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能
- Gateway概述
- Spring Cloud Gateway是Spring Cloud的一个全新项目,该项目是基于Spring 5.0,Spring Boot 2.0和Project Reactor等响应式编程和事件流技术开发的网关
- Gateway旨在为微服务架构提供一种简单、有效、统一的API路由管理方式
- Gateway网关是微服务的守门神,所有微服务的统一入口
- Gateway的核心功能
权限控制
- 网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
请求路由和负载均衡
- 一切请求都必须先经过Gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。
- 当然路由的目标服务有多个时,还需要做负载均衡。
限流
- 当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大
- Gateway路由流程图
2 Gateway的使用
Gateway也是一个服务,因此第一步就是创建Gateway服务并引入相关依赖
<!--spring cloud gateway服务网关-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
编写application.yml,在其中我们可以配置路由规则
server:
port: 10010 # 服务端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
# uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** # 按照路径匹配,只要以/user/开头就符合要求
路由配置包括
- 路由id
每个路由的唯一标示,没有命名规则,唯一即可
- 路由目标(uri)
路由的目标地址,http代表固定地址,lb(LoadBalance)代表根据服务名进行负载均衡
- 路由断言(predicates)
路由的规则,其中Path表示按路径进行匹配
- 路由过滤器(filters)
对请求或响应做处理
上述配置中,Gateway将/user/**开头的请求,代理到lb://userservice,其中lb是负载均衡,lb会根据服务名拉取服务列表,实现负载均衡。
- 测试
浏览器访问http://localhost:10010/user/1,符合id为user-service的路由Path制定的/user/**规则,请求将转发到http://userservice/user/1
3 断言工厂(Predicate Factory)
断言工厂概述
- 配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
- 例如Path=/user/**是按照路径匹配,这个规则是由路径断言工厂
org.springframework.cloud.
gateway.handler.predicate.PathRoutePredicateFactory
类来处理的
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 | | RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 | | Weight** | 权重处理 |
|
4 过滤器工厂(GateFilter)
- GatewayFilter概述
GatewayFilter是Gateway提供的过滤器,可以对进入网关的请求和微服务返回的响应做处理
- Spring提供了31种不同的路由过滤器工厂,常用工厂如下 | 名称 | 说明 | | —- | —- | | AddRequestHeader | 给当前请求添加一个请求头 | | RemoveRequestHeader | 移除请求中的一个请求头 | | AddResponseHeader | 给响应结果中添加一个响应头 | | RemoveResponseHeader | 从响应结果中移除有一个响应头 | | RequestRateLimiter | 限制请求的流量 |
- 实例:给所有进入UserService的请求添加一个请求头Truth=cyc is freaking awesome!
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 过滤器
- AddRequestHeader=Truth, cyc is freaking awesome! # 添加请求头
当前过滤器写在user-service路由下,因此仅仅对访问UserService服务的请求有效。
- 默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth, cyc is freaking awesome!
5 全局过滤器(Global Filter)
1 全局过滤器简介
全局过滤器概述
- Gateway提供了31种过滤器,但每一种过滤器的作用都是固定的。如果我们希望拦截请求然后做自己的业务逻辑则没办法实现。
- 与DefaultFilter的作用一样,全局过滤器的作用也是处理一切进入网关的请求和微服务响应。区别在于DefaultFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的处理逻辑需要自己写代码实现。
全局过滤器定义方式是实现GlobalFilter接口
public interface GlobalFilter { /** * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 * * @param exchange 请求上下文,可以从中获取Request、Response等信息 * @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono<Void>} 返回标示当前过滤器业务结束 */ Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain); }
在全局过滤器中编写自定义逻辑,可以实现下列功能
- 登录状态判断
- 权限校验
- 请求限流
- …
2 自定义全局过滤器实例
- 过滤器需求
定义全局过滤器拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
- 过滤器实现 ```java package person.cyc.gateway.filters;
import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.annotation.Order; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono;
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono
6 过滤器执行顺序
过滤器链概述
- 请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
- 请求路由后,会将当前路由过滤器、DefaultFilter和GlobalFilter合并到一个过滤器链(集合)中,排序后依次执行每个过滤器
过滤器链排序规则
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口或者添加@Order注解来指定order值
- 路由过滤器和DefaultFilter的order值由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 DefaultFilter -> 路由过滤器 -> GlobalFilter的顺序执行。