SpringCloud.H-网关
# SpringCloud.H-网关
笔记日期:2020.5.20
# 1. Zuul
停更 (netflix)
# 2. gateway
spring(自己)
https://blog.csdn.net/qq_41211642/article/details/104873418
# 1.概述
# 1. 介绍
官网: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/
Cloud 全家桶中有个很重要的组件就是网关,在1.x版本中都是采用的Zuul网关;但在2.x版本中,zuul的升级一直跳票,SpringCloud最后自己研发了一个网关替代Zuul,那就是Spring Cloud Gateway
Gateway是在Spring 生态系统之上构建的API网关服务,基于Spring 5,SpringBoot 2和Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由,以及提供一些强大的过滤器功能,例如:熔断、限流、重试等。
总结: Spring Cloud Gateway 使用的Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架.(利于高并发,非阻塞式,响应式编程高性能的框架
)
# 2. 能干什么?
功能:
- 反向代理
- 鉴权
- 流量控制
- 熔断
- 日志监控。。。
# 3. 微服务架构中网关在哪里?
# 4. 为什么选择Gateway
netflix不太靠谱,zuul 2.0一直跳票,迟迟不发布
- 一方面因为Zuul 1.0已经进入了维护阶段,而且Gateway是SpringCloud团队研发的,值得信赖。而且很多功能Zuul都没有用起来也非常的简单便捷。
- Gateway是基于异步非阻塞模型上进行开发的,性能方面不需要担心。虽然Netflix早就发布了最新的Zuul 2.x,但SpringCloud貌似没有整合计划。而且Netflix相关组件都宣布进入维护期。
- 多方面综合考虑Gateway是很理想的网关选择.
SpringCloud Gateway具有如下特性
- 基于Spring Framework 5,Project Reactor和Spring Boot 2.0构建
- 动态路由:能够匹配任何请求属性
- 可以对路由指定 Predicate(断言)和Filter(过滤器)
- 集成Hystrix的断路器功能
- 集成Spring Cloud 的服务发现功能
- 易于编写的Predicate(断言)和Filter(过滤器)
- 请求限流功能
- 支持路径重写
SpringCloud Gateway 与 zuul 的区别
在SpringCloud Finchley 正式版之前,SpringCloud推荐的网关是Netflix提供的Zuul:
- Zuul 1.x是一个基于阻塞 I/O 的API Gateway
- Zuul 1.x基于servlet 2.5使用阻塞架构它不支持任何长连接(如websocket)Zuul的设计模式和Nginx较像,每次I/O 操作都是从工作线程中选择一个执行,请求线程被阻塞到工作线程完成,但是差别是Nginx用C++实现,Zuul用Java实现,而JVM本身会有一次加载较慢的情况,使得zuul的性能相对较差
- Zuul 2.x理念更先进,向基于Netty非阻塞和支持长连接,但SpringCloud目前还没有整合。Zuul 2.x的性能较Zuul 1.x有较大提升。在性能方面,根据官方提供的基准测试,SpringCloud Gateway的RPS(每秒请求数)是Zuul的1.6倍
- SpringCloud Gateway建立在Spring Framework5、Project Reactor和Spring Boot 2之上,使用非阻塞API
- SpringCloud Gateway还支持WebSocket,并且与Spring紧密集成用于更好的开发体验
Gateway模型
Gateway支持 Reactor 和 WebFlux
传统的Web框架,比如说:struts2,springmvc等都是基于Servlet API与servlet容器基础之上运行的。 但是Servlet3.1之后有了异步非阻塞的支持,而WebFlux是一个典型非阻塞异步的框架,它的核心是基于Reactor的相关API实现的。相对与传统的Web框架来说,它可以运行在诸如Netty,Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程
Spring WebFlux 是 Spring 5.0引入的新的响应式框架,区别于Spring MVC,它不需要依赖Servlet API,它是完全异步非阻塞的,并且基于 Reactor 来实现响应式流规范
zuul 1.x模型
SpringCloud中所集成的Zuul版本,采用的是Tomcat容器,使用的是传统的Servlet IO处理模型。
Servlet生命周期? servlet 由 servlet container 进行生命周期管理 container 启动时构造 servlet 对象并调用 servlet init() 进行初始化; container 运行时接受请求,并为每个请求分配一个线程(一般从线程池中获取空闲线程)然后调用service(); container 关闭时调用 servlet destory() 销毁servlet;
上述模式的缺点: servlet是一个简单的网络IO模型,当请求进入servlet container时,servlet container就会为其绑定一个线程,在并发不高的场景下这种模型是适用的。但是一旦高并发(比如用jmeter压测),线程数量就会涨,而线程资源代价是昂贵的(上下文切换,内存消耗大)严重影响请求的处理时间。在一些简单业务场景下,不希望为每个request分配一个线程,只需要1个或几个线程就能应对极大并发的请求,这种业务场景下servlet模型没有优势
所以Zuul 1.x是基于servlet之上的一个阻塞式处理模型,即spring实现了处理所有request请求的一个servlet(DispatcherServlet)并由该servlet阻塞式处理。所以SpringCloud Zuul无法摆脱servlet模型的弊端。
# 2. Gateway 核心概念及工作流程
# 1. 核心概念
Route(路由):路由是构建网关的基本模块,它由ID、目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由
Predicate(断言):参考的是Java8的java.util.function.Predicate 开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由
Filter(过滤):指的是Spring框架中GatewayFilyter的实例,使用过滤器,可以在请求被路由前或者之后进行修改
匹配方式就叫断言,实现这个匹配方式就叫filter,对外表现出来就是路由的功能。
- web 请求,通过一些匹配条件,定位到真正的服务节点。并在这个转发过程的前后,进行一些精细化控制。
- predicate 就是我们的匹配条件,而filter,就可以理解为一个无所不能的拦截器。有了这两个元素再加上目标uri,就可以实现一个具体的路由。
# 2. gateway工作流程
客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到Gateway Web Handler。
Handler再通过指定的过滤器链来讲请求发送到我们实际的服务执行业务逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑
Filter 在 “pre” 类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等;在 “post” 类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等,有着非常重要的作用
核心逻辑 :路由转发 + 执行过滤器链
# 3. 编码
https://blog.csdn.net/qq_41211642/article/details/104874932
<!--gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
2
3
4
5
- 配置文件
server:
port: 9527
spring:
application:
name: cloud-gateway
# 网关配置
cloud:
gateway:
routes:
- id: payment_routh #payment_routh #路由的ID,没有固定规则但要求唯一,简易配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2 #payment_routh #路由的ID,没有固定规则但要求唯一,简易配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
效果
# 4. Gateway网关路由有两种配置方式
https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#route-metadata-configuration
# 方式一
3中的方式: 在配置文件yml 中配置
# 方式二
代码中注入RouteLocator 的Bean
@Configuration
public class GatewayConfig {
/**
* 通过访问 http://localhost:9527/guonei 来访问 http://news.baidu.com/guonei
* 通过路由 百度百度网站
* http://news.baidu.com/guonei
*/
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
RouteLocatorBuilder.Builder routes = builder.routes();
routes.route("path_route_chggx",
r -> r.path("/**").uri("http://news.baidu.com/guonei"))
.build();
return routes.build();
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
效果
http://localhost:9527/guonei
# 5. 动态路由
# 1. 为什么使用动态路由?
之前访问的路由地址我们是写死的,在微服务架构中,微服务提供者不可能只有一台服务器,就需要动态路由
# 2. 使用思路
之前80客户端发送请求访问8001/8002,通过ribbon负载均衡,将请求分散,现在服务提供者如果是多台,就需要将ribbon替换为gateway,只暴露gateway,客户端请求统一发到gateway,gateway将请求转发给8001/8002。
默认情况下Gateway会根据注册中心注册的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
现在启动一个eureka7001,两个服务提供者8001/8002
# 3. 编码
修改配置文件
- 开启从注册中心动态创建路由的功能,利用微服务名进行路由
- 使用"lb"动态匹配路由地址
访问 测试
http://localhost:9527/payment/get/1
8001/8002 切换访问
# 6. Predicate
https://blog.csdn.net/qq_41211642/article/details/104879278
# 0. 求时区时间
public class T2 {
public static void main(String[] args) {
// 默认时区
ZonedDateTime zbj = ZonedDateTime.now();
// 2020-04-02T10:32:44.384+08:00[Asia/Shanghai]
System.out.println(zbj);
// 用于制定时区获取当前时间
// ZonedDateTime zny = ZonedDateTime.now(ZoneId.of("America/New_york"));
// System.out.println(zny);
}
}
2
3
4
5
6
7
8
9
10
11
12
13
# 1. After 时间类型
https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gateway-request-predicates-factories
spring:
application:
name: cloud-gateway
# 网关配置
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能,利用微服务名进行路由(默认false)
routes:
- id: payment_routh #payment_routh #路由的ID,没有固定规则但要求唯一,简易配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service # 匹配后动态提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2 #payment_routh #路由的ID,没有固定规则但要求唯一,简易配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service # 匹配后动态提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2020-04-02T10:32:44.384+08:00[Asia/Shanghai]
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
- 调节时间,只有当前时间在"设置时间之后"才能正常访问
# 2. Before 时间类型
- 调节时间,只有当前时间在"设置时间之前"才能正常访问
# 3. Between 时间类型
- 调节时间,只有当前时间在"设置时间之内"才能正常访问
# 4. Cookie
Cookie Route Predicate: 需要两个参数, ==(Cookie Name,正则表达式)==
路由规则会通过获取对应的Cookie Name值和正则表达式去匹配,如果匹配上就会执行路由,如果没有匹配上则不执行
# 1. yml配置
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2020-04-02T10:32:44.384+08:00[Asia/Shanghai]
- Cookie=username,hp
2
3
4
# 2. 不带cookie ==curl测试==
curl http://localhost:9527/payment/lb
# 3. 带cookie
curl http://localhost:9527/payment/lb --cookie "username=hp"
# 5. Header
两个参数: ==(属性名,正则表达式)== 这个属性和正则表达式匹配则执行
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2020-04-02T10:32:44.384+08:00[Asia/Shanghai]
# - Cookie=username,hp
- Header=X-Request-Id, \d+ # 请求头要有"X-Request-Id"属性,并且值为整数的正则表达式
2
3
4
5
# 1. 测试
curl http://localhost:9527/payment/lb -H "X-Request-Id: 1234"
- 负数报错.
# 6. Host
# 7. Method
# 8. Path
# 9. Query
# 10. RemoteAddr
# 11. Weight
# 7. Filter
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用
SpringCloud Gateway内置了多种路由过滤器,他们都由GatewayFilter的工厂类来生成
SpringCloud Gateway的 Filter,生命周期有 pro 和 post, 种类有GatewayFilter 和 GlobalFilter
常用的GatewayFilter 有31种之多.GlobalFilter 有10个.官网参考 (opens new window)
这里主要介绍一下==自定义全局GlobalFilter==
# 1. 自定义接口
# 1. 主要接口
==GlobalFilter,Ordered==
# 2. 能干啥?
- 全局日志记录
- 统一网关鉴权
- ......
# 3. 编码
- 配置
- id: payment_routh2 #payment_routh #路由的ID,没有固定规则但要求唯一,简易配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service # 匹配后动态提供服务的路由地址
filters:
- AddRequestParameter=X-Requesr-Id,1024 # 过滤器工厂,会在匹配的请求头,加上一对请求头,名称为X-Request-Id值为1024
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2020-04-02T10:32:44.384+08:00[Asia/Shanghai]
# - Cookie=username,hp
- Header=X-Request-Id, \d+ # 请求头要有"X-Request-Id"属性,并且值为整数的正则表达式
2
3
4
5
6
7
8
9
10
- 代码
@Slf4j
@Component
public class MyLogGatewayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("******come in MyLogGatewayFilter: "+new Date());
// 参数
String username = exchange.getRequest().getQueryParams().getFirst("username");
if (username==null){
log.info("******用户名为null,非法用户,o(╥﹏╥)o");
// 不被接受
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
/**
* 加载过滤器的顺序
*/
@Override
public int getOrder() {
return 0;
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
测试:
不带参数
带参数