关于Spring cloud Gateway集成nacos 实现路由到指定微服务的方式总结

Posted 2023-04-07 Austinu

Nacos

两种方式实现nacos服务注册与发现

Nacos服务注册与发现的2种实现方法

1.OpenAPI模式

2.SDK模式

Spring Cloud GateWay

gateway网关路由配置详解

gateway动态配置网关路由规则

微服务路由

方式1，nacos自动下发

应用

请求路径中包含微服务名

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/demo-system/sys/gatewayRoute/list

应用场景

gateway 微服务路由

配置方式

application.yml

spring:  
  cloud:
    gateway:
      # 此处配置表示开启自动映射naocs下发的路由
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      default-filters:
  main:
    allow-bean-definition-overriding: true #当遇到同样名字的时候，是否允许覆盖注册

优点

nacos自动下发，和gateway本身无关，路由转发的功能由nacos分担。因此对开发友好，易上手。

缺点

只要是 微服务 demo-system的接口都可以进行请求。请求范围大。

方式2，yml 配置路由规则

应用

gateway 根据路径参数查找 对应的服务进行路由。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot gateway服务路由

配置方式

application.yml

spring:
  cloud:
    gateway:
      # 配置路由规则
      routes:
        # 采用自定义路由 ID（有固定用法，不同的 id 有不同的功能
        - id: demo-business
          # 采用 LoadBalanceClient 方式请求，以 lb:// 开头，后面的是注册在 Nacos 上的服务名
          uri: lb://demo-business
