gateway学习笔记

概述

官方文档
Spring Cloud Gateway基于Web Flux框架实现，而Web Flux框架底层则使用了高性能的Reactor模式通信框架Netty。目标是提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如安全、监控/指标，限流等。

三大核心概念

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

一句话概述

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

工作流程

• 客户端向SpringCloud Gateway发出请求，然后在GateWay Handler
  Mapping中找到与请求相匹配的路由，将其发送到Gateway Web Hander；
• Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。过滤器之间用虚线分开是因为过滤器可能在发送代理请求之前（“pre”）或之后（“post”）执行业务逻辑
• Filter在“pre”类型的过滤器中可以做参数校验、权限校验、流量监控、日志输出、协议转换等；在“post”类型的过滤器中可以做响应内容、响应头的修改、日志输出、流量监控等有着非常重要的作用。

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

代码示例：

这里通过微服务名实现动态路由
搭建工程cloud-gateway
pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud2020</artifactId>
        <groupId>com.atguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway9527</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--新增gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

yml

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
            #开启从注册中心动态创建路由的功能，利用微服务名称进行路由
          enabled: true
      routes:
        # 路由的id,没有规定规则但要求唯一,建议配合服务名
        - id: payment_route
          #匹配后提供服务的路由地
          uri: lb://CLOUD-PAYMENT-SERVICE   #lb，表示启用Gateway的负载均衡功能
          predicates:
            # 断言，路径相匹配的进行路由
            - Path=/payment/get/**
eureka:
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka1:7001/eureka/
  instance:
    instance-id: gateway9527
    prefer-ip-address: true
    lease-renewal-interval-in-seconds: 10   # 客户端向服务端发送心跳的时间间隔，默认30秒
    lease-expiration-duration-in-seconds: 10    # 服务端在收到最后一次心跳后等待时间上限， 默认90秒， 超时将剔除服务

主启动类

@SpringBootApplication
@EnableEurekaClient
public class GateWayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GateWayApplication.class, args);
    }
}

注册中心 7001端口上 注册了CLOUD-PAYMENT-SERVICE服务 和 CLOUD-GATEWAY当前网关服务

调用8001本身：

调用8002本身：

通过网关9527端口调用：

常用Predicate

官方文档
部分代码示例：
修改yml gateway的配置

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
            #开启从注册中心动态创建路由的功能，利用微服务名称进行路由
          enabled: true
      routes:
        # 路由的id,没有规定规则但要求唯一,建议配合服务名
        - id: payment_route
          #匹配后提供服务的路由地址
          #uri: http://localhost:8001
          uri: lb://CLOUD-PAYMENT-SERVICE   #lb，表示启用Gateway的负载均衡功能
          predicates:
            # 断言，路径相匹配的进行路由
            - Path=/payment/get/**
            - After=2020-08-03T15:45:34.102+08:00[Asia/Shanghai]    # 上海时间2020-08-03 15:45:34 之后的调用才匹配

当前时间 2020-08-03 15:42:53
调用结果：

当前时间 2020-08-03 15:46:00
调用结果：

 predicates:
    # 断言，路径相匹配的进行路由
    - Path=/payment/get/**
    #-After=2020-08-03T15:45:34.102+08:00[Asia/Shanghai]
    #- Before=2017-01-20T17:42:47.789-07:00[America/Denver]
    #- Cookie=username,zzyy
    #- Header=X-Request-Id, \d+ #请求头要有X-Request-Id属性，并且值为正数
    #- Host=**.atguigu.com
    #- Method=GET
    #- Query=username, \d+ # 要有参数名username并且值还要是正整数才能路由

略…

自定义filter

官方文档

Filter分类：Gateway Fliter（单一31种）、Global Filter（全局–10种）

自定义过滤器类实现GlobalFilter，Orderd接口即可
　　
可以全局日志记录、统一网关鉴权

代码示例：

@Component
@Slf4j
public class MyGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        String username = request.getQueryParams().getFirst("username");
        if (username == null) {
            log.error("用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

运行结果：