springcloud之Gateway

spring cloud
字数统计: 2.1k   |   阅读时长≈ 8 分钟

springcloud学习笔记，第7章，Gateway微服务网关。

gateway：n.大门口; 门道; 出入口; (通往其他地区的) 门户; 途径; 方法; 手段;

简介：

Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的API接入层。

SpringCloud Gateway是Spring cloud的一个全新项目，基于spring 5.0+springboot 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链的方式提供了网关基本的功能，例如：安全，监控/指标，限流。

源码架构：

能干什么？

  1. 反向代理
  2. 鉴权
  3. 流量控制
  4. 熔断
  5. 日志监控

gateway在那一层呢？

Gateway与Zuul的区别：

我们为什么选择Gateway：

  1. Netflix不太靠谱，zuul2.0一直跳票，迟迟不发布

  2. Spingcloud gateway具有如下特性：

  3. springcloud gateway与zuul的区别：

zuul1.x模型：

webFlux是什么：

Gateway的三大核心概念：

route路由

路由是构建网关的基本模块，他由ID，目标URI(统一资源标识符)一系列的断言和过滤器组成，如果断言为true则匹配该路由。就是根据某些规则将请求发送到指定服务上。

predicate断言

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

filter过滤

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

总体来说就是：

Gateway工作流程：

解释上图：客户端spring cloud gateway发出请求。然后gateway handler mapping中找到与请求相匹配的路由，将其发送到gateway web handler。

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

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

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

使用Gateway入门配置：

项目结构：

新建实例：

  1. 建moudle，cloud-gateway-gateway9527

  2. POM

    不要web依赖模块，否则不能正常启动

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    <!--不要web依赖模块-->
    <!--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通用包-->
    <dependency>
        <groupId>org.example</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>${project.version}</version>
    </dependency>
    <!--一般基础通用配置-->
    <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>

  3. YML

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    server:
      port: 9527

    spring:
      application:
        name: cloud-gateway
      # 这些网关配置就是在配置8001的端口访问
      cloud:
        gateway:
          routes:
            - id: payment_routh
              uri: http://localhost:8001
              predicates:
                - Path=/payment/get/**

            - id: payment_routh2
              uri: http://localhost:8001
              predicates:
                - Path=/payment/create

    eureka:
      instance:
        hostname: cloud-gateway-service
      client:
        register-with-eureka: true  #false表示不向注册中心注册自己
        fetch-registry: true #false表示自己端就是注册中心
        service-url:
          defaultZone: http://localhost:7001/eureka/

  4. 主启动类

  5. 9527网关如何做路由映射？

    • cloud-provider-payment8001看看controller的访问地址

    • 我们目前不想暴露8001端口，希望在8001外面套一层9527

  6. YML新增网关配置

  7. 测试

    1. 启动7001，启动8001，启动9527网关

    那么这样就可以通过9527网关端口去访问8001里面的服务了。

Gateway配置路由的两种配置方式：

  1. 在配置文件yml中配置。前面使用的就是这种方式
  2. 代码中注入RouteLocator的Bean
    • 配置一个id为route-name的路由规则，当访问地址为http://localhost:9527/guonei时会自动转发到地址：http://news.baidu.com/guonei

1
2
3
4
5
6
7
8
9
10
11
@Configuration
public class GatewayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_routh1",
                r -> r.path("/guonei").uri("http://news.baidu.com/guonei"))
                .build();
        return routes.build();
    }
}

Gateway配置动态路由：

通过微服务名实现动态路由。

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

  2. YML

  • 需要注意的是uri的协议为lb，表示启用Gateway的负载均衡功能。lb://serviceName是spring cloud geteway在微服务中自动为我们创建的负载均衡的uri。

  1. 测试：

    • 这时我们在写一个服务提供者8002模块，同样注册进eureka。这时我们使用微服务名进行调用：

    • 可以发现，这里也实现了负载均衡。

Gateway中的Predicate断言：

spring cloud gateway将路由匹配作为spring webflux handlerMapping基础架构的一部分。spring cloud gateway包括许多的内置route predicate工厂。所有这些predicate都与HTTP请求的不同属性匹配。多个predicate工厂可以进行组合。

spring cloud gateway创建route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate对象可以赋值给Route。Spring cloud Gateway包括许多内置的Route predicate factories。

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

我们之前配置的path就是断言的一种：

这个断言表示，如果外部访问路径是指定路径，就路由到指定的微服务上

可以看到，这里有一个Path，这个就是断言的一种，以下是断言的类型也可以在输出台找到：

  1. After Route Predicate：

    可以指定，只有在指定时间后，才可以路由到指定微服务。

    获取当前时区和时间：

    • 如果访问时间早于这个时间，那么就访问失败。

  2. Before：与After类似，指定时间之前才可以访问。

  3. Between：需要指定两个时间，逗号隔开，在他们之间的时间才可以访问。

  4. Cookie：只有包含某些指定cookie(key,value)的请求才可以路由。

  5. Header：只有包含指定请求头的请求,才可以路由。

  6. host：只有指定主机的才可以访问。

  7. method：只有指定请求才可以路由,比如get请求…

  8. path：只有访问指定路径,才进行路由。比如访问,/abc才路由

  9. Query：必须带有请求参数才可以访问。

Gateway中的Filter过滤器：

**生命周期:**在请求进入路由之前,和处理请求完成,再次到达路由之前。

种类：GatewayFilter和GlobalFilter。

  1. GateWayFilter,单一的过滤器：

    与断言类似,比如闲置,请求头,只有特定的请求头才放行,反之就过滤。官网上有31个。

  2. GlobalFilter,全局过滤器：

    官网上有10个。

自定义过滤器：

实现两个接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@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("username");
        if(StringUtils.isEmpty(username)){
            log.info("*****用户名为Null 非法用户,(┬＿┬)");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//给人家一个回应
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

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

测试链接：localhost:9527/payment/lb?uname=z3

这个自定义过滤器能干嘛？可以全局日志记录和统一网关鉴权。

然后启动服务,即可,因为过滤器通过@Componet已经加入到容器了。

  • 版权声明： 本博客所有文章除特别声明外，著作权归作者所有。转载请注明出处！

请我喝杯咖啡吧~

支付宝
微信