07）springcloud学习 SpringCloud Gateway 网关，API 路由管理

最新推荐文章于 2023-09-19 09:20:37 发布

影子2401

最新推荐文章于 2023-09-19 09:20:37 发布

阅读量401

点赞数

本文链接：https://blog.csdn.net/qq445829096/article/details/122700743

版权

java 专栏收录该内容

45 篇文章 1 订阅

订阅专栏

对网关的理解：

1.我们之前使用的nginx就可以实现代理多个http服务，ngixn就是一个统一网关，

我们可以在nginx做一些负载均衡，限流等操作，对于公网服务，把nginx部署在DMZ区，真实服务部署在内望区，通过nginx代码内网服务，还可以做到提高应用安全的作用。

2.项目中写的flfter过滤器，封装的统一服务入口控制器都可以说是网关

但是每个项目都自己内部实现网关很是不方便

在微服务通过一个统一的网关服务，转发请求到其他微服务上，

这样可以统一管理所有的微服务，统一日志管理，权限管理，负载均衡，熔断机制等。

gateway不仅能转发api接口请求，也能转发页面请求，返回页面。

目前因为spirng cloud提供了配套的gateway网关，在srpingcloud项目中更加倾向于使用springcloud gateway替代nginx网关。nginx只是一个工具，C语言写的，不好扩展，而

springcloud gateway是一个java web项目，我们可以编码实现gateay 统一日志收集，自定义路由规则等扩展。

1.抄一段SpringCloud 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 链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。

提前声明：Spring Cloud Gateway 底层使用了高性能的通信框架Netty。

2.抄一段SpringCloud Gateway特征

SpringCloud官方，对SpringCloud Gateway 特征介绍如下：

（1）基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0

（2）集成 Hystrix 断路器

（3）集成 Spring Cloud DiscoveryClient

（4）Predicates 和 Filters 作用于特定路由，易于编写的 Predicates 和 Filters

（5）具备一些网关的高级功能：动态路由、限流、路径重写

从以上的特征来说，和Zuul的特征差别不大。SpringCloud Gateway和Zuul主要的区别，还是在底层的通信框架上。

简单说明一下上文中的三个术语：

（1）Filter（过滤器）：

和Zuul的过滤器在概念上类似，可以使用它拦截和修改请求，并且对上游的响应，进行二次处理。过滤器为org.springframework.cloud.gateway.filter.GatewayFilter类的实例。

（2）Route（路由）：

网关配置的基本组成模块，和Zuul的路由配置模块类似。一个Route模块由一个 ID，一个目标 URI，一组断言和一组过滤器定义。如果断言为真，则路由匹配，目标URI会被访问。

（3）Predicate（断言）：

这是一个 Java 8 的 Predicate，可以使用它来匹配来自 HTTP 请求的任何内容，例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。

3.项目搭建

选择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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wying</groupId>
    <artifactId>gatewayservice</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>gatewayservice</name>
    <description>springcloud gateway for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>2021.0.1</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

忘记eureka了，单独引入eureka依赖

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

先配置注册到eureka服务中心

server:
  # 配置服务端口
  port: 7018
eureka:
  client:
    service-url:
      # 填写注册中心服务器地址
      defaultZone: http://127.0.0.1:7012/eureka
    # 是否需要将自己注册到注册中心
    register-with-eureka: true
    # 是否需要搜索服务信息
    fetch-registry: true
  instance:
    # 使用ip地址注册到注册中心
    prefer-ip-address: true
    # 注册中心列表中显示的状态参数
    instance-id: ${spring.cloud.client.ip-address}:${server.port}
spring:
  application:
    # 服务名称 - 服务之间使用名称进行通讯
    name: pes-gateway
    jackson:
      date-format: yyyy-MM-dd HH:mm:ss
      time-zone: GMT+8

启用eureka

启动eureks服务和gateway客户端后访问eureka主页注册成功

4.断言/路由转发规则

predicates(断言):

先来解释下route的组成部分：

id：路由的ID
uri：匹配路由的转发地址
predicates：配置该路由的断言，通过PredicateDefinition类进行接收配置。

4.1 时间断言

Spring Cloud 提供了三种时间断言工厂，After、Before、和Between。分别表示在某个时间点之后、在某个时间点之前、在某段之间之间路由才生效。时间的格式为Java的ZonedDataTime。如下我们在不同的时间点转发到不同的地址。After断言工厂需要一个带ZonedDateTime的时间参数，断言将匹配发生在这个时间之后的时间；Before断言工厂需要一个带ZonedDateTime的时间参数，断言将匹配发生在这个时间之前的时间；Between断言工厂需要两个带ZonedDateTime的时间参数，断言将匹配发生在这两个时间之间的时间。

4.2 Cookie/Header断言

Cookie断言工厂和Header断言工厂携带两个参数、cookie name或者header name和一个Java正则表达式，即cookie或者header的值,断言将会匹配Cookie或者Header给出的name和value值。

测试下cookie断言配置

- id: cookie-proxy-1
          uri: http://127.0.0.1:8012/
          predicates:
          - Cookie=tname, zhangsan

postman测试 Cookie断言

断言设置的规则是如果cookie name为tname value为zhangsan则把http://127.0.0.1:7018/的请求路由到http://127.0.0.1:8012/

如下配置

