服务网关-Gateway

一、概念简介

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

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

二、网关作用

反向代理

鉴权

流量监控

熔断

日志监控

...

三、网关在微服务中的位置

外部请求

负载均衡

网关

微服务

四、三大核心概念

Route（路由）

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

Rredicate（断言）

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

Filter（过滤）

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

五、Gateway工作流程

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

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

Filter在pre类型的过滤器可以做校验、权限校验、流量监控、日志输出、协议转换等，在post类型的过滤器中可以做响应内容、响应头的修改、日志的输出，流量监控等有着非常重要的作用。

六、Gateway搭建

6.1 新建Module

新建一个名称为“cloud-gateway-gateway9527”的Module

6.2 改POM

在pom文件中添加“spring-cloud-starter-gateway”引用

<?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>ckfuture-springcloud</artifactId>
        <groupId>com.ckfuture.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway-gateway9527</artifactId>

    <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>
        <!--引入自定定义的api通用包，可以使用Payment支付实体-->
        <dependency>
            <groupId>com.ckfuture.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--热部署devtools-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </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>

注意：gateway的pom中式不需要引入关于web的配置的

<!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

否则网关是启动不起来的，不要问我为什么知道。。。。

6.3 建立YML

新建“application.yml”文件

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url: 
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

6.4 业务类

无

6.5 主启动类

新建“com.ckfuture.springcloud.GateWayMain9527”主启动类

package com.ckfuture.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

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

6.6 网关如何做路由映射？

在YML新增网关配置

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes: 
        - id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          uri: http://localhost:8001 #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/** #断言，路径相匹配的进行路由
        - id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          uri: http://localhost:8001 #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lib/** #断言，路径相匹配的进行路由
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

6.7 测试

依次启动 7001、8001、网关9527

 添加网关前访问“​​http://localhost:8001/payment/get/31​​”

 添加网关后访问“​​http://localhost:9527/payment/get/31​​”

6.8 YML配置说明

gateway网关路由有两种配置方式：

第①种：在配置文件yml中配置，前面步骤

第②种：代码中注入RouteLocator的Bean

 添加“GateWayConfig”配置类，利用@Bean注解在代码中添加路由规则

package com.ckfuture.springcloud.config;

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//在代码中添加网关的路由和断言
@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_route_ckFuture",
                r->r.path("/guonei")
                        .uri("http://news.baidu.com/guonei")).build();
        return routes.build();
    }
    @Bean
    public RouteLocator customRouteLocator2(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_route_ckFuture2",
                r->r.path("/guoji")
                        .uri("http://news.baidu.com/guoji")).build();
        return routes.build();
    }
}

 七、配置动态路由

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

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

修改网关9527的YML文件

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:
        - id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          # uri: http://localhost:8001 #匹配后提供服务的路由地址
          uri: lb://colud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/** #断言，路径相匹配的进行路由
        - id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          # uri: http://localhost:8001 #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/discovery #断言，路径相匹配的进行路由
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

 八、Predicate（断言）的使用

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。

Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与Http请求的不同属性匹配。多个Route Predicate工厂可以进行组合。

Spring Cloud Gateway 创建Route对象时，使用RoutePredicateFactory 创建Predicate对象，Predicate对象可以赋值给Route。Spring Cloud Gateway 包含许多内置的Route Predicate Factories。

所有这些谓词都匹配HTTP请求的不同属性。多种谓词工厂可以组合，并通过逻辑and。

匹配规则：

① After Route Predicate

在设置时间之后有效

② Before Route Predicate

- Before=2020-02-05T15:10:03.685+08:00[Asia/Shanghai]

③ Between Route Predicate

- Between=2020-02-05T15:10:03.685+08:00[Asia/Shanghai],2020-02-05T15:10:03.685+08:00[Asia/Shanghai]

④ Cookie Route Predicate

请求中携带cookie值，键值对形式

⑤ Header Route Predicate

两个参数：一个是属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。

⑥ Host Route Predicate

请求主机规则

⑦ Method Route Predicate

方法形式

⑧ Path Route Predicate

路径，最常用的

⑨ Query Route Predicate

带有查询参数

★ 小总结：

Predicate就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理。

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:
        - id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          # uri: http://localhost:8001 #匹配后提供服务的路由地址
          uri: lb://colud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/** #断言，路径相匹配的进行路由
        - id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名称
          # uri: http://localhost:8001 #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/discovery #断言，路径相匹配的进行路由
            #- Query=username,\d+ #要有参数名username并且值还是整数才能路由
            #- Host=**.ckfuture.com
            #- Method=GET
            #- Header=X-Request-Id,\d+ #请求头要有X-Request-Id属性并且值为整数的正则表达式
            #- Cookie=uesrname,ckfuture
            #- After=2020-02-05T15:10:03.685+08:00[Asia/Shanghai]
            #- Before=2020-02-05T15:10:03.685+08:00[Asia/Shanghai]
            #- Between=2020-02-05T15:10:03.685+08:00[Asia/Shanghai],2020-02-05T15:10:03.685+08:00[Asia/Shanghai]
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

九、Gateway的Filter

 ★自定义全局GlobalFilter过滤器

作用：实现全局日志记录、统一网关鉴权等

创建”MyLogGateWayFilter“类

package com.ckfuture.springcloud.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.Date;

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("***** come in MyLogGateWayFilter:"+new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");//获取查询参数中的”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;
    }
}

每次判断是否携带uname这个参数。

测试

带参数：

 不带参数：