是什么?
spring cloud gateway提供统一的路由方式且基于Filter链的方式提供了网关基本功能,例如:安全,指标/监控,和限流。使用webfluex中的reactor-netty响应式编程组件,底层使用了Netty通信。
特性
- 基于spring framework5,project reactor和spring boot2构建
- 可以对路由指定predicate(断言)和filter(过滤器),并且易于编写
- 集成Hystrix
- 集成spring cloud服务发现功能
- 请求限流功能
- 支持路径重写
三大核心概念
- Route,路由是构建网关的基本模块,它由ID,目标URI,一系列断言和过滤器组成,如果断言为true则匹配该路由
- Predicate,参考java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中所有内容(例如请求头或请求参数),如果请求与断言相匹配,则进行路由。
- Filter,过滤是指Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或之后对请求进行修改。发送给代理之前,可以做参数校验,权限校验,流量控制,日志输出,协议转换;在发送代理之后,可以做响应内容,响应头修改,日志输出,流量监控等。
web请求,通过一些匹配条件,定位到真正的服务节点。并在这个转发过程的前后,进行一些精细化控制。predicate就是匹配条件,filter就是一个拦截器,有了这两个元素,再加上目标URI,就可以实现一个具体的路由了。
配置实现
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh1 #路由ID,没有固定规则,但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/discovery
eureka:
instance:
instance-id: ${spring.application.name}:${server.port}
prefer-ip-address: true
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka/
management:
endpoints:
web:
exposure:
include:
- '*'
代码实现
@Configuration
public class GatewayConifg {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_route_guonei", r -> r.path("/guonei").uri("https://news.baidu.com/guonei")).build();
routes.route("path_route_guoji", r->r.path("/guoji").uri("https://news.baidu.com/guoji")).build();
return routes.build();
}
}
通过微服务名进行动态路由
默认情况下,Gateway会根据注册中心注册服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh1 #路由ID,没有固定规则,但要求唯一,建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由Q地址
uri: lb://cloud-payment-service # 匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
uri: lb://cloud-payment-service
# uri: http://localhost:8001
predicates:
- Path=/payment/discovery
discovery:
locator:
enabled: true
eureka:
instance:
instance-id: ${spring.application.name}:${server.port}
prefer-ip-address: true
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka/
Predicate的使用
- 时间级别:After, Before, Between
After=2020-06-09T23:26:40.434+08:00[Asia/Shanghai]
产生上述带时区的时间字符串
ZonedDateTime zbj = ZonedDateTime.now();
System.out.println(zbj);
- Cookie:不带cookies访问,带cookies访问
Cookie Route Predicate需要两个参数,一个是Cookie name,一个是正则表达式。路由规则会通过获取对应的Cookie name值和正则表达式去匹配,如果匹配上就执行路由,如果没匹配上则不执行。
After=2020-06-09T22:26:40.434+08:00[Asia/Shanghai]
Cookie=username,james
测试curl
curl http://localhost:9527/payment/get/5 --cookie "username=james"
- Header
Header=X-Request-Id, \d+ #请求头要有X-Request-Id属性并且值为正数的正则表达式
测试curl
curl http://localhost:9527/payment/get/5 -H "X-Request-Id: 1"
Filter的使用
路由过滤器可用于修改进入的Http请求和返回的Http响应,路由过滤器只能指定路由进行使用。Spring Cloud GateWay内置了多种路由过滤器,他们都由GatewayFilter的工厂来产生。
- 按生命周期分:pre,post
- 按种类分:GatewayFilter,GlobalFilter
自定义filter实现GlobalFilter,Ordered接口
package com.example.springcloud.filter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
@Override
public int getOrder() {
return 0;
}
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("welcome my house...");
String uname = exchange.getRequest().getQueryParams().getFirst("uname");
if(uname==null) {
log.info("who are you?");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
}