http://127.0.0.1:7018/pesTestController01/test01成功路由到了http://127.0.0.1:8012/pesTestController01/test01

4.3 Method/Host断言

Method断言工厂需要携带一个http请求的methods参数，断言将会匹配请求的方法类型。Host断言工厂会携带一个主机的匹配模式，模式使用.分隔

4.4 Query断言

Query路由断言工厂会从请求中获取两个参数，将请求中参数和Query断言中的配置进行匹配，如果请求中包含参数pname=zhangyuanyuan，使用下面的示例中的路由才能转发。也可以只限制参数不限制参数值，配置为Query=pname

4.5 RemoteAddr断言

RemoteAddr断言配置一个IPv4或者IPv6网段的字符串或者IP。当请求IP地址在网断之内和配置的IP相同，表示匹配成功，转发请求，否则不能转发。

4.6 Path断言

Path断言需要两个参数: 一个Spring PathMatcher模式的列表 and 可选的标识参数matchOptionalTrailingSeparator.。

我想要实现的效果是

通过7018 gateway网关统一管理 8012 pes-service-01 ，8013 pes-service-01 项目

及 8012 pes-service-01 ，8013 pes-service-01的请求都要经过7018 gateway转发

但是通过path断言配置中发现有问题

访问http://127.0.0.1:7018/pes-service-01/pesTestController01/test01

实际路由到了 http://127.0.0.1:8012/pes-service-01/pesTestController01/test01

无法路由到http://127.0.0.1:8012/pesTestController01/test01

实际上8012 pes-service-01没配置项目名直接ip端口访问的

给8012 pes-service-01项目加上项目名

server.servlet.context-path=/pes-service-01

才可以和path断言匹配上

    
        - id: pes-service-01-proxy
          uri: http://127.0.0.1:8012/
          predicates:
          - Path=/pes-service-01

由于8012 pes-service-01项目没设置项目名导入path断言加上一层pes-service-01后匹配不上，

需要访问的是http://127.0.0.1:8012/pesTestController01/test01

实际访问的是http://127.0.0.1:8012/pesTestController01/test01pes-service-01/http://127.0.0.1:8012/pesTestController01/test01

给 8012 pes-service-01项目配置上server.servlet.context-path=/pes-service-01就可以了

如果不想加项目名的话通过filters过滤器实现

StripPrefix 的意思：如gateway的地址是：http://127.0.0.1:7018/pesservice01/**
如果StripPrefix配置的是1，就会在http://127.0.0.1:7018后面的第一个pesservice01给去掉，同时把http://127.0.0.1:7018给替换为http://127.0.0.1:8012

  cloud:
    gateway:
      routes:
        - id: add_request_header_route
          uri: http://127.0.0.1:8012/
          predicates:
            - Path=/pesservice01/**
          filters:
            - StripPrefix=1

（path断言感觉和nginx转发请求配置方式很像啊。。。）

目前完整配置文件如下

server:
  # 配置服务端口
  port: 7018
eureka:
  client:
    service-url:
      # 填写注册中心服务器地址
      defaultZone: http://127.0.0.1:7012/eureka
    # 是否需要将自己注册到注册中心
    register-with-eureka: true
    # 是否需要搜索服务信息
    fetch-registry: true
  instance:
    # 使用ip地址注册到注册中心
    prefer-ip-address: true
    # 注册中心列表中显示的状态参数
    instance-id: ${spring.cloud.client.ip-address}:${server.port}
spring:
  application:
    # 服务名称 - 服务之间使用名称进行通讯
    name: pes-gateway
    jackson:
      date-format: yyyy-MM-dd HH:mm:ss
      time-zone: GMT+8
  cloud:
    gateway:
      routes:
        #cookie断言 postman测试访问 http://127.0.0.1:7018/pesTestController01/test01 请求头增加Cookie ： tname=zhangsan 路由到http://127.0.0.1:8012/pesTestController01/test01
        - id: cookie-proxy-1
          uri: http://127.0.0.1:8012/
          predicates:
            - Cookie=tname, zhangsan
        # postman访问 http://127.0.0.1:7018/pesservice01/pesTestController01/test01 路由到http://127.0.0.1:8012/pesTestController01/test01
        - id: pes-service-01-proxy
          uri: http://127.0.0.1:8012/
          predicates:
            - Path=/pesservice01/**
          #因为pesservice01项目没配置项目名(默认root)，ip 端口号直接访问的 通过filters StripPrefix=1截取到Path断言默认追加的pesservice01路径
          filters:
            - StripPrefix=1

5.路由过滤器

路由过滤器可以以某种方式去修改请求的内容或者要响应的内容，在Spring Cloud中有两种过滤器一种称为GatewayFilter、另一种为GlobalFilter，Spring Cloud Gateway 提供了二三十个过滤器，这里不再一一列出，详细的过滤器可以参考官方文档Spring Cloud Gateway 文档。

Spring Cloud Gatewayhttps://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.5.RELEASE/single/spring-cloud-gateway.html#_path_route_predicate_factory

6.gateway日志收集

影子2401

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
07）springcloud学习 SpringCloud Gateway 网关，API 路由管理

1.抄一段SpringCloud Gateway简介SpringCloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。SpringCloud Gateway 作为 Spring Cloud 生态系统中的网关，目标是替代 Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Z..
复制链接

扫一扫

专栏目录