一、什么是网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
⛅网关的实现原理
Gateway 服务网关是所有请求的统一入口,每次请求由服务网关接受并根据路径条件转发至不同的微服务中。
网关的核心特性
- 请求路由
- 权限控制
- 限流
架构图
权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
二、Gateway 与 Zuul 的区别?
Spring Cloud 中的 网关类型
- Gateway
- Zuul
两者之间的区别
- Zuul 是基于Servlet 的实现,属于
阻塞式编程
- Spring Cloud Alibaba Gateway 服务网关是基于 Spring5.x 提供的WebFlux,属于
响应式编程
的实现,具备更好的性能。
三、Gateway 服务网关 快速入门
⛄需求
基于 Spring Cloud Alibaba Gateway 服务网关完成 路由转发,具体要求如下
- 必须基于 Gateway 服务网关转发路由至指定的微服务
- 配置路由的访问时间,order-service 服务 访问必须在2022-07-09之前
- 配置服务的负载均衡,防止大规模请求造成服务无法访问
⏳项目搭建
新建 module
右击 nacos-demo
新建 module
Next 下一步,命名为 gateway
,单击 Finish完成创建
引入依赖
1. <!--网关--> 2. <dependency> 3. <groupId>org.springframework.cloud</groupId> 4. <artifactId>spring-cloud-starter-gateway</artifactId> 5. </dependency> 6. <!--nacos服务发现依赖--> 7. <dependency> 8. <groupId>com.alibaba.cloud</groupId> 9. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 10. </dependency> 11. <!--客户端负载均衡loadbalancer--> 12. <dependency> 13. <groupId>org.springframework.cloud</groupId> 14. <artifactId>spring-cloud-starter-loadbalancer</artifactId> 15. </dependency>
配置项目基本信息
1. server: 2. port: 10010 # 网关端口 3. spring: 4. application: 5. name: gateway # 服务名称 6. cloud: 7. nacos: 8. server-addr: localhost:8848 # nacos地址 9. gateway: 10. routes: # 网关路由配置 11. - id: user-service # 路由id,自定义,只要唯一即可 12. # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址 13. uri: lb://userService # 路由的目标地址 lb就是负载均衡,后面跟服务名称 14. predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 15. - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求 16. - id: order-service # 路由id,自定义,只要唯一即可 17. # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址 18. uri: lb://orderService 19. predicates: 20. - Path=/order/** 21. - Before=2022-07-09T17:42:47.789-07:00[Asia/Shanghai]
我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
我们将 /user/**开头的请求,代理到lb://userService, /order/** 开头的请求,代理到 lb://orderService , lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
新建 Application 启动类
1. package com.chen; 2. 3. import org.springframework.boot.SpringApplication; 4. import org.springframework.boot.autoconfigure.SpringBootApplication; 5. 6. @SpringBootApplication 7. public class GatewayApplication { 8. 9. public static void main(String[] args) { 10. SpringApplication.run(GatewayApplication.class, args); 11. } 12. } 13.
✅启动测试
依赖服务启动
在启动之前,请务必启动 Nacos 服务,所有的服务都需要依赖于 Nacos服务注册中心来实现
启动 order-service、user-service、gateway服务
测试访问
访问 localhost:10010/user/1,符合/user/**
规则,请求转发 uri 至 http://userService/user/1,得到结果
访问 localhost:10010/order/101,符合 /order/**
规则,但不符合 Before=2022-07-09T17:42:47.789-07:00[Asia/Shanghai]
规则,所以,转发uri失败!
测试成功,访问user服务成功访问,访问order服务由于已过期限,所以报404未找到!
小结 Gateway服务网关项目
网关搭建步骤:
- 创建项目,引入nacos服务发现和gateway依赖
- 配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
- 路由id:路由的唯一标示
- 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
- 路由断言(predicates):判断路由的规则,
- 路由过滤器(filters):对请求或响应做处理
四、Gateway 断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个:
名称 说明 示例
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 权重处理
例如,Path
、 Before,在Gateway项目快速入门中就用到了该断言工厂
具体的详细配置可看 Spring Cloud Alibaba Gateway 官网
五、Gateway 过滤器
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
⛽过滤器工厂
路由器的种类
Spring提供了31种不同的路由过滤器工厂。例如:
名称 说明
AddRequestHeader 给当前请求添加一个请求头
RemoveRequestHeader 移除请求中的一个请求头
AddResponseHeader 给响应结果中添加一个响应头
RemoveResponseHeader 从响应结果中移除有一个响应头
RequestRateLimiter 限制请求的流量
请求头过滤器
下面我们以AddRequestHeader 为例来讲解。
需求:给所有进入userservice的请求添加一个请求头:Truth= Hello WHC !!!
只需修改 gateway 服务的 application.yaml 文件即可添加路由过滤即可
1. spring: 2. cloud: 3. gateway: 4. routes: 5. - id: user-service 6. uri: lb://userService 7. predicates: 8. - Path=/user/** 9. filters: # 过滤器 10. - AddRequestHeader=Truth, Hello WHC !!! # 添加请求头
在userService 下写过滤器,只对userService服务生效,重新启动即可生效
默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
1. spring: 2. cloud: 3. gateway: 4. routes: 5. - id: user-service 6. uri: lb://userservice 7. predicates: 8. - Path=/user/** 9. default-filters: # 默认过滤项,全局生效 10. - AddRequestHeader=Truth, Hello WHC !!! # 添加请求头
添加该默认过滤器,对所有微服务生效,重新启动服务即可生效
过滤器小结
过滤器的作用是什么?
- 对路由的请求和响应做加工处理,比如添加请求头,返回指定响应信息
- 配置在路由下的过滤器只对当前服务生效
defaultFilters的作用是什么?
- 配置过滤器,并对全局服务生效
♨️全局过滤器
上一节的过滤器中,可以看出,这些过滤器都是固定的,如果我们想要拦截请求,做自己的业务逻辑更是无法实现
全局过滤器的作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
实现流程
实现GlobalFilter接口
1. public interface GlobalFilter { 2. /** 3. * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 4. * 5. * @param exchange 请求上下文,里面可以获取Request、Response等信息 6. * @param chain 用来把请求委托给下一个过滤器 7. * @return {@code Mono<Void>} 返回标示当前过滤器业务结束 8. */ 9. Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain); 10. }
在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有authorization,
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
核心代码
1. package com.chen.gateway; 2. 3. import org.springframework.cloud.gateway.filter.GatewayFilterChain; 4. import org.springframework.cloud.gateway.filter.GlobalFilter; 5. import org.springframework.core.Ordered; 6. import org.springframework.core.annotation.Order; 7. import org.springframework.http.HttpStatus; 8. import org.springframework.http.server.reactive.ServerHttpRequest; 9. import org.springframework.stereotype.Component; 10. import org.springframework.util.MultiValueMap; 11. import org.springframework.web.server.ServerWebExchange; 12. import reactor.core.publisher.Mono; 13. 14. /** 15. * 认证过滤器类 16. * 需要通过注解或接口的形式去管理过滤器的顺序,因为一个项目中可能有多个过滤器 17. */ 18. //@Order(-1) 19. @Component 20. public class AuthorizeFilter implements GlobalFilter, Ordered { 21. @Override 22. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 23. // 网关基于 WebFlux 响应式编程编写,api可能有些不一样 24. 25. // 1. 获取请求参数 26. ServerHttpRequest request = exchange.getRequest(); 27. // 2. 获取参数中的authorization 参数 28. MultiValueMap<String, String> params = request.getQueryParams(); 29. // 3, 判断参数值是否等于 admin 30. String auth = params.getFirst("authorization"); 31. // 4. 如果相等,放行 32. if ("admin".equals(auth)) { 33. return chain.filter(exchange); 34. } 35. 36. // 设置响应码,未登录 37. exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); 38. 39. // 5,如果不等,则拦截 40. return exchange.getResponse().setComplete(); 41. } 42. 43. @Override 44. public int getOrder() { 45. return -1; 46. } 47. } 48.
过滤器的执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、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排序,组织过滤器链