【SpringCloud】06-服务路由-Gateway

:语雀原文链接

什么是Gatetway

Gateway是在Spring生态系统之上构建的API网关服务，基于Spring5，SpringBoot2和Project Reactor等技术，Gatetway旨在提供一种简单而有效地方式来对API进行路由，以及提供一些强大的过滤器功能，例如：熔断，限流，重试等；

SpringCloud Gatetway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty；

网关位置

Gatetwayway是基于异步非阻塞模型上进行开发的，性能上面不用担心

特性

动态路由：能够匹配任何请求属性
可以对指定Predicate（断言）和Filter（过滤器）
集成Hystrix的断路器功能
集成Springcloud的服务发现功能
易于编写的Predicate（断言）和Filter（过滤器）
请求限流功能
支持路径重写

WebFlux

传统的Web框架，例如strtus2,springmvc等都是基于Servlet API与Servlet容器基础之上运行的；
但是在Servlet3.1之后有了异步非阻塞的支持。而WebFlux是一个典型的非阻塞异步的框架，它的核心是基于Reactor的相关API实现，相对于传统的web框架来说，它可以运行在诸如Netty，Undertow及支持Servlet3.1的容器上，非阻塞式+函数式编程
Spring WebFlux是spring5.0引入的响应式框架，区别于SpringMVC，它不需要依赖Servlet API它是完全异步非阻塞的，并且基于Reactor来实现响应式流规范

Gateway三个重要概念

Route（路由）：路由是构建网关的基本魔模块，它是由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由

Predicate（断言）：开发人员可以匹配HTTP请求中的所有内容（例如请求头或者请求参数），如果请求与断言匹配则进行路由

Filter（过滤）：指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。

web请求，通过一些匹配条件，定位到真正的服务节点，并在这个转发过程的前后，进行一些精细化的控制
Predicate就是我们的匹配条件，而filter，就可以理解为一个无所不能的拦截器，有了这两个元素，再加上目标URI，就可以实现一个具体的路由

核心逻辑：路由转发+执行过滤器链

Gateway项目新建

新建一个cloud-gateway-gateway9527

pom文件主要引入内容：

<!--        gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <!--        eureka client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

application.yml文件

eureka:
instance:
hostname: cloud-gateway-servce
client:
service-url:
#表示是否将自己注册金EurekaServer，默认为true
register-with-eureka: true
#是否从EurekaServer抓取已有的自己的注册信息，默认为true，单节点无所谓，集群必须先设置为true才能配合ribbon使用负载均衡
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka

server:
port: 9527
spring:
application:
    name: cloud-gateway

Gateway网关路由的两种配置方式：
在配置文件yml中配置：

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:
        - id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001 #匹配成功之后提供服务的路由地址
          predicates :
           - Path=/payment/get/** #断言。路径相匹配的进行路由

        - id: payment_routh2 #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001 #匹配成功之后提供服务的路由地址
          predicates:
           - Path=/payment/lb/** #断言。路径相匹配的进行路由

这里配置了两个路由，两种访问方式，两种断言，最终指向访问到8001的服务
所以最后我们可以使用http:localhost:9725/payment/get/id的方式访问各种服务

代码中注入RouteLocator的Bean

@Configuration
public class GateWayConfig {
    /**
    * 配置了一个id为path_route_pojo123的路由规则
    * 当访问地址为http:localhost:9527/guonei时会自动转发到地址：http://news.baidu.com/guonei
    * @param routeLocatorBuilder
    * @return
    */
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes=routeLocatorBuilder.routes();
        routes.route("path_route_pojo123",
                     r->r.path("/guonei")
                     .uri("http://news.baidu.com/guonei"));
        return routes.build();
    }
    
}

新建一个GateWayConfig的配置类，通过配置类对路由进行配置

通过微服务名实现动态路由

默认情况下Gateway会根据祖册中心注册的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能

修改yaml文件：

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 #路由的ID，没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001 #匹配成功之后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
           - Path=/payment/lb/** #断言。路径相匹配的进行路由

启动一个eureka7001+两个服务提供者8001/8002

Predicate（断言）的使用

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。Spring Cloud Gateway包括许多内置的Route Predicate工厂，所有这些Predicate都与HTTP请求不同的属性你匹配。多个RoutePredicate工厂可以进行组合；
path:用于进行路径匹配

• Path=/payment/lb/** #断言。路径相匹配的进行路由

after：用于匹配在此时间之后的

• After=2022-07-07T15:39:49.483+08:00[Asia/Shanghai

before，between也是一样的到道理（between两个时间点之间用逗号分开）

cookies：Cookie Route Predicate需要两个参数，一个是Cookie name，一个是正则表达式。路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行
-Cookie=username，zzyy #匹配cookie名为username，值为zzyy的路径

header：Header头请求匹配，两个参数，一个是属性名和一个正则表达式，这个属性值和正则表达式匹配则执行；
-Header=X-Request-Id，\d+ #请求头要有X-Request-Id属性，并且值为整数的正则表达式；

Host同上

Method：用于匹配请求的方法
-Method：GET #请求方式为Get方式才可以路由

Filter（过滤）的使用

指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由或者之后对请求进行修改，用于修改进入HTTP请求和返回HTTP响应，路由过滤器只能指定路由进行使用。
Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生；

按生命周期来分可以分为前置（pre）和后置（post），按种类来分可以分为GatewayFilter（单一过滤）和GlobalFilter（全局过滤）

使用：
实现GlobalFilter和Ordered接口

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("########come in MylLogGateWayFilter"+new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        
        if (uname==null){
            log.info("#######用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return  exchange.getResponse().setComplete();
        }
        
        return chain.filter(exchange);
    }
    
    @Override
    public int getOrder() {
        return 0;
    }

可以做全局日志记录，统一网关鉴权