Gateway是什么
Gateway使用的是Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架。Spring Cloud Gateway作为Spring Cloud生态系中的网关,目标是替代ZUUL,其不仅提供统一的路由方式,并且基于Filter链的方式提供了网关基本的功能,例如:安全,监控/埋点,和限流等。
Gateway三个核心概念
Route(路由):路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如断言为true则匹配该路由。
Predicate(断言):参考的是Java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由。
Filter(过滤):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
Gateway工作流程
客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到Gateway Web Handler。
Handler再通过指定的过滤器链来讲请求发送到我们实际的服务执行业务逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑。
Filter 在 “pre” 类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等;在 “post” 类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等,有着非常重要的作用
Gateway Predicate(断言)简单使用
配置文件方式
server:
port: 9527
spring:
application:
name: cloud-gateway-9527
cloud:
gateway:
routes:
- id: baidu
uri: https://news.baidu.com/guonei
predicates: #以下Predicate 可配合使用
- After=2020-05-27T15:53:35.943+08:00[Asia/Shanghai] #在这个时间后才会匹配 是通过ZonedDateTime进行时间比较
- Before=2020-05-27T15:53:35.943+08:00[Asia/Shanghai] #在这个时间前才会匹配
- Between=2018-01-20T06:06:06+08:00[Asia/Shanghai], 2020-05-27T15:53:35.943+08:00[Asia/Shanghai] #在这个时间段之间才会匹配
- Cookie=name, tom #两个参数,一个是 Cookie name , 一个是正则表达式
- X-Request-Id, \d+ #两个参数,一个 header 中属性名称和一个正则表达式
- Host=**.host.com #一组参数,一组匹配的域名列表,这个模板是一个 ant 分隔的模板,用.号作为分隔符
- Method=GET #通过是 POST、GET、PUT、DELETE 等不同的请求方式来进行路由
- Path=/guonei #匹配路径的参数进行路由
- Query=name, \d+ #两个参数,一个是属性名一个为属性值,属性值可以是正则表达式。
- RemoteAddr=192.168.1.1/24 #通过设置某个 ip 区间号段的请求才会路由
代码中注入RouteLocator的Bean实现路由
@Configuration
public class GatewayConfig {
@Bean
public RouteLocator gateRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
return routeLocatorBuilder.routes().route("baidu_guoji",r -> r.path("/guoji").uri("http://news.baidu.com/guoji")).build();
}
}
Gateway 通过服务名实现动态路由
spring:
application:
name: cloud-gateway-9527
cloud:
gateway:
discovery:
locator:
enabled: true #从服务中心动态创建路由,利用微服务进行路由
routes:
- id: provider_route
uri: lb://cloud-provider #uri的协议lb,表示启用Gateway的负载均衡功能
predicates:
- Path=/provider/**
Gateway Filter
SpringCloud Gateway的 Filter,生命周期有 pro 和 post,种类有GatewayFilter 和GlobalFilter。SpringCloud Gateway内置了多种路由过滤器,常用的GatewayFilter 有31种之多,GlobalFilter 有10个。
内置Filter可参考官网案例
GatewayFilter
GlobalFilter
如何自定义全局GlobalFilter
需实现GlobalFilter,OrderId接口
@Component
public class MyGatewayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
String name = request.getQueryParams().getFirst("name");
if (name==null){
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE); //返回错误状态码406
return exchange.getResponse().setComplete();
}
return chain.filter(exchange); //放行
}
/**
* 值越小,优先级越高
* @return
*/
@Override
public int getOrder() {
return 0;
}
}