使用Nacos實(shí)現(xiàn)動(dòng)態(tài)路由的步驟和代碼示例

更新時(shí)間：2024年09月05日 08:48:03 作者：威哥愛(ài)編程

這篇文章主要介紹了使用 Nacos 實(shí)現(xiàn) Spring Cloud Gateway 的動(dòng)態(tài)路由,本文給大家介紹了具體的實(shí)現(xiàn)步驟和代碼案例,感興趣的小伙伴跟著小編一起來(lái)看看吧

添加依賴：在 Spring Cloud Gateway 應(yīng)用的 pom.xml 文件中添加 Nacos 相關(guān)依賴。
配置 Nacos：在 application.yml 或 application.properties 文件中配置 Nacos 服務(wù)地址。
啟用動(dòng)態(tài)路由：在配置文件中啟用 Nacos 動(dòng)態(tài)路由功能。
創(chuàng)建動(dòng)態(tài)路由配置：在 Nacos 配置中心創(chuàng)建動(dòng)態(tài)路由的配置信息。
監(jiān)聽(tīng)配置變化：在 Spring Cloud Gateway 應(yīng)用中監(jiān)聽(tīng) Nacos 配置變化，動(dòng)態(tài)更新路由規(guī)則。

下面是具體的實(shí)現(xiàn)步驟和代碼案例，來(lái)看一下：

1. 添加依賴

在 pom.xml 文件中添加 Spring Cloud Gateway 和 Nacos 相關(guān)依賴：

<dependencies>
    <!-- Spring Cloud Gateway -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!-- Spring Cloud Alibaba Nacos Discovery -->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!-- Spring Cloud Alibaba Nacos Config -->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
</dependencies>

2. 配置 Nacos

在 application.yml 文件中配置 Nacos 服務(wù)地址：

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848 # Nacos 服務(wù)地址
      config:
        server-addr: 127.0.0.1:8848 # Nacos 配置中心地址
        file-extension: yml # 配置文件格式
        group: DEFAULT_GROUP # 配置分組
        namespace: # 配置命名空間

3. 啟用動(dòng)態(tài)路由

在 application.yml 文件中啟用 Nacos 動(dòng)態(tài)路由功能：

spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 開(kāi)啟從注冊(cè)中心動(dòng)態(tài)創(chuàng)建路由的功能
          lower-case-service-id: true # 使用小寫服務(wù)名，默認(rèn)是大寫

4. 創(chuàng)建動(dòng)態(tài)路由配置

在 Nacos 配置中心創(chuàng)建一個(gè)配置文件，例如 gateway-routes.yml，內(nèi)容如下：

