为了账号安全，请及时绑定邮箱和手机立即绑定
首页 手记 配置Gateway+Nacos学习入门

配置Gateway+Nacos学习入门

标签：
Spring Cloud 微服务
概述

本文将详细介绍如何在Spring Cloud环境中搭建和配置Gateway与Nacos的结合使用，实现动态路由和配置管理。从环境搭建到项目创建，再到具体配置和实战演练，帮助你快速掌握这一技术栈的使用方法。

Gateway+Nacos简介
Gateway简介

Spring Cloud Gateway 是 Spring Cloud 生态系统中的一个库，用于构建 API 网关。它基于 Netty 构建，可以实现路由、过滤器等功能。Spring Cloud Gateway 采用功能丰富的路由和过滤器 API，以及高度可扩展的插件模型，使开发人员可以轻松地构建自己的网关。

Gateway 通过路由规则将请求转发到对应的后端服务。路由规则定义了请求路径和后端服务地址之间的映射。Spring Cloud Gateway 支持多种路由匹配规则，包括路径匹配、请求头匹配等。此外，Gateway 还提供了多种内置过滤器和自定义过滤器，可以实现请求的预处理和响应的后处理。

Nacos简介

Nacos 是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台。它能够帮助服务提供者和服务消费者在动态、低延迟的环境下进行服务发现和负载均衡。Nacos 也提供了全局配置管理的功能，使得配置可以在不同环境之间轻松地进行修改和同步。

Nacos 的核心服务包括：

  • 服务发现和服务健康管理：允许服务提供者注册到 Nacos 中，服务消费者能够动态获得注册服务列表，同时监控服务提供者的健康状态。
  • 动态配置服务：支持配置的动态更新和推送，可以根据不同的环境（如开发、测试、生产）设置不同的配置。
  • 服务管理：支持服务的注册、注销和发现，可以在 Nacos 控制台中管理服务。
Gateway与Nacos的结合

在 Spring Cloud 环境中，Gateway 与 Nacos 可以结合使用，使得路由和配置更加灵活和动态。Spring Cloud Gateway 本身已经内置了对 Nacos 的支持，可以通过 Nacos 进行动态路由配置和配置管理。

结合使用时，主要通过 Nacos 配置中心来管理路由配置，并将这些配置推送到 Gateway。当 Nacos 中的配置发生变更时，配置会自动更新到 Gateway，从而实现路由的动态更新。这种配置方式使得服务治理更加灵活，可以快速响应业务需求的变化。

环境搭建与安装
搭建Java开发环境
  1. 安装 JDK：首先需要安装 Java 开发工具包 (JDK)。下载最新版本的 JDK：https://www.oracle.com/java/technologies/javase-jdk11-downloads.html。
  2. 配置环境变量：安装完成后，需要配置环境变量 JAVA_HOME 和 PATH。例如：
    • JAVA_HOME 设为 JDK 的安装路径。
    • PATH 中添加 %JAVA_HOME%\bin（对于 Windows），或者 $JAVA_HOME/bin（对于 Linux 和 macOS）。
  3. 验证安装：在命令行中输入 java -version，查看安装的 JDK 版本。 
    java -version
下载并安装Spring Boot
  1. 安装 Maven：Spring Boot 的构建依赖于 Maven，所以需要先安装 Maven。下载 Maven 的最新版本：https://maven.apache.org/download.cgi。
  2. 配置环境变量：
    • MAVEN_HOME 设为 Maven 的安装路径。
    • PATH 中添加 %MAVEN_HOME%\bin（对于 Windows），或者 $MAVEN_HOME/bin（对于 Linux 和 macOS）。
  3. 验证安装：通过 mvn -version 检查 Maven 是否安装成功。 
    mvn -version
下载并安装Nacos
  1. 下载Nacos：访问 Nacos GitHub 仓库 下载最新版本。
    • 下载启动脚本并解压。
  2. 启动Nacos：
    • 进入解压后的目录，找到 startup.cmd（Windows）或 startup.sh（Linux/macOS）。
    • 使用命令启动 Nacos： 
      sh bin/startup.sh -m standalone

      或者：

      sh bin/startup.sh -m cluster

启动完成后，可以在浏览器中访问 http://localhost:8848/nacos，使用默认的用户名 nacos 和密码 nacos 登录 Nacos 管理界面。

创建Spring Boot Gateway项目
创建新的Spring Boot项目
  1. 使用 Spring Initializr 创建新的 Spring Boot 项目。访问 https://start.spring.io，选择项目基本信息（如项目名、语言、依赖等）。
  2. 添加依赖：
    • Spring Boot Starter Webflux：用于创建响应式 web 应用。
    • Spring Cloud Gateway：用于集成 Gateway。
    • Spring Cloud Nacos Discovery：用于集成 Nacos 配置中心。

生成完成后，下载项目并导入到 IDE 中。

添加Gateway和Nacos依赖

在项目的 pom.xml 文件中添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!-- 如果需要使用Nacos配置中心，则还需要添加 -->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
</dependencies>
配置Nacos服务器地址