#          uri: http://192.168.0.105:18000
          # Predicate 翻译过来是“谓词”的意思，必须，主要作用是匹配用户的请求，有很多种用法
          predicates:
            - Path=/business/**,/biz/**
            # Method 方法谓词，这里是匹配 GET 和 POST 请求
            - Method=GET,POST

        - id: demo-system
          uri: lb://demo-system
          predicates:
            - Path=/system/**,/sys/**

优点

因为是否能路由到对应的微服务，是根据路由条件进行匹配的，所以这种路由方式更加严格，自定义路由条件配置。路由范围自定义。

缺点

如果出现对路由规则条件配置的变更，活增加新的微服务，都需要停掉网关服务，然后进行配置，再进行部署。比较繁琐。

方式3， 数据库读取路由配置规则

应用

为了解决方式2的缺点，即不停网关服务，依然能进行配置路由规则，并且路由功能生效，这就诞生了数据库动态路由。

动态路由的机制：

1）实现一个Spring提供的事件推送接口ApplicationEventPublisherAware，

2）提供动态路由的基础方法，可通过获取bean操作该类的方法。该类提供新增路由、更新路由、删除路由，然后实现发布的功能。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot 默认 gateway服务路由方式

配置方式

优点

方便集中管理，自定义程度较高。

缺点

需要由webflux基础，上手较难。需要有网关路由条件配置界面。

如果是微服务名不同，匹配路径相同，比如 jeecg-system 和demo-system 微服务 都有查询路由这个路径规则 /sys/**，启动jeecg-system, 停止demo-system，可能会出现找服务找到demo-system，而不是 jeecg-system微服务。从而出现微服务不可用异常。

jeecg-boot 使用自定义 status 来控制 微服务是否可用，而不是根据实际nacos注册中心中注册的微服务实例 来进行判断是否进行路由。

Spring Cloud LoadBalancer

https://blog.csdn.net/feiying0canglang/article/details/126815588

SpringCloud从2020版本开始移除了对Ribbon的依赖，官方使用Spring Cloud Loadbalancer正式替换Ribbon，而且Spring Cloud Loadbalancer成为了Spring Cloud负载均衡器的唯一实现。

方式4， nacos配置路由规则json文件

应用

路由规则配置在 demo-gateway-router.json，然后在demo-gateway-dev.yaml中指定路由规则时nacos。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot 可以选择使用 nacos 路由配置规则，动态刷新路由。

配置方式

demo-gateway-router.json

[
  "id": "jeecg-system",
  "order": 6,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/sys/**",
      "_genkey_1": "/jmreport/**",
      "_genkey_3": "/online/**",
      "_genkey_4": "/generic/**"
    
  ],
  "filters": [],
  "uri": "lb://jeecg-system"
, 
  "id": "jeecg-demo",
  "order": 1,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/mock/**",
      "_genkey_1": "/test/**",
      "_genkey_2": "/bigscreen/template1/**",
      "_genkey_3": "/bigscreen/template2/**"
    
  ],
  "filters": [],
  "uri": "lb://jeecg-demo"
, 
  "id": "jeecg-system-websocket",
  "order": 2,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/websocket/**",
      "_genkey_1": "/newsWebsocket/**"
    
  ],
  "filters": [],
  "uri": "lb:ws://jeecg-system"
, 
  "id": "jeecg-demo-websocket",
  "order": 3,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/vxeSocket/**"
    
  ],
  "filters": [],
  "uri": "lb:ws://jeecg-demo"
,
  "id": "demo-system",
  "order": 4,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/sys/**",
      "_genkey_1": "/system/**"
    
  ],
  "filters": [],
  "uri": "lb://demo-system"
, 
  "id": "demo-business",
  "order": 5,
  "predicates": [
    "name": "Path",
    "args": 
      "_genkey_0": "/mock/**",
      "_genkey_1": "/business/**"
    
  ],
  "filters": [],
  "uri": "lb://demo-business"
]

优点

易上手。实现动态路由，在nacos修改路由规则后可以不用重启网关，路由生效。

缺点

如果微服务一多，维护可能复杂。

如果是微服务名不同，匹配路径相同，比如 jeecg-system 和demo-system 微服务 都有查询路由这个路径规则 /sys/**，启动jeecg-system, 停止demo-system，可能会出现找服务找到demo-system，而不是 jeecg-system微服务。从而出现微服务不可用异常。

综上所述，作者认为实现spring cloud 动态路由最好的方式是 使用nacos自动下发。

Spring Cloud Gateway集成

主项目链接：https://gitee.com/java_wxid/java_wxid
项目架构及博文总结：

• 点击：【使用Spring Boot快速构建应用】
• 点击：【使用Spring Cloud Open Feign基于动态代理动态构造请求实现与其他系统进行交互】
• 点击：【使用Spring Cloud Hystrix实现服务容错、熔断、降级、监控】
• 点击：【使用Spring Cloud Ribbon以库的方式集成到服务的消费方实现客户端负载均衡】
• 点击：【使用Spring Cloud Gateway作为API网关服务进行请求拦截、服务分发、降级、限流】
• 点击：【使用Spring Cloud Security Oauth2作为微服务统一认证中心实现用户认证和授权访问】
• 点击：【使用Spring Cloud Stream作为消息驱动用于动态的切换中间件】
• 点击：【使用Spring Cloud Skywalking基于字节码注入通过探针方式进行链路追踪、分布式追踪、性能指标分析、应用和服务依赖分析
• 点击：【使用Spring Cloud Alibaba Nacos实现服务注册/发现/续约/剔除/下线、心跳检测、服务配置管理、基于长轮训机制实现配置动态变更】
• 点击：【使用Spring Cloud Alibaba Seata作为对项目代码无入侵的分布式事务解决方案】
• 点击：【使用Spring Cloud Alibaba Sentinel实现高可用流量防护】
• 点击：【使用Apache ShardingSphere作为关系型数据库中间件实现分库分表、读写分离】
• 点击：【使用Apache Mybatis作为持久层框架用于定制化SQL、存储过程以及高级映射】
• 点击：【使用Redis作为高性能分布式缓存数据库】
• 点击：【使用ElasticSearch全文搜索】
• 点击：【使用MongoDB非关系型数据库】
• 点击：【使用xxl-job作为分布式任务调度平台】
• 点击：【使用Elasticsearch + Logstash + Kibana作为日志收集系统】
• 点击：【使用Apifox作为API文档、API调试、API Mock、API自动化测试】
• 点击：【使用Apache Spark作为基于内存计算的大数据分析引擎用于批处理、交互式查询】
• 点击：【使用ETL工具将数据源抽取到HDFS作为高可靠、高吞吐量的分布式文件系统存储，通过Hive清洗、处理和计算原始数据，Hive清洗处理后的结果，将存入Hbase，海量数据随机查询场景从HBase查询数据】
• 点击：【使用领域驱动DDD设计和设计模式进行开发】
• 点击：【使用Netty基于Java NIO封装的高性能的网络通信框架】
• 点击：【使用k8s、docker、docker-compose、宝塔面板进行环境搭建和部署】
• 点击：【使用Vue渐进式JavaScript框架作为适用场景丰富的Web前端框架】
• 点击：【分享人才筛选、工作分配、高效办公、项目推动等团队管理经验】

项目模块：
前期规划，实现部分

java_wxid   
├── demo        // 演示模块
│     └── 模块名称：spring-boot-demo模块                   //Spring Boot快速构建应用（已实现并有博文总结）
│     └── 模块名称：spring-cloud-alibaba-nacos-demo模块    //Spring Cloud Alibaba Nacos集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-open-feign-demo模块       //Spring Cloud Open Feign集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-hystrix-demo模块          //Spring Cloud Hystrix集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-ribbon-demo模块           //Spring Cloud Ribbon集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-gateway-demo模块          //Spring Cloud Gateway集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-security-oauth2-demo模块  //Spring Cloud Security Oauth2集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-stream-demo模块           //Spring Cloud Stream集成(框架已搭建，待校验，待博文总结)
│     └── 模块名称：spring-cloud-skywalking-demo模块       //Spring Cloud Skywalking集成(框架已搭建，待校验，待博文总结)
│     └── 模块名称：spring-cloud-alibaba-seata-demo模块    //Spring Cloud Alibaba Seata集成（已实现并有博文总结）
│     └── 模块名称：spring-cloud-alibaba-sentinel-demo模块 //Spring Cloud Alibaba Sentinel集成(框架已搭建，待校验，待博文总结)
│     └── 模块名称：apache-shardingsphere-demo模块         //Apache ShardingSphere集成（已实现并有博文总结）
│     └── 模块名称：apache-mybatis-demo模块                //Apache Mybatis集成（已实现并有博文总结）
│     └── 模块名称：redis-demo模块                         //Redis集成（已实现并有博文总结）
│     └── 模块名称：elasticsearch-demo模块                 //ElasticSearch集成(框架已搭建，待校验，待博文总结)
│     └── 模块名称：mongodb-demo模块                       //MongoDB集成（已实现并有博文总结）
│     └── 模块名称：xxl-job-demo模块                       //xxl-job集成(框架已搭建，待校验，待博文总结)
│     └── 模块名称：apache-spark-demo模块                  //Apache Spark集成
│     └── 模块名称：etl-hdfs-hive-hbase-demo模块           //ETL、HDFS、Hive、Hbase集成
│     └── 模块名称：ddd-design-mode-demo模块               //DDD、设计模式集成
│     └── 模块名称：netty-demo模块                         //Netty集成
│     └── 模块名称：vue-demo模块                           //前端vue集成
├── document        // 文档
│     └── README.ch.md                      //中文文档
│     └── README.en.md                      //英文文档

---

系列文章：前期主要以demo项目为主，快速集成各种微服务相关的技术，帮助大家可以快速集成到自己的项目中，节约开发时间。后期则会以企业实战项目为主，致力于解决高并发、高可用、高性能、高可靠、海量数据等疑难问题，同时记录工作中遇到的技术难点、有技术亮点，项目会结合博客、视频辅助讲解，帮助大家查询是否遇到过同类型的问题。
提示：系列文章还未全部完成，后续的文章，会慢慢补充进去的。

文章目录

• • 创建spring-cloud-gateway-demo项目
  • • 修改pom.xml
    • 创建bootstrap.yml文件
    • 修改启动类SpringCloudGatewayDemoApplication
  • 校验gateway是否工作

本章会结合【java_wxid项目】【第五章】【Spring Cloud Hystrix集成】的spring-cloud-hystrix-demo项目进行demo演示

创建spring-cloud-gateway-demo项目

项目代码：https://gitee.com/java_wxid/java_wxid/tree/master/demo/spring-cloud-gateway-demo
项目结构如下（示例）：

修改pom.xml

代码如下（示例）：

<?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>

    <groupId>com.example</groupId>
    <artifactId>spring-cloud-gateway-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-cloud-gateway-demo</name>
    <description>Demo project for Spring Boot</description>

    <!--    属性配置-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <!--引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系-->
        <spring.boot.version>2.3.12.RELEASE</spring.boot.version>
        <spring.cloud.version>Hoxton.SR12</spring.cloud.version>
        <spring.cloud.alibaba.version>2.2.7.RELEASE</spring.cloud.alibaba.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--        代表web模块，在这个模块中含了许多JAR包，有spring相关的jar，内置tomcat服务器，jackson等，这些web项目中常用的的功能都会自动引入-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-web</artifactId>-->
<!--        </dependency>-->

        <!-- Alibaba Nacos 配置 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!--        在SpringBoot 2.4.x的版本之后，对于bootstrap.properties/bootstrap.yaml配置文件
        (我们合起来成为Bootstrap配置文件)的支持，其实这个jar包里什么都没有，
        就只有一个标识类Marker，用来标识要开启Bootstrap配置文件的支持，由于父类用了2.5.6版本需要导入如下的依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
            <version>3.1.0</version>
        </dependency>

        <!--        网关配置-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
<!--        spring cloud gateway是基于webflux的，如果非要web支持的话需要导入spring-boot-starter-webflux，
而不是spring-boot-start-web。-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-webflux</artifactId>-->
<!--        </dependency>-->

    </dependencies>


    <!--
        引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系
     -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>$spring.boot.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>$spring.cloud.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>$spring.cloud.alibaba.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>


    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <source>$java.version</source>
                    <target>$java.version</target>
                    <encoding>$project.build.sourceEncoding</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

创建bootstrap.yml文件

代码如下（示例）：

#bootstrap.yml优先级比application.yml优先级高
spring:
  #prefix−spring.profile.active.$file-extension
  #nacos会根据当前环境去拼接配置名称查找相应配置文件，
  #示例：spring.application.name-spring.profiles.active-spring.cloud.nacos.config.file-extension
  #获取到值：nacos-autoconfig-service-dev.yml
  profiles:
    #开发环境dev，测试环境test，生产环境prod
    active: dev
  application:
    #配置应用的名称，用于获取配置
    name: gateway-demo
  cloud:
    nacos:
      discovery:
        # 服务注册地址
        server-addr: 106.14.132.94:8848
      config:
        #nacos配置中心地址
        server-addr: 106.14.132.94:8848
        #配置中心的命名空间id
        namespace: 9e50b6d9-6c3d-4e7a-b701-10f085e4b98d
        #配置分组，默认没有也可以
        group: DEFAULT_GROUP
        #配置文件后缀，用于拼接配置配置文件名称，目前只支持yaml和properties
        file-extension: yaml
        #配置自动刷新
        refresh-enabled: true
        #配置文件的前缀，默认是application.name的值，如果配了prefix，就取prefix的值
        #prefix: nacos-autoconfig-service-$spring.profile.active
        # 配置编码
        encode: UTF-8
        username: nacos
        password: nacos
    gateway:
      discovery:
        locator:
          enabled: false
          lowerCaseServiceId: true
      routes:
        - id: hystrix-route   #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: lb://hystrix-demo #nacos的服务名称，匹配后提供服务的路由地址，也可以用uri: http://localhost:8805/
          predicates:
            - Path=/hystrix-demo/**         # 断言，路径相匹配的进行路由
          filters:
            - StripPrefix=1 #去掉服务名前缀

修改启动类SpringCloudGatewayDemoApplication

代码如下（示例）：

package com.example.springcloudgatewaydemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@EnableDiscoveryClient
@SpringBootApplication
public class SpringCloudGatewayDemoApplication 

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

    @Bean
    @LoadBalanced
    RestTemplate restTemplate() 
        return new RestTemplate();
    

校验gateway是否工作

启动spring-cloud-hystrix-demo项目、spring-cloud-gateway-demo项目
如下图（示例）：

正常调用spring-cloud-hystrix-demo的接口，是这样的，请求地址：
如下图（示例）：

使用网关之后的请求地址：http://localhost:8806/hystrix-demo/hystrix/getNacosConfigure
如下图（示例）：

可以发现已经经过网关分发到具体的服务了，gateway起作用了