1. 什么是 Spring Cloud Gateway
网关作为流量的入口，常用的功能包括路由转发，权限校验，限流等。
Spring Cloud Gateway 是 Spring Cloud 官方推出的第二代网关框架，定位于取代 Netflix Zuul。相比 Zuul 来说，Spring Cloud Gateway 提供更优秀的性能，更强大的有功能。
Spring Cloud Gateway 是由 WebFlux + Netty + Reactor 实现的响应式的 API 网关。它不能在传统的 servlet 容器中工作，也不能构建成 war 包。
Spring Cloud Gateway 旨在为微服务架构提供一种简单且有效的 API 路由的管理方式，并基于 Filter 的方式提供网关的基本功能，例如说安全认证、监控、限流等等。
官网文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories
1.1 核心概念
路由是网关中最基础的部分，路由信息包括一个 ID、一个目的 URI、一组断言工厂、一组 Filter 组成。如果断言为真，则说明请求的 URL 和配置的路由匹配。
Java8 中的断言函数，SpringCloud Gateway 中的断言函数类型是 Spring5.0 框架中的 ServerWebExchange。断言函数允许开发者去定义匹配 Http request 中的任何信息，比如请求头和参数等。
SpringCloud Gateway 中的 filter 分为 Gateway FilIer 和 Global Filter。Filter 可以对请求和响应进行处理。
1.2 工作原理
Spring Cloud Gateway 的工作原理跟 Zuul 的差不多，最大的区别就是 Gateway 的 Filter 只有 pre 和 post 两种。
客户端向 Spring Cloud Gateway 发出请求，如果请求与网关程序定义的路由匹配，则该请求就会被发送到网关 Web 处理程序，此时处理程序运行特定的请求过滤器链。
过滤器之间用虚线分开的原因是过滤器可能会在发送代理请求的前后执行逻辑。所有 pre 过滤器逻辑先执行，然后执行代理请求；代理请求完成后，执行 post 过滤器逻辑。
2. Spring Cloud Gateway 快速开始
2.1 环境搭建
1) 引入依赖
<!-- gateway网关 --><dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId></dependency>
<!-- nacos服务注册与发现 --><dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency>
复制代码
注意：会和 spring-webmvc 的依赖冲突，需要排除 spring-webmvc
2) 编写 yml 配置文件
server: port: 8888spring: application: name: mall-gateway #配置nacos注册中心地址 cloud: nacos: discovery: server-addr: 127.0.0.1:8848
gateway: discovery: locator: # 默认为false，设为true开启通过微服务创建路由的功能，即可以通过微服务名访问服务 # http://localhost:8888/mall-order/order/findOrderByUserId/1 enabled: true # 是否开启网关 enabled: true
复制代码
3）测试
2.2 路由断言工厂（Route Predicate Factories）配置
https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories
网关启动日志：
2.2.1 时间匹配
可以用在限时抢购的一些场景中。
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 predicates: # 测试：http://localhost:8888/order/findOrderByUserId/1 # 匹配在指定的日期时间之后发生的请求 入参是ZonedDateTime类型 - After=2021-01-31T22:22:07.783+08:00[Asia/Shanghai]
复制代码
获取 ZonedDateTime 类型的指定日期时间
ZonedDateTime zonedDateTime = ZonedDateTime.now();//默认时区// 用指定时区获取当前时间ZonedDateTime zonedDateTime2 = ZonedDateTime.now(ZoneId.of("Asia/Shanghai"));
复制代码
设置时间之前发起请求：
超过设置时间之后再次请求：
2.2.2 Cookie 匹配
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 predicates: # Cookie匹配 - Cookie=username, fox
复制代码
postman 测试
curl 测试
2.2.3 Header 匹配
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 predicates: # Header匹配 请求中带有请求头名为 x-request-id，其值与 \d+ 正则表达式匹配 #- Header=X-Request-Id, \d+
复制代码
测试
2.2.4 路径匹配
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 predicates: # 测试：http://localhost:8888/order/findOrderByUserId/1 - Path=/order/** #Path路径匹配
复制代码
2.2.5 自定义路由断言工厂
自定义路由断言工厂需要继承 AbstractRoutePredicateFactory 类，重写 apply 方法的逻辑。在 apply 方法中可以通过 exchange.getRequest() 拿到 ServerHttpRequest 对象，从而可以获取到请求的参数、请求方式、请求头等信息。
注意： 命名需要以 RoutePredicateFactory 结尾
@Component@Slf4jpublic class CheckAuthRoutePredicateFactory extends AbstractRoutePredicateFactory<CheckAuthRoutePredicateFactory.Config> {
public CheckAuthRoutePredicateFactory() { super(Config.class); }
@Override public Predicate<ServerWebExchange> apply(Config config) { return new GatewayPredicate() {
@Override public boolean test(ServerWebExchange serverWebExchange) { log.info("调用CheckAuthRoutePredicateFactory" + config.getName()); if(config.getName().equals("fox")){ return true; } return false; } }; }
/** * 快捷配置 * @return */ @Override public List<String> shortcutFieldOrder() { return Collections.singletonList("name"); }
public static class Config {
private String name;
public String getName() { return name; }
public void setName(String name) { this.name = name; } }}
复制代码
yml 中配置
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 predicates: # 测试：http://localhost:8888/order/findOrderByUserId/1 - Path=/order/** #Path路径匹配 #自定义CheckAuth断言工厂# - name: CheckAuth# args:# name: fox - CheckAuth=fox
复制代码
2.3 过滤器工厂（ GatewayFilter Factories）配置
SpringCloudGateway 内置了很多的过滤器工厂，我们通过一些过滤器工厂可以进行一些业务逻辑处理器，比如添加剔除响应头，添加去除参数等
https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories
2.3.1 添加请求头
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 #配置过滤器工厂 filters: - AddRequestHeader=X-Request-color, red #添加请求头
复制代码
测试http://localhost:8888/order/testgateway
@GetMapping("/testgateway")public String testGateway(HttpServletRequest request) throws Exception { log.info("gateWay获取请求头X-Request-color：" +request.getHeader("X-Request-color")); return "success";}@GetMapping("/testgateway2")public String testGateway(@RequestHeader("X-Request-color") String color) throws Exception { log.info("gateWay获取请求头X-Request-color："+color); return "success";}
复制代码
2.3.2 添加请求参数
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 #配置过滤器工厂 filters: - AddRequestParameter=color, blue # 添加请求参数
复制代码
测试http://localhost:8888/order/testgateway3
@GetMapping("/testgateway3")public String testGateway3(@RequestParam("color") String color) throws Exception { log.info("gateWay获取请求参数color:"+color); return "success";}
复制代码
2.3.3 为匹配的路由统一添加前缀
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 #配置过滤器工厂 filters: - PrefixPath=/mall-order # 添加前缀 对应微服务需要配置context-path
复制代码
mall-order 中需要配置
server: servlet: context-path: /mall-order
复制代码
测试：http://localhost:8888/order/findOrderByUserId/1 ====》 http://localhost:8020/mall-order/order/findOrderByUserId/1
2.3.4 重定向操作
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 #配置过滤器工厂 filters: - RedirectTo=302, https://www.baidu.com/ #重定向到百度
复制代码
测试：http://localhost:8888/order/findOrderByUserId/1
2.3.5 自定义过滤器工厂
继承 AbstractNameValueGatewayFilterFactory 且我们的自定义名称必须要以 GatewayFilterFactory 结尾并交给 spring 管理。
@Component@Slf4jpublic class CheckAuthGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {
@Override public GatewayFilter apply(NameValueConfig config) { return (exchange, chain) -> { log.info("调用CheckAuthGatewayFilterFactory===" + config.getName() + ":" + config.getValue()); return chain.filter(exchange); }; }}
复制代码
配置自定义的过滤器工厂
spring: cloud: gateway: #设置路由：路由id、路由到微服务的uri、断言 routes: - id: order_route #路由ID，全局唯一 uri: http://localhost:8020 #目标微服务的请求地址和端口 #配置过滤器工厂 filters: - CheckAuth=fox,男
复制代码
测试
2.4 全局过滤器（Global Filters）配置
GlobalFilter 接口和 GatewayFilter 有一样的接口定义，只不过， GlobalFilter 会作用于所有路由。
官方声明：GlobalFilter 的接口定义以及用法在未来的版本可能会发生变化。
2.4.1 LoadBalancerClientFilter
LoadBalancerClientFilter 会查看 exchange 的属性 ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR 的值（一个 URI），如果该值的 scheme 是 lb，比如：lb://myservice ，它将会使用 Spring Cloud 的 LoadBalancerClient 来将 myservice 解析成实际的 host 和 port，并替换掉 ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR 的内容。
其实就是用来整合负载均衡器 Ribbon 的
spring: cloud: gateway: routes: - id: order_route uri: lb://mall-order predicates: - Path=/order/**
复制代码
2.4.2 自定义全局过滤器
@Component@Order(-1)@Slf4jpublic class CheckAuthFilter implements GlobalFilter { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { //校验请求头中的token List<String> token = exchange.getRequest().getHeaders().get("token"); log.info("token:"+ token); if (token.isEmpty()){ return null; } return chain.filter(exchange); }}
@Componentpublic class CheckIPFilter implements GlobalFilter, Ordered {
@Override public int getOrder() { return 0; }
@Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { HttpHeaders headers = exchange.getRequest().getHeaders(); //模拟对 IP 的访问限制，即不在 IP 白名单中就不能调用的需求 if (getIp(headers).equals("127.0.0.1")) { return null; } return chain.filter(exchange); }
private String getIp(HttpHeaders headers) { return headers.getHost().getHostName(); }}
复制代码
2.5 Gateway 跨域配置（CORS Configuration）
通过 yml 配置的方式
https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#cors-configuration
spring: cloud: gateway: globalcors: cors-configurations: '[/**]': allowedOrigins: "*" allowedMethods: - GET - POST - DELETE - PUT - OPTION
复制代码
通过 java 配置的方式
@Configurationpublic class CorsConfig { @Bean public CorsWebFilter corsFilter() { CorsConfiguration config = new CorsConfiguration(); config.addAllowedMethod("*"); config.addAllowedOrigin("*"); config.addAllowedHeader("*");
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser()); source.registerCorsConfiguration("/**", config);
return new CorsWebFilter(source); }}
复制代码
2.6 gateway 整合 sentinel 限流
这块单独分析，涉及网关规则持久化，sentinel dashboard 源码改造。思考：网关流控实现原理是什么？
2.7 网关高可用
为了保证 Gateway 的高可用性，可以同时启动多个 Gateway 实例进行负载，在 Gateway 的上游使用 Nginx 或者 F5 进行负载转发以达到高可用。
评论