文章目录
- 前言
- 一、Zuul与Gateway的关系和区别
- 二、.Spring Cloud Gataway的特点
- 三、Spring Cloud Gataway的核心概念Spring Cloud Gataway有几个核心组成:
- 四、.Spring Cloud Gateway的执行流程
- 五,Spring Cloud Gataway代码实现
- 六,Predicate断言工厂
- 1.什么是断言工厂
- 2.根据查询参数断言- Query Route Predicate Factory
- 3.根据path断言-Path Route Predicate Factory
- 4.根据权重比例断言-Weight Route Predicate Factory
- 5.根据远程ip断言 - RemoteAddr Route Predicate Factory
- 6.指定时间之后断言-After Route Predicate Factory
- 7.在指定时间之前断言-Before Route Predicate Factory
- 8.在指定时间段之间断言-Between Route Predicate Factory
- 9.根据cookie断言-Cookie Route Predicate Factory
- 10.根据请求头断言-Header Route Predicate Factory
- 11.根据主机断言-Host Route Predicate Factory
- 12.根据请求方式断言-Method Route Predicate Factory
- 七,Gateway 的 Filter 过滤器
- 八、Gateway跨域配置
- 九、Gateway超时
- 总结
前言
接着上章【spring cloud - zuul服务网关】,继续学习SpringCloudGateway-服务网关
一、Zuul与Gateway的关系和区别
Zuul是Netflix的开源项目,Spring Cloud将其收纳成为自己的一个子组件。zuul用的是多线程阻塞模型,它本质上就是一个同步 Servlet,这样的模型比较简单,他都问题是多线程之间上下文切换是有开销的,线程越多开销就越大。线程池数量固定意味着能力接受的请求数固定,当后台请求变慢,面对大量的请求,线程池中的线程容易被耗尽,后续的请求会被拒绝。
在Zuul 2.0中它采用了 Netty 实现异步非阻塞编程模型,异步非阻塞模式对线程的消耗比较少,对线程上线文切换的消耗也比较小,并且可以接受更多的请求。它的问题就是线程模型比较复杂,要求深究底层原理需要花一些功夫。
Spring Cloud Gateway是Spring Cloud自己的产物,基于Spring 5 和Spring Boot 2.0 开发,Spring Cloud Gateway的出现是为了代替zuul,在Spring Cloud 高版本中没有对zuul 2.0进行集成,SpringCloud Gateway使用了高性能的Reactor模式通信框架Netty。
Spring Cloud Gateway 的目标,不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控/指标,和限流。
二、.Spring Cloud Gataway的特点
在Spring Cloud官方定义了SpringCloud Gateway 的如下特点:
- 基于 Spring 5,Project Reactor , Spring Boot 2.0
- 默认集成 Hystrix 断路器
- 默认集成 Spring Cloud DiscoveryClient
- Predicates 和 Filters 作用于特定路由,易于编写的 Predicates 和 Filters
- 支持动态路由、限流、路径重写
三、Spring Cloud Gataway的核心概念Spring Cloud Gataway有几个核心组成:
- Filter(过滤器):
Spring Cloud Gateway的Filter和Zuul的过滤器类似,可以在请求发出前后进行一些业务上的处理 ,这里分为两种类型的Filter,分别是Gateway Filter网关filter和Global Filter全局Filter, 他们的区别在后续会讲到。
- Route(路由):
网关配置的基本组成模块,和Zuul的路由配置模块类似。一个Route模块由一个 ID,一个目标 URI,一组断言和一组过滤器定义。如果断言为真,则路由匹配,目标URI会被访问。说白了就是把url请求路由到对应的资源(服务),或者说是一个请求过来Gateway应该怎么把这个请求转发给下游的微服务,转发给谁。
- Predicate(断言):
这是一个 Java 8 的 Predicate,可以使用它来匹配来自 HTTP 请求的任何内容,例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。简单理解就是处理HTTP请求的匹配规则,在什么样的请情况下才能命中资源继续访问。
四、.Spring Cloud Gateway的执行流程
相比于zuul,Gateway 的 Filter 只有 pre 和 post 两种,官方的执行流程图:
客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射确定请求与路由匹配,则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链来运行请求。筛选器由虚线分隔的原因是,筛选器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后,将运行“后”过滤器逻辑。
五,Spring Cloud Gataway代码实现
1.创建工程导入依赖
工程名:springcloud-gateway-server 端口:1060 ,导入gataway基础依赖
代码如下(示例):
<!--服务注册与发现-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
2. 配置启动类
@SpringBootApplication
public class GatewayApplication
{
public static void main( String[] args )
{
SpringApplication.run(GatewayApplication.class, args);
}
}
3.yml配置
server:
port: 1060 # 端口
eureka:
client:
serviceUrl:
defaultZone: http://localhost:1010/eureka/ #注册地址
instance:
prefer-ip-address: true #使用ip注册到Eureka
instance-id: gateway-server #指定客户端实例的ID
spring:
application:
name: gateway-server # 客户端名字
cloud:
gateway:
discovery:
locator:
enabled: false #开放服务名访问方式
lower-case-service-id: true #服务名小写
routes:
- id : application-user #指定服务名
uri: lb://user-server #去注册中心找这个服务名
predicates: #断言,匹配访问的路径
- Path=/user/** #服务访问路径
filters:
- StripPrefix=1 #请求转发的时候会去掉 /user访问路径
这里除了要注册到Eureak以外,还需要配置Gataway的路由
- spring.cloud.gateway.discovery.locator.enabled=false: 不开放服务名访问方式
- spring.cloud.gateway.discovery.locator.lower-case-service-id: true 忽略服务名大小写,大写小写都可以匹配
- spring.cloud.gateway.routes.id : 指定了路由的服务名,可以自己定义
- spring.cloud.gateway.routes.uri=lb://user-server : 去注册中心找服务,采用负载均衡的方式请求。其实就是找要调用的服务。
- spring.cloud.gateway.routes.predicates: 断言,这里使用的Path=/user/**,即匹配访问的路径如果匹配/user/就可以将请求路由(分发)到user-server这个服务上。
- spring.cloud.gateway.routes.filters :这里使用StripPrefix=1主要是处理前缀 /user ,访问目标服务的时候会去掉前缀访问。这个需要根据url情况来定义。
六,Predicate断言工厂
1.什么是断言工厂
什么是断言工程,在Spring Cloud Gateway官方文档有如下解释:
Spring Cloud Gateway将路由作为Spring WebFlux HandlerMapping基础架构的一部分进行匹配。Spring Cloud Gateway包括许多内置的路由断言工厂。所有这些断言都与HTTP请求的不同属性匹配。您可以将多个路由断言工厂与逻辑and语句结合使用。
这里不难理解,其实断言工厂就是用来判断http请求的匹配方式。比如我们再上面案例中配置的:“Path=/user/**” ,就是使用的是 “Path Route Predicate Factory” 路径匹配工厂,意思是http请求的资源地址必须是 /user 才会被匹配到对应的路由,然后继续执行对应的服务获取资源。
在Spring Cloud Gateway中,针对不同的场景内置的路由断言工厂,比如
- Query Route Predicate Factory:根据查询参数来做路由匹配
- RemoteAddr Route Predicate Factory:根据ip来做路由匹配
- Header Route Predicate Factory:根据请求头中的参数来路由匹配
- Host Route Predicate Factory:根据主机名来进行路由匹配
- Method Route Predicate Factory :根据方法来路由匹配
- Cookie Route Predicate Factory:根据cookie中的属性值来匹配
- Before Route Predicate Factory:指定时间之间才能匹配
- After Route Predicate Factory: 指定时间之前才能匹配
- Weight Route Predicate Factory: 根据权重把流量分发到不同的主机
2.根据查询参数断言- Query Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: query_route
uri: https://example.org
predicates:
- Query=green
3.根据path断言-Path Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: path_route
uri: https://example.org
predicates:
- Path=/red/{segment},/blue/{segment}
4.根据权重比例断言-Weight Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: weight_high
uri: https://weighthigh.org
predicates:
- Weight=group1, 8
- id: weight_low
uri: https://weightlow.org
predicates:
- Weight=group1, 2
5.根据远程ip断言 - RemoteAddr Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: remoteaddr_route
uri: https://example.org
predicates:
- RemoteAddr=192.168.1.1/24
如果请求的远程地址为 192.168.1.1到192.168.1.24之间,则此路由匹配
6.指定时间之后断言-After Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: after_route
uri: https://example.org
predicates:
- After=2017-01-20T17:42:47.789-07:00[America/Denver]
7.在指定时间之前断言-Before Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: before_route
uri: https://example.org
predicates:
- Before=2017-01-20T17:42:47.789-07:00[America/Denver]
8.在指定时间段之间断言-Between Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: between_route
uri: https://example.org
predicates:
- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]
9.根据cookie断言-Cookie Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: cookie_route
uri: https://example.org
predicates:
- Cookie=chocolate, ch.p
10.根据请求头断言-Header Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: header_route
uri: https://example.org
predicates:
- Header=X-Request-Id, \d+
11.根据主机断言-Host Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: host_route
uri: https://example.org
predicates:
- Host=**.somehost.org,**.anotherhost.org
如果请求的主机头具有值.somehost.org,或者.anotherhost.org这匹配路由
12.根据请求方式断言-Method Route Predicate Factory
spring:
cloud:
gateway:
routes:
- id: method_route
uri: https://example.org
predicates:
- Method=GET,POS
只允许 GET和POST请求
七,Gateway 的 Filter 过滤器
Gateway的Filter的zuul的Filter有相似之处,与zuul不同的是,Gateway的filter从生命周期上可以为“pre”和“post”类型。根据作用范围可分为针对于单个路由的gateway filter,和针对于所有路由的Global Filer
1.内置的Gateway filter
以配置AddRequestHeader GatewayFilter Factory为例,该Filter是Gateway内置的,它的作用是在请求头加上指定的属性,
配置:
spring:
cloud:
gateway:
routes:
- id: add_request_header_route
uri: https://example.org
filters:
- AddRequestHeader=X-Request-red, blue
在spring.cloud.gateway.routes.filters配置项配置了一个AddRequestHeader ,他是“AddRequestHeader GatewayFilter Factory”的名称,意思是在请求头中添加一个“X-Request-red”的属性,值为blue 。
其他的Filter可以去看 AbstractGatewayFilterFactory 的实现类。
2.自定义Gateway Filter
在Spring Cloud Gateway自定义过滤器,过滤器需要实现GatewayFilter和Ordered这两个接口。
以下例子:自定义filter计算请求的耗时
// 计算请求的时间
public class RequestTimeFilter implements GatewayFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 获取请求开始时间
long time = new Date().getTime();
return chain.filter(exchange).then(
Mono.fromRunnable(() -> {
// 获取请求完成时间
Long newtime =new Date().getTime();
// 计算请求时间差
long t= newtime - time;
System.out.println(exchange.getRequest().getURI().getRawPath()+":"+t);
})
);
}
@Override
public int getOrder() {
// filter执行顺序
return 0;
}
}
提示: getOrder返回filter的优先级,越大的值优先级越低
还需要把该Filter配置在对应的路由上,配置如下:
@Configuration
public class FilterConfig {
//配置Filter作用于那个访问规则上
@Bean
public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
return builder.routes().route(r -> r.path("/service/user/**")
//去掉2个前缀
.filters(f -> f.stripPrefix(2)
.filter(new RequestTimeFilter())
.addResponseHeader("X-Response-test", "test"))
// 作用于那个服务
.uri("lb://user-service")
.order(0)
.id("test-RequestTimeFilter")
).build();
}
}
3.自定义GlobalFilter
GlobalFilter:全局过滤器,不需要在配置文件中配置,作用在所有的路由上,最终通过GatewayFilterAdapter包装成GatewayFilterChain可识别的过滤器,它为请求业务以及路由的URI转换为真实业务服务的请求地址的核心过滤器,不需要配置,系统初始化时加载,并作用在每个路由上。
案例:模拟了一个登陆检查的Filter
代码实现:
@Component
public class loginGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 获取请求对象
ServerHttpRequest request = exchange.getRequest();
// 获取请求头中的的token
List<String> token = request.getHeaders().get("token");
// 判断token是否有值,若为空,则响应一个错误信息
if (token == null || token.size() == 0) {
// 获取响应对象
ServerHttpResponse response = exchange.getResponse();
DataBuffer buffer = null;
try {
byte[] bytes = "去登录!".getBytes("utf-8");
buffer = response.bufferFactory().wrap(bytes);
//设置完成相应,不会继续执行后面的filter
//response.setComplete();
response.setStatusCode(HttpStatus.UNAUTHORIZED);
response.getHeaders().add("Content-Type","application/json;charset=UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
//把结果写给客户端
return response.writeWith(Mono.just(buffer));
}
// 放行
return chain.filter(exchange);
}
@Override
public int getOrder() {
// 执行顺序
return 0;
}
}
八、Gateway跨域配置
所谓的跨域是因为浏览器的同源(同一个域)策略限制,其实就是同源策略会阻止一个域的javascript脚本和另外一个域的内容进行交互 ,在前后端分离的项目架构中就会出现跨域问题,因为Gateway 网关是微服务的访问入口,所以我们只需要在Gateway配置跨域
spring:
cloud:
globalcors: #跨域配置
cors-configurations:
'[/**]':
allowedOrigins: "https://docs.spring.io" #允许的站点
allowedMethods: #允许的请求方式
- GET
- POST
- DELETE
- PUT
- HEAD
- CONNECT
- TRACE
- OPTIONS
allowHeaders: #允许的请求头
- Content-Type
九、Gateway超时
超时配置在微服务调用和数据读取的时候显得尤为重要,下面演示Gateway中的全局超时设置:
spring:
cloud:
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s
指定路由超时配置:
spring:
cloud:
gateway:
routes:
- id: per_route_timeouts
uri: https://example.org
predicates:
- name: Path
args:
pattern: /delay/{timeout}
metadata:
response-timeout: 200
connect-timeout: 200
总结
对 SpringCloudGateway-服务网关 的基础知识学习和掌握基本使用