在 application.yml 文件中配置 Nacos 服务器地址：

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848 # Nacos服务器地址
    gateway:
      discovery:
        enabled: true
        locator:
          enabled: true
          fallbackAppName: gateway-fallback # 当请求服务不存在时的默认路由
        routes:
          - id: route_to_service1
            uri: lb://service1 # 使用Nacos的服务发现
            predicates:
            - Path=/service1/**
            filters:
            - SetRequestHeader=X-Service-Id,service1
Gateway基础配置
路由配置

Spring Cloud Gateway 通过路由规则将请求转发到后端服务。路由配置定义了请求路径和后端服务地址之间的映射。在 application.yml 文件中定义路由配置：

spring:
  cloud:
    gateway:
      routes:
        - id: route_to_service1
          uri: http://localhost:8080 # 后端服务地址
          predicates:
            - Path=/service1/**
          filters:
            - SetStatus=201
            - SetRequestHeader=X-Service-Id,service1
路由匹配规则

Spring Cloud Gateway 提供了多种路由匹配规则，例如基于路径、请求头、HTTP 方法等。以下是一些常用的匹配规则：

  1. Path：匹配请求路径。 
    predicates:
 - Path=/service1/**
  2. Host：匹配请求主机。 
    predicates:
 - Host=service1.example.com
  3. Method：匹配请求方法。 
    predicates:
 - Method=GET
路由过滤器

路由过滤器用于在路由处理过程中拦截请求和响应。Spring Cloud Gateway 提供了许多内置的过滤器，也可以自定义过滤器。以下是一些常用的内置过滤器：

  1. SetRequestHeader：设置请求头。 
    filters:
 - SetRequestHeader=X-Service-Id,service1
  2. SetStatus：设置响应状态码。 
    filters:
 - SetStatus=201
  3. RewritePath：重写路径。 
    filters:
 - RewritePath=/service1(/?), http://localhost:8080/$1
使用Nacos进行动态路由管理
Nacos配置中心介绍

Nacos 配置中心允许将配置文件存储在 Nacos 中，并通过配置中心进行管理和同步。Spring Cloud Gateway 可以通过 Nacos 配置中心动态更新路由配置。

在 Nacos 控制台中创建配置文件（例如 gateway-config.yml），并添加路由配置：

spring:
  cloud:
  gateway:
    routes:
      - id: route_to_service1
        uri: lb://service1
        predicates:
        - Path=/service1/**
        filters:
        - SetRequestHeader=X-Service-Id,service1
在Gateway项目中集成Nacos

在 application.yml 中配置 Nacos 配置中心：

spring:
  cloud:
  nacos:
    config:
      server-addr: 127.0.0.1:8848
      file-extension: yml
      auto-refresh: true
  gateway:
    discovery:
      enabled: true
      locator:
        enabled: true
        fallbackAppName: gateway-fallback
      routes:
        - id: route_to_service1
          uri: lb://service1
          predicates:
          - Path=/service1/**
          filters:
          - SetRequestHeader=X-Service-Id,service1
动态更新路由配置

当在 Nacos 控制台中修改配置文件后，Gateway 会自动读取最新的配置文件，实现路由配置的动态更新。

实战演练
案例一：简单路由转发

在 application.yml 中配置一个简单的路由转发规则：

spring:
  cloud:
  gateway:
    routes:
      - id: route_to_service1
        uri: http://localhost:8080
        predicates:
        - Path=/service1/**

启动 Spring Boot 项目和后端服务 (例如，一个简单的 Spring Boot 应用)：

@SpringBootApplication
@RestController
public class Service1Application {

    @GetMapping("/service1/echo")
    public String echo() {
        return "Hello from service1!";
    }

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

访问 http://localhost:8081/service1/echo，会返回 Hello from service1!。

案例二：使用Nacos动态更新路由

在 Nacos 控制台中创建配置文件 gateway-config.yml：

spring:
  cloud:
  gateway:
    routes:
      - id: route_to_service2
        uri: lb://service2
        predicates:
        - Path=/service2/**
        filters:
        - SetRequestHeader=X-Service-Id,service2

在 application.yml 中配置 Nacos 配置中心：

spring:
  cloud:
  nacos:
    config:
      server-addr: 127.0.0.1:8848
      file-extension: yml
      auto-refresh: true
  gateway:
    discovery:
      enabled: true
      locator:
        enabled: true
        fallbackAppName: gateway-fallback
      routes:
      - id: route_to_service2
        uri: lb://service2
        predicates:
        - Path=/service2/**
        filters:
        - SetRequestHeader=X-Service-Id,service2

后端服务实现代码（例如服务2）：

@SpringBootApplication
@RestController
public class Service2Application {

    @GetMapping("/service2/echo")
    public String echo() {
        return "Hello from service2!";
    }

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

在 Nacos 控制台中修改 gateway-config.yml 文件，然后访问 http://localhost:8081/service2/echo，会返回新的服务响应。

案例三：过滤器的应用

在 application.yml 中定义一个路由过滤器：

spring:
  cloud:
  gateway:
    routes:
      - id: route_to_service1
        uri: http://localhost:8080
        predicates:
        - Path=/service1/**
        filters:
        - SetStatus=201
        - SetRequestHeader=X-Service-Id,service1
        - RewritePath=/service1(/?), http://localhost:8080/$1

后端服务实现代码（例如服务1）：

@SpringBootApplication
@RestController
public class Service1Application {

    @GetMapping("/service1/echo")
    public String echo() {
        return "Hello from service1!";
    }

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

启动服务，访问 http://localhost:8081/service1/echo，会看到请求头中包含 X-Service-Id: service1，响应状态码为 201，路径也经过了重写。

通过这些案例，可以进一步理解 Spring Cloud Gateway 和 Nacos 在实际项目中的应用。

点击查看更多内容
发表于 2024.12.27 21:08， 共 25 人浏览

本文原创发布于慕课网 ，转载请注明出处，谢谢合作

举报
为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

作者其他优质文章

正在加载中

翻阅古今

手记
篇
粉丝
9
获赞与收藏
36

关注作者，订阅最新文章

阅读免费教程

  • 推荐
  • 评论
  • 收藏
  • 共同学习，写下你的评论
感谢您的支持，我会继续努力的～
扫码打赏，你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫，即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消