spring:
  cloud:
    gateway:
      routes:
        - id: my-service-route
          uri: lb://MY-SERVICE
          predicates:
            - Path=/my-service/**
          filters:
            - StripPrefix=1

5. 監(jiān)聽(tīng)配置變化

在 Spring Cloud Gateway 應(yīng)用中，創(chuàng)建一個(gè)配置類來(lái)監(jiān)聽(tīng) Nacos 配置變化，并刷新路由規(guī)則：

import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
import org.springframework.cloud.gateway.route.RouteDefinitionLocator;
import org.springframework.cloud.gateway.route.RouteDefinitionWriter;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class DynamicRouteService {

    private final RouteDefinitionWriter routeDefinitionWriter;
    private final RouteDefinitionLocator routeDefinitionLocator;

    public DynamicRouteService(RouteDefinitionWriter routeDefinitionWriter,
                                RouteDefinitionLocator routeDefinitionLocator) {
        this.routeDefinitionWriter = routeDefinitionWriter;
        this.routeDefinitionLocator = routeDefinitionLocator;
    }

    @EventListener
    public void onEnvironmentChange(EnvironmentChangeEvent event) {
        if (event.getKeys().contains("spring.cloud.gateway.routes")) {
            routeDefinitionLocator.getRouteDefinitions()
                .subscribe(routeDefinitions -> {
                    routeDefinitionWriter.delete("*").subscribe();
                    routeDefinitionWriter.save(routeDefinitions).subscribe();
                });
        }
    }
}

這個(gè)類會(huì)監(jiān)聽(tīng)環(huán)境變化事件，當(dāng)檢測(cè)到 spring.cloud.gateway.routes 配置項(xiàng)發(fā)生變化時(shí)，會(huì)重新加載和刷新路由規(guī)則。

我們通過(guò)使用 Nacos 實(shí)現(xiàn) Spring Cloud Gateway 的動(dòng)態(tài)路由。通過(guò)在 Nacos 配置中心維護(hù)路由配置，可以實(shí)現(xiàn)不重啟網(wǎng)關(guān)服務(wù)的情況下動(dòng)態(tài)更新路由規(guī)則，這對(duì)于微服務(wù)架構(gòu)中的服務(wù)治理非常有用。

在使用 Nacos 動(dòng)態(tài)路由時(shí)，如果服務(wù)下線了，Spring Cloud Gateway 會(huì)如何響應(yīng)？

當(dāng)使用 Nacos 動(dòng)態(tài)路由時(shí)，如果服務(wù)下線，Spring Cloud Gateway 會(huì)通過(guò) Nacos 的服務(wù)發(fā)現(xiàn)機(jī)制感知到這一變化，并根據(jù)配置的動(dòng)態(tài)路由規(guī)則進(jìn)行調(diào)整。如何配置 Spring Cloud Gateway 以響應(yīng)服務(wù)下線的情況呢？來(lái)，上代碼：

首先，確保咱們的項(xiàng)目中已經(jīng)添加了 Spring Cloud Gateway 和 Spring Cloud Alibaba Nacos Discovery 的依賴。

1. application.yml 配置

在 application.yml 中配置 Nacos 服務(wù)發(fā)現(xiàn)和動(dòng)態(tài)路由：

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848 # Nacos 服務(wù)地址
    gateway:
      routes:
        - id: my-service-route
          uri: lb://MY-SERVICE
          predicates:
            - Path=/my-service/**
          filters:
            - StripPrefix=1
      discovery:
        locator:
          enabled: true
          lower-case-service-id: true

2. Nacos 配置中心的動(dòng)態(tài)路由配置

在 Nacos 配置中心創(chuàng)建一個(gè)名為 gateway-routes.json 的配置文件，內(nèi)容如下：

{
  "spring": {
    "cloud": {
      "gateway": {
        "routes": [
          {
            "id": "my-service-route",
            "uri": "lb://MY-SERVICE",
            "predicates": [
              {
                "name": "Path",
                "args": {
                  "_genkey_0": "/my-service/**"
                }
              }
            ],
            "filters": [
              {
                "name": "StripPrefix",
                "args": {
                  "_genkey_1": "1"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

3. 動(dòng)態(tài)路由配置監(jiān)聽(tīng)

創(chuàng)建一個(gè)配置類來(lái)監(jiān)聽(tīng) Nacos 配置變化，并刷新路由規(guī)則：

import com.alibaba.cloud.nacos.NacosConfigManager;
import com.alibaba.cloud.nacos.NacosConfigProperties;
import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.model.Properties;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionRepository;
import org.springframework.cloud.gateway.route.RoutesRefreshedEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Component;

import java.util.Properties as JavaProperties;

@Component
public class NacosDynamicRoute implements ApplicationRunner {

    @Autowired
    private RouteDefinitionRepository routeDefinitionRepository;

    @Autowired
    private ApplicationEventPublisher publisher;

    private ConfigService configService;

    public NacosDynamicRoute(NacosConfigProperties properties) throws NacosException {
        JavaProperties javaProperties = new JavaProperties();
        javaProperties.setProperty("serverAddr", properties.getServerAddr());
        javaProperties.setProperty("namespace", properties.getNamespace());
        configService = NacosFactory.createConfigService(javaProperties);
    }

    @Override
    public void run(ApplicationArguments args) {
        try {
            String routeJson = configService.getConfig("gateway-routes.json", "DEFAULT_GROUP", 5000);
            refreshRoutes(routeJson);
            configService.addListener("gateway-routes.json", "DEFAULT_GROUP", s -> refreshRoutes(s));
        } catch (NacosException e) {
            e.printStackTrace();
        }
    }

    private void refreshRoutes(String routeJson) {
        SpringCloudRouteDefinition routeDefinition = JsonUtils.deserialize(routeJson, SpringCloudRouteDefinition.class);
        routeDefinitionRepository.delete("*").subscribe();
        routeDefinitionRepository.save(routeDefinition.getRouteDefinitions()).subscribe();
        publisher.publishEvent(new RoutesRefreshedEvent(this));
    }

    // 內(nèi)部類，用于反序列化 Nacos 配置
    static class SpringCloudRouteDefinition {
        private RouteDefinition[] routeDefinitions;

        // getter 和 setter 省略
    }
}

NacosDynamicRoute 類會(huì)在應(yīng)用啟動(dòng)時(shí)從 Nacos 配置中心加載路由配置，并注冊(cè)一個(gè)監(jiān)聽(tīng)器來(lái)監(jiān)聽(tīng)配置變化。當(dāng)配置發(fā)生變化時(shí)，它會(huì)重新加載路由配置并刷新路由規(guī)則。

以上就是使用Nacos實(shí)現(xiàn)動(dòng)態(tài)路由的步驟和代碼示例的詳細(xì)內(nèi)容，更多關(guān)于Nacos動(dòng)態(tài)路由的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: