Springcloud Gateway网关

简介

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

Spring Cloud Gateway的目标提供统一的路由方式且基于 Filter链的方式提供了网关基本的功能，例如:安全，监控/指标，和限流。

三大核心概念

• Route(路由) - 路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如断言为true则匹配该路由；
• Predicate(断言) - 参考的是Java8的java.util.function.Predicate，开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由；
• Filter(过滤) - 指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。

工作流程

客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到GatewayWeb Handler。

Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post"）执行业务逻辑。

Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。
核心逻辑：路由转发 + 执行过滤器链。

使用

依赖：

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

路由配置方式1：yml配置

在application.yml添加相关配置，这里添加后就能以localhost:9527/payment/get/31去访问localhost:8001/payment/get/31

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
#############################新增网关配置###########################
  cloud:
    gateway:
      routes:
        - id: payment_routh #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001          #匹配后提供服务的路由地址
          #uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/**         # 断言，路径相匹配的进行路由

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

路由配置方式2：config配置

创建配置类，添加RouteLocator Bean。

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        //访问localhost:[网关port]/guonei时能够转发到http://news.baidu.com/guonei
        routes.route("path_to_baidu",r-> r.path("/guonei")
                                .uri("http://news.baidu.com/guonei")).build();

        return routes.build();
    }
}

配置动态路由:利用一个URL，转发到多个网址

将discovery.locator.enable设置为true，开启动态路由功能。
uri写成注册中心的服务名，当访问网关时，会自动转发到服务提供者的ip上去，类似ribbon的负载均衡。

application.yml

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

        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001          #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
      discovery:
        locator:
          enabled: true   # 开启动态路由功能
####################################################################

路由断言工厂

Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个RoutePredicate工厂可以进行组合。
Spring Cloud Gateway创建Route 对象时，使用RoutePredicateFactory 创建 Predicate对象，Predicate 对象可以赋值给Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories。

简单的说：路由断言工厂能够对请求进行限制，比如请求的时间、域名、cookie，只有符合要求的请求才能得到正确的响应。

常用的Route Predicate Factory

• The After Route Predicate Factory
• The Before Route Predicate Factory
• The Between Route Predicate Factory
• The Cookie Route Predicate Factory
• The Header Route Predicate Factory
• The Host Route Predicate Factory
  更多方法可以访问：https://springdoc.cn/spring-cloud-gateway/#gateway-request-predicates-factories

这里的请求只有在2024-01-08T19:41:00.之后，并且携带name=liu的cookie才能进行访问，否则会返回404。

spring:
  application:
    name: cloud-gateway
  #############################新增网关配置###########################
  cloud:
    gateway:
      routes:
        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001          #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
            - After=2024-01-08T19:41:00.896+08:00[Asia/Shanghai]
            - Cookie=name,liu

过滤器Filter

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生。

生命周期：
pre
post

种类（具体看官方文档）：
GatewayFilter - 有31种
GlobalFilter - 有10种

用途：
全局日志记录
统一网关鉴权
…
官方给的过滤器一般不怎么用，大多时候用自定义的过滤器。

自定义过滤器

过滤掉没有携带uname参数的请求。

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("************come in MyLogfilter");
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");//需要携带uname参数
        if(uname==null){
            log.info("用户名为空，非法");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }

        return chain.filter(exchange);//放行
    }

    @Override
    public int getOrder() { //表示优先级别
        return 0;
    }
}