开发笔记:springcloudgateway概念精讲

一、定义

外部请求通过gateWay转发到后端微服务,网关一般提供如下功能

1. 统一接入&＃xff0c;路由转发
2. 安全审查&＃xff0c;校验鉴权
3. 熔断降级&＃xff0c;数据缓存
4. 统一日志&＃xff0c;全局监控

总的来说&＃xff0c;gateway提供了一个入口来管控所有的微服务&＃xff0c;基于这个特点可以灵活使用。

网关解决方案对比

nginx&＃43;lua 高性能反向代理服务器&＃xff0c;一般作为负载均衡入口

Zuul是第一代网关&＃xff0c;spring

cloud是第二代网关&＃xff0c;基于Netty\\Reactor\\WebFLux构建

• 性能强劲&＃xff0c;zuul1.6倍
• 功能强大&＃xff0c;内置转发&＃xff0c;监控&＃xff0c;限流等功能

缺点

• 不能再servlet容器下功能&＃xff0c;不能使用war包

基础说明

1. spring cloud gateway基于springBoot2.x系列&＃xff0c;webflux&＃xff0c;reactor等技术&＃xff0c;传统的同步库都是不能使用的
2. gateway底层依赖netty,不接受servlet容器或者war包

二、核心术语

Route路由

基础的转发规则&＃xff0c;包含下面几部分&＃xff0c;当predicate满足时则代表匹配

• id
• 目标url
• predicate集合&＃xff1a;满足条件才转发
• filter集合&＃xff1a;满足条件则过滤&＃xff08;改变请求&＃xff09;

Predicate谓词、断言

java.util.funcation.Predicate实现路由匹配条件&＃xff0c;通过ServletWebExchange(封装了HTTP请求和相应)作为入参&＃xff0c;来对request的各种属性&＃xff08;参考predicate的各种规则&＃xff09;做匹配。

Filter过滤器

修改请求及响应

gateway已经为了我们准备了各种过滤器工厂,我们也可以通过自定义过滤器

三、简单原理

1. client发送请求给gateway,handlermapping判断请求路径是否匹配路由配置
2. 如果匹配成功web handler会读取路由配置过滤器&＃xff0c;把请求交给过滤器处理
3. 过滤器如图是链式结构&＃xff0c;分为pre和post处理

四、概念讲解

Route Predcate Factories

符合Predicate的条件&＃xff0c;就使用该路由的配置&＃xff0c;否则就不管。

https://www.imooc.com/article/290804

配置形式

模糊匹配和精确匹配

路由到指定URL

spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: http://www.itmuch.com


表示访问 GATEWAY_URL/** 会转发到 http://www.itmuch.com/**
需要和predicate配合使用&＃xff0c;满足条件则转发

spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/


表示访问 GATEWAY_URL/spring-cloud/spring-cloud-stream-pan-ta/ 会转发到 http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/

路由转发到微服务

路由到服务发现组件上的微服务

routes:
- id: user_route
uri: lb://user-center
predicates:
- Path&＃61;/users/**


浏览器访问 网关url时&＃xff0c;http://localhost:8040/users/1会自动转发到user-center服务的接口&＃xff0c;等同于访问http://localhost:9099/users/1

自定义predicate工厂

xxxxRoutePredicateFactory必须以这种形式结尾

routes:
- id: after_route
uri: lb://user-center
predicates:
# 当且仅当请求时的时间After配置的时间时&＃xff0c;才会转发到用户微服务
# 目前配置不会进该路由配置&＃xff0c;所以返回404
# 将时间改成 user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- After&＃61;2010-01-20T17:42:47.789-07:00[America/Denver]
- TimeBetween&＃61;00:00:00,12:44:13


&＃64;Data
public class TimeBetweenBean {
private String start;
private String end;
}



&＃64;Component
public class TimeBetweenRoutePredicateFactory
extends AbstractRoutePredicateFactory {
public TimeBetweenRoutePredicateFactory() {
super(TimeBetweenBean.class);
}
/**
* 谓词工厂的核心方法&＃xff0c;控制路由的判断人条件
* &＃64;param config
* &＃64;return
*/
&＃64;Override
public Predicate apply(TimeBetweenBean config) {
String start &＃61; config.getStart();
String end &＃61; config.getEnd();
return serverWebExchange ->{
LocalTime now &＃61; LocalTime.now();
System.out.println(now.isAfter(LocalTime.parse(start)));
return now.isAfter(LocalTime.parse(start)) && now.isBefore(LocalTime.parse(end));
};
}
/**
* 控制配置类和配置文件映射关系,和配置文件顺序一致
* &＃64;return
*/
&＃64;Override
public List shortcutFieldOrder() {
return Arrays.asList("start","end");
}
}


