spring-cloud学习六-gateway网关

1 gateway概述

1.1 gateway简介

SpringCloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

SpringCloud Gateway 作为 Spring Cloud 生态系统中的网关，目标是替代 Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Zuul 2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 2.0之前的非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

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

1.2 gateway三大核心概念

1.2.1 路由(Route)

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

1.2.2 断言(predicate)

参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由

1.2.3 过滤(filter)

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

1.3 gateway工作流程

客户端像Gateway发出请求。然后Gateway Handler Mapping中找到与请求相匹配的路由，将其发送给Gateway Web Handler。

Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前或之后执行业务逻辑。

filter在请求之前可以做参数校验，权限校验，流量监控，日志输出，协议转换等等，在请求之后可以做响应内容、响应头的修改，日志输出，流量监控等，这个过滤器作用还是很大的。

2 快速入门案例

2.1 gateway搭建

2.1.1 maven依赖

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!-- 监控管理模块 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

2.1.2 配置文件

server:
  port: 9527

spring:
  application:
    name: gateway

  cloud:
    gateway:
      routes:
        - id: payment_route # 路由id，没有固定但要求唯一，建议配合服务名
          uri: http://localhost:8001 # 匹配后提供的路由服务地址
          predicates:
            - Path=/payment/get* # 断言，路径匹配的进行路由
eureka:
  instance:
    prefer-ip-address: true # 注册服务的时候使用服务的ip地址，需要引入web和actuator包
    instance-id: gateway${server.port} # 自定义服务名称信息，需要引入web和actuator包
  client:
    service-url:
      defaultZone: http://localhost:7002/eureka/,http://localhost:7001/eureka/
    fetch-registry: true #从eureka上来获取服务的注册信息
    register-with-eureka: true #把自己注册到eureka上

2.1.3 访问测试

http://localhost:9527/payment/get?id=1

2.1.4 动态路由配置

spring:
  application:
    name: gateway

  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 开启从注册中心动态创建路由的功能
      routes:
        - id: payment_route # 路由id，没有固定但要求唯一，建议配合服务名
          uri: lb://payment # payment是微服务在网关上的注册名
          predicates:
            - Path=/payment/get* # 断言，路径匹配的进行路由

访问同上

2.1.5 常用的Predicate

          predicates:
            - Path=/payment/get* # 断言，路径匹配的进行路由
#            - After=2020-05-16T22:36:30.506+08:00[Asia/Shanghai] # 这个时间之后接口才可以访问，Before和Between(,隔开)类似
#            - Cookie=name,zhangsan # 需要携带"name=zhangsan"的cookie kv键值对才能访问
#            - Header=X-Request-Id,\d+ # 请求头要有X-Request-Id值并且为整数才能访问
#            - Method=GET # 仅允许get请求
#            - Query=name, \d+ # 参数名要有name并且是数字的请求
#            - Host=**at.guigu.com # host后缀要是at.guigu.com

2.1.6 自定义过滤器

@Component
public class LogFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("访问" + exchange.getRequest().getPath());
        return chain.filter(exchange);
        // 拒绝访问
//        exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
//        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        // 过滤器加载顺序，数字越小，优先级越高
        return 0;
    }
}