springcloud入门系列——Gateway

作为zuul1.x网关的替代品，spring自主编写。

一. 什么是Gateway网关?

• Gateway是在Spring生态系统之上构建的API网关服务,基于Spring 5,Spring Boot 2和Project Reactor等技术。

• Gateway旨在提供一 种简单而有效的方式来对API进行路由，以吸提供- 些强大的过滤器功能， 例如:熔断、限流、重试等

• 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 1.x非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty

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

二. Spring Cloud Gateway具有如下特性

• 基于Spring Framework 5, Project Reactor和Spring Boot 2.0进行构建;
• 动态路由:能够匹配任何请求属性;
• 可以对路由指定Predicate (断言)和Filter (过滤器) ;
• 集成Hystrix的断路器功能;
• 集成Spring Cloud服务发现功能;
• 易于编写的Predicate (断言)和Filter (过滤器) ;
• 请求限流功能;liaoj
• 支持路径重写。

对于GateWay核心原理这里不说，要了解gateway，主要就是其三个重点：
1、断言 2、路由 3、过滤器

先判断一个请求的断言是否符合，符合则通过过滤器过滤掉一些请求，然后再路由到相应的服务接口

下面通过案例说明：

三. 新建module cloud-gateway-gateway9527

pom：

<dependencies>
        <!--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>
        <dependency>
            <groupId>com.cloud</groupId>
            <artifactId>cloud-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </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>

yml：

server:
  port: 9527

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

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


eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:7001/eureka,http://localhost:7002/eureka

启动类：

@SpringBootApplication
@EnableEurekaClient
public class GatewayMain9527 {

    public static void main(String[] args) {
        SpringApplication.run(GatewayMain9527.class,args);
    }
}

由于前面已经建好对于8001端口的访问接口，这里就不再说明，此时我们通过访问http://localhost:9527/payment/get/1

此时网关帮我们路由到http://localhost:8001/payment/get/1。发现测试成功

这时我们来解释下yml中路由的配置：
 

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

其中id可以随便起名，uri：表示如果断言成立，要转发到哪个地址，predicates即断言表示如果请求路径有/payment/get/则进行路由。

这里可以看出，如果我们此时要路由的服务是集群模式，但这里的uri却是要写死的比较不方便，所以gateway还提供了路由到某服务的功能配置（该服务要注册到注册中心中），即lb配置：将ymlgai'w

 gateway:
      routes:
        - id: payment_routh #payment_routh    #路由的ID，没有固定规则但要求唯一，简易配合服务名
          uri: lb://cloud-payment-service  #匹配后提供服务的路由服务
          predicates:
            - Path=/payment/get/**          #断言，路径相匹配的进行路由

此时访问测试成功：

2、gateway常用的断言规则：predicates

2.1：配置时间断言after、before、betwwen

例：表示在该时间之后才可以访问，同理before是之前，betwwen是之间

2.2 Cookie断言

Cookie Route Predicate需要两个参数, 一个是Cookie name ,一个是正则表达式。

路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行

我们除了用浏览器、postman之外，还可以打开cmd窗口利用curl命令进行接口访问：

2.3  Header断言

 - Header=X-Request-Id, \d+ 
 #请求头需要有X-Request-Id属性名,值为整数正则表达式

命令框输入http://localhost:9527/payment/lb -H “X-Request-Id:1234”,负数就直接报错

其他断言就不一一进行举例了。

3、Gateway的filter

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

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用。

Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生

常用的GatewayFilter 有31种之多
全局的Filter也有10种

一般我们使用自定义的filter（主要用于用户鉴权、过滤、全局日志等功能）

3.1自定义gateway的filter

创建Gateway配置类:

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("***************Come in My LogGlobalFilter " + new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if (uname == null) {
            log.info("*******用户名非法,请稍后再试!");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();

        }
        return chain.filter(exchange);
    }
}

这里实现的是,请求进来必须带有uname的参数才可以访问,测试以下

可以写多个Filter进行过滤,传回过滤连就行chain

自定义filter经常被用来用户鉴权和全局日志的处理。至于原理篇后面再写。