动态路由-服务名称转发
面向服务的路由&＃xff0c;支持整合EUREKA或者NACOS注册中心&＃xff0c;根据serviceId自动从注册中心获取服务地址并转发请求。不需要给每个微服务都配置路由规则

discovery:
locator:
enabled: true # 开启从注册中心动态创建路由


例子&＃xff1a;
http://localhost:8001/payment/get/1?uname&＃61;123
http://localhost:9527/cloud-payment-service/payment/get/1?uname&＃61;123

三、Filter

生命周期

• Pre:转发请求之前
• post:转发请求之后

gateway自带过滤器讲解

1. RewritePath 请求地址重定向

按照正则匹配上的路径重写为逗号后面的地址

pring:
cloud:
gateway:
routes:
- id: rewritepath_route
uri: https://example.org
predicates:
- Path&＃61;/red/**
filters:
- RewritePath&＃61;/red/?(?.*), /$\\{segment}


注&＃xff1a;效果是去掉/red

2. PrefixPath 添加前缀

给请求路径添加前缀

spring:
cloud:
gateway:
routes:
- id: prefixpath_route
uri: https://example.org
filters:
- PrefixPath&＃61;/mypath


3. StripPrefix 删除前缀

删除请求的指定个数前缀后添加到服务末尾

spring:
cloud:
gateway:
routes:
- id: nameRoot
uri: https://nameservice
predicates:
- Path&＃61;/name/**
filters:
- StripPrefix&＃61;2


例如&＃xff1a;请求路径/name/blue/red&＃xff0c;实际效果 nameservice/red

全局过滤器GlobalFilter

无需配置文件作用在所有的路由&＃xff0c;最终通过gatewayfilterAdapter包装为过滤器

自定义过滤器工厂

• 继承AbstractGateWayFilterFactory
• 继承AbstractNameValueGatewayFilterFactory
  第一种方式的简化方式

自定义网关过滤器

&＃64;Component
&＃64;Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
&＃64;Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("**** com int mylogglbalfiltert{}",new Date());
String uname &＃61; exchange.getRequest().getQueryParams().getFirst("uname");
if(uname&＃61;&＃61;null){
log.info("非法用户");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE); //返回状态码
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
&＃64;Override
public int getOrder() {
return 0;
}
}


注册过滤器

&＃64;Configuration
public class GateWayConfig {
&＃64;Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
RouteLocatorBuilder.Builder routes &＃61; routeLocatorBuilder.routes();
routes.route("path_route_kouryoushine",
r->r.path("guonei").
uri("http://news.baidu.com/guonei")).build();
return routes.build() ;
}
}


全局过滤器

无需注册操作&＃xff0c;默认直接生效

核心API

• exchange.getRequest().mutate().xxx 修改request
• exchange.mutate.xxx 修改exchange
• chain.filter(exchange) 传递给下一个过滤器
• exchange.getResponse() 获取响应

配置文件

filters:
- AddRequestHeader&＃61;X-Request-Foo,Bar
- PreLog&＃61;a,b


&＃64;Slf4j
&＃64;Component
public class PreLogGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {
&＃64;Override
public GatewayFilter apply(NameValueConfig config) {
log.info("请求建立了{}{}",config.getName(),config.getValue());
return (exchagne,chain)->{
log.info("请求建立了{}{}",config.getName(),config.getValue());
ServerHttpRequest request &＃61; exchagne.getRequest()
.mutate()
.build();
ServerWebExchange exchange &＃61; exchagne.mutate()
.request(request)
.build();
return chain.filter(exchange);
};
}
}


全局过滤器

order越小有效执行
局部过滤器按照配置顺序执行
如果想自行控制order,返回OrderedGateFilter

全局监控

查看全局过滤器
http://localhost:8040/actuator/gateway/globalfilters

• routes展示路由列表

其他监控包括动态增加路由都可以百度