简介
在spring生态上构建的API网关服务,基于spring和Reactor等技术,旨在提供一种简单而有效的方式来对API进行路由以及强大的过滤器功能,如熔断、限流、重试等。它基于WebFlux框架,而webflux底层使用了高性能的Reactor模式通信框架Netty。它为目标提供了统一的路由方式且基于Filter链的方式提供了网关的基本功能如安全、监控指标和限流。
GateWay可以反向代理、鉴权、流量控制、熔断、日志监控······网关一般在负载均衡之后,访问服务前起作用。(ZUUL使用阻塞架构,不支持任何长连接)。
三大核心
-
路由Route:路由是网关的基础模块,它由ID,目标URI,一系列的断言和过滤器注册,断言为true则匹配该路由
-
断言Predicate:参考java8的Predicate,可以匹配HTTP请求的所有内容,如果请求和断言相匹配则进行路由。
-
过滤Filter:GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
工作流程
客户端向gateway发送请求,在Gateway Handler Mapping中找到相匹配的路由,发送到gateway Web Handler。Handler再通过指定的过滤器链来将请求发送到实际的服务执行后再返回。过滤器在pre类型可以做参数校验、权限校验、协议转换等;在post类型可以做响应内容和响应头的修改等。
配置
- yml配置
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- 编码配置
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes(); routes.route("path_rote_atguigu", r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
动态路由
gateway根据注册中心的服务列表,以中心上微服务名为路径创建动态路由进行转发,从而实现动态路由。
修改yml配置:
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名 #uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
注意,uri: lb代表uri的协议为lb,启用负载均衡功能。
断言
#- After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]
#- Cookie=username,zhangshuai #并且Cookie是username=zhangshuai才能访问
#- Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
#- Host=**.ty.com
#- Method=GET
#- Query=username, \d+ #要有参数名称并且是正整数才能路由
过滤器
路由过滤器可修改进入的HTTP请求和返回的HTTP响应,只能指定路由进行使用。内置了多种的过滤器,都由GatewayFilter的工厂类来产生。
自定义过滤器
两个重要接口,GlobalFilter和Ordered
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("*********come in MyLogGateWayFilter: "+new Date());
String uname = exchange.getRequest().getQueryParams().getFirst("username"); if(StringUtils.isEmpty(username)){
log.info("*****用户名为Null 非法用户,(┬_┬)");
//给人家一个回应
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE); return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}