SpringCloud中集成Gateway网关实现路由配置的两种方式以及动态路由

桃扇骨 2023-09-30 13:56 19阅读 0赞

## 场景 ##

SpringCloud中集成Eureka实现服务注册(单机Eureka构建)：

[SpringCloud中集成Eureka实现服务注册(单机Eureka构建)\_霸道流氓气质的博客-CSDN博客][SpringCloud_Eureka_Eureka_-CSDN]

SpringCloud中集成Eureka实现集群部署服务注册与服务提供者：

[SpringCloud中集成Eureka实现集群部署服务注册与服务提供者\_霸道流氓气质的博客-CSDN博客\_springcloud服务注册集群][SpringCloud_Eureka_-CSDN_springcloud]

在上面实现服务注册单机与集群的基础上，怎样集成Gateway网关实现服务调用。

### SpringCloud Gateway ###

Cloud全家桶中有个很重要组件就是网关，在1.x版本中都是采用的Zuul网关；

但在2.x版本中，zuul的升级一直跳票，SpringCloud最后足迹研发了一个网关替代Zuul，

这就是SpringCloud Gateway。

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

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

而为了 提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则是使用了高性能的Reactor模式通信框架Netty。

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

SpringCloud Gateway具有如下特性：

1、动态路由，能够匹配任何请求属性。

2、可以对路由指定Predicate(断言)和Filter(过滤器)。

3、集成Hystrix的断路器功能。

4、集成SpringCloud服务发现功能。

5、易于编写的Predicate(断言)和Filter(过滤器)。

6、请求限流功能。

7、支持路径重写。

Gateway的三大核心概念：

1、Route(路由)

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

2、Predicate(断言)

参考的是Java 8的java.util.function.Predicate

开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)，例如请求与断言相匹配则

进行路由。

3、Filter(过滤)

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

在之前可以做参数校验、权限校验、流量监控、日志输出、协议转换等。

在之后可以做响应内容、响应头的修改、日志的输出、流量监控等。

注：

博客：  
[霸道流氓气质的博客\_CSDN博客-C\#,架构之路,SpringBoot领域博主][CSDN_-C_SpringBoot]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

## 实现 ##

1、参考上面新建子模块的流程，新建cloud-gateway-gateway9527子模块

![3f34cae018866ac52927c149f0ff1e1c.png][]

2、修改其pom文件，添加如下依赖

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>

这里继续使用Eureka作为服务注册中心，所以完整的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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>SpringCloudDemo</artifactId>
            <groupId>com.badao</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-gateway-gateway9527</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
        </dependencies>
    </project>

3、新建并修改application.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/**         # 断言，路径相匹配的进行路由
    
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client: #服务提供者provider注册进eureka服务列表内
        service-url:
          register-with-eureka: true
          fetch-registry: true
          defaultZone: http://eureka7001.com:7001/eureka

4、新建启动类并添加@EnableEurekaClient注解

package com.badao.springclouddemo;
    
    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);
        }
    }

5、参考上面启动8001服务提供者

原来通过

[http://127.0.0.1:8001/payment/get/1][http_127.0.0.1_8001_payment_get_1]

可以访问服务，启动网关之后就可以通过

[http://127.0.0.1:9527/payment/get/1][http_127.0.0.1_9527_payment_get_1]

来访问服务的接口了

![f13e43a33376d1b4ee754aefc0a8db4c.png][]

#### Gateway配置网关的两种方式 ####

有两种配置方式，一种是和上面一样，在配置文件yml中配置，如果有多个路由的话，在routes下配置多个

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

一种是通过在代码中注入RouteLocator的Bean来实现

新建配置类

package com.badao.springclouddemo.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("badaodechengxvyuan",
                    r -> r.path("/badao")
                            .uri("https://blog.csdn.net/BADAO_LIUMANG_QIZHI")).build ();
    
            return routes.build();
        }
    }

比如这里实现的就是/badao这个路由映射到博客首页

[霸道流氓气质的博客\_CSDN博客-C\#,架构之路,SpringBoot领域博主][CSDN_-C_SpringBoot 1]

route的第一个参数就是类似yml中的id，后面的参数就是路由的映射，具体可以参考官网

[Spring Cloud Gateway][]

![f205b49689e8e745f3831e70b8734d5a.png][]

然后访问网关的/badao路由查看效果

[http://127.0.0.1:9527/badao][http_127.0.0.1_9527_badao]

![7aab02dbeb68c2ed8953a773adbecb20.png][]

#### Gateway的动态路由配置 ####

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

从而实现动态路由的功能。

修改yml配置文件

添加如下配置

discovery:
            locator:
              enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由

添加位置

![4af39632246b9ca2d7566bceb3bf18d8.png][]

将配置文件中原routes下的url由指定ip和端口的地址改为lb://服务名

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

完整pom文件

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://cloud-payment-service #匹配后提供服务的路由地址
              predicates:
                - Path=/payment/get/**         # 断言，路径相匹配的进行路由
    
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client: #服务提供者provider注册进eureka服务列表内
        service-url:
          register-with-eureka: true
          fetch-registry: true
          defaultZone: http://eureka7001.com:7001/eureka

启动一个eureka7001以及两个服务提供者8001和8002，然后再通过网关去调用该路由，可以通过端口

看到服务是动态切换的。

![1ed8de2fa945cdda05886a2ba7ad2f37.gif][]

[SpringCloud_Eureka_Eureka_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124688609
[SpringCloud_Eureka_-CSDN_springcloud]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124710576
[CSDN_-C_SpringBoot]: https://blog.csdn.net/badao_liumang_qizhi
[3f34cae018866ac52927c149f0ff1e1c.png]: https://img-blog.csdnimg.cn/img_convert/3f34cae018866ac52927c149f0ff1e1c.png
[http_127.0.0.1_8001_payment_get_1]: http://127.0.0.1:8001/payment/get/1
[http_127.0.0.1_9527_payment_get_1]: http://127.0.0.1:9527/payment/get/1
[f13e43a33376d1b4ee754aefc0a8db4c.png]: https://img-blog.csdnimg.cn/img_convert/f13e43a33376d1b4ee754aefc0a8db4c.png
[CSDN_-C_SpringBoot 1]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI
[Spring Cloud Gateway]: https://spring.io/projects/spring-cloud-gateway/
[f205b49689e8e745f3831e70b8734d5a.png]: https://img-blog.csdnimg.cn/img_convert/f205b49689e8e745f3831e70b8734d5a.png
[http_127.0.0.1_9527_badao]: http://127.0.0.1:9527/badao
[7aab02dbeb68c2ed8953a773adbecb20.png]: https://img-blog.csdnimg.cn/img_convert/7aab02dbeb68c2ed8953a773adbecb20.png
[4af39632246b9ca2d7566bceb3bf18d8.png]: https://img-blog.csdnimg.cn/img_convert/4af39632246b9ca2d7566bceb3bf18d8.png
[1ed8de2fa945cdda05886a2ba7ad2f37.gif]: https://img-blog.csdnimg.cn/img_convert/1ed8de2fa945cdda05886a2ba7ad2f37.gif