为了账号安全，请及时绑定邮箱和手机立即绑定
首页 手记 配置Gateway+nacos项目实战教程

配置Gateway+nacos项目实战教程

标签：
Spring Cloud 微服务
概述

本文将详细介绍如何配置Gateway+nacos项目实战。通过初始化Spring Boot项目、添加相关依赖、配置Nacos服务发现和路由规则，以及通过Nacos实现路由规则的动态更新。文章中将展示关键代码片段和配置文件，帮助读者更好地理解和应用Gateway+nacos的结合。我们将通过一个简单的API网关实例，演示如何实现服务的动态路由和配置管理。

引入Gateway和Nacos

什么是Spring Cloud Gateway

Spring Cloud Gateway 是基于Spring Boot 2.0的API网关，提供定义路由、过滤器链以及其他路由规则的手段。其主要功能包括路由、过滤器链、断路器、路径重写、请求改造（如添加请求头和请求参数）、限流和自定义过滤器等。它支持通过Nacos等配置中心动态配置和更新路由规则，从而实现服务的动态路由和负载均衡。

什么是Nacos

Nacos 是由阿里巴巴开源的服务发现、配置管理和服务管理平台。它支持服务注册、服务发现及配置的动态更新。服务提供者可以注册服务，服务消费者则可以动态发现和调用服务。Nacos提供的集中式配置管理使得配置的集中管理和动态更新变得非常方便。

Gateway与Nacos的结合优势

Spring Cloud Gateway与Nacos结合，可以实现动态的服务路由和配置管理，从而提高系统的灵活性和可维护性。通过Nacos，可以在不重启服务的情况下动态更新路由规则和配置，使得服务变更更加及时高效。Nacos的服务发现功能使得服务的注册和发现变得更加简单和直观，从而方便实现服务的动态调度和负载均衡。这种结合增强了系统的健壮性和扩展性，使得服务治理更加灵活高效。

创建基础项目

初始化Spring Boot项目

首先，创建一个新的Spring Boot项目。使用Maven或Gradle构建工具初始化项目，这里以Maven为例，项目名称为gateway-nacos，并在pom.xml文件中添加必要的依赖项。

<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">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>gateway-nacos</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <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>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>2021.0.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2021.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>
``

此项目结构中，`pom.xml`文件包含了Spring Boot 2.5.5版本的依赖管理，以及Spring Cloud Gateway、Nacos Discovery和Nacos Config的相关依赖。这些依赖确保项目能够正确使用Spring Cloud Gateway和Nacos服务。

### 添加Gateway和Nacos依赖
在`pom.xml`文件中，已经添加了Spring Cloud Gateway、Nacos Discovery和Nacos Config的相关依赖。接下来，在`src/main/java`目录下创建一个基本的Spring Boot启动类。该启动类需要配置Spring Cloud Gateway和Nacos Discovery，以确保项目能够正确运行。

```java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayNacosApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayNacosApplication.class, args);
    }
}
``

在启动类中，通过`@EnableDiscoveryClient`注解启用了Nacos服务发现功能。`@SpringBootApplication`注解包含@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解，用于Spring Boot的自动配置、组件扫描和应用的基本配置。

## 配置Nacos服务发现

### 添加Nacos配置中心依赖
Nacos配置中心依赖已在`pom.xml`文件中添加。接下来，在`src/main/resources`目录下创建`bootstrap.yml`文件，用于配置Nacos服务的相关参数。这个文件是Spring Boot应用的启动配置文件。

```yaml
spring:
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848
        namespace: # 如果有命名空间，填写
        group: DEFAULT_GROUP # 如果未填写，默认使用DEFAULT_GROUP
      discovery:
        server-addr: 127.0.0.1:8848
application:
  name: gateway-nacos

bootstrap.yml文件中，spring.cloud.nacos.config.server-addr配置Nacos配置中心地址，spring.cloud.nacos.discovery.server-addr配置Nacos服务发现地址。spring.application.name配置当前应用名称，用于注册Nacos服务发现。spring.cloud.nacos.config.namespace和spring.cloud.nacos.config.group可根据需要配置。

配置Nacos服务发现

除了@EnableDiscoveryClient注解外，还需要配置服务注册到Nacos。通常在配置文件中已经定义了服务注册的相关参数，但为了确保服务能够正确注册到Nacos，在启动类中添加一些配置。在src/main/resources目录下创建application.yml文件，用于配置服务注册的相关参数。

server:
  port: 8080

spring:
  cloud:
  gateway:
    discovery:
      locator:
        enabled: true
        # 如果有多个服务同名，使用此属性
        # services:
  # discovery:
    # 如果未填写，默认值
    # server-addr: 127.0.0.1:8848
    # namespace: # 如果有命名空间，填写
    # group: DEFAULT_GROUP # 如果未填写，默认使用DEFAULT_GROUP

在application.yml文件中，spring.cloud.gateway.discovery.locator.enabled配置Spring Cloud Gateway启用服务发现功能，spring.cloud.gateway.discovery.locator.services配置需要服务发现的服务列表（可选）。spring.cloud.nacos.discovery配置服务发现的相关参数，包括Nacos服务地址、命名空间和分组等。

配置服务注册与发现

最后，在Nacos服务列表中查看是否成功注册了gateway-nacos服务。如果是第一次使用Nacos，需要手动启动Nacos服务，并配置Nacos服务的相关参数。启动Nacos服务后，可以通过Nacos的Web界面查看注册的服务列表，确认gateway-nacos服务是否已成功注册。

配置Gateway路由

添加Gateway路由规则

Spring Cloud Gateway通过路由规则实现服务间的请求转发。路由规则定义了请求如何从网关转发到后端服务。在application.yml文件中定义路由规则。

spring:
  cloud:
  gateway:
    routes:
    - id: service1_route
      uri: lb://service1
      predicates:
      - Path=/service1/**
      filters:
      - StripPrefix=1

此配置文件中，定义了一个路由规则，id为service1_route，请求路径匹配/service1/**，将请求转发到service1服务。StripPrefix过滤器用于去除请求路径中的前缀。

配置路由转发规则

除了基本的路由规则外，还可以配置更多过滤器，如RewritePath过滤器，用于重写请求路径，或者SetStatus过滤器，用于设置HTTP响应状态码等。这些过滤器可组合使用，实现更复杂的路由规则。

spring:
  cloud:
  gateway:
    routes:
    - id: service2_route
      uri: lb://service2
      predicates:
      - Path=/service2/**
      filters:
      - RewritePath=/service2/(?<segment>.*), /service2/$\{segment}
      - SetStatus=404

此配置文件中，定义了一个路由规则，id为service2_route，请求路径匹配/service2/**，将请求转发到service2服务。RewritePath过滤器用于重写请求路径，去掉路径中的service2/前缀。SetStatus过滤器用于设置HTTP响应状态码为404。

通过Nacos动态更新路由规则

Nacos不仅支持配置中心的动态更新，还可以用于路由规则的动态更新。在application.yml文件中配置Nacos动态更新路由规则。

spring:
  cloud:
  gateway:
    discovery:
      locator:
        enabled: true
        # 如果有多个服务同名，使用此属性
        # services:
  # discovery:
    # 如果未填写，默认值
    # server-addr: 127.0.0.1:8848
    # namespace: # 如果有命名空间，填写
    # group: DEFAULT_GROUP # 如果未填写，默认使用DEFAULT_GROUP

此配置文件中，spring.cloud.gateway.discovery.locator.enabled配置了Spring Cloud Gateway启用服务发现功能，使得路由规则可以根据服务变化动态更新。通过Nacos的Web界面，可以动态修改服务注册的相关参数，实现路由规则的动态更新。

实战案例演示

构建一个简单的API网关

构建一个简单的API网关，用于转发请求到后端服务。在application.yml文件中定义两个路由规则，分别转发请求到两个不同的后端服务。

spring:
  cloud:
  gateway:
    routes:
    - id: service1_route
      uri: lb://service1
      predicates:
      - Path=/service1/**
      filters:
      - StripPrefix=1
    - id: service2_route
      uri: lb://service2
      predicates:
      - Path=/service2/**
      filters:
      - RewritePath=/service2/(?<segment>.*), /service2/$\{segment}

此配置文件中，定义了两个路由规则，id分别为service1_route和service2_route。第一个路由规则将路径匹配/service1/**的请求转发到service1服务，并去除路径中的前缀service1/。第二个路由规则将路径匹配/service2/**的请求转发到service2服务，并重写路径中的前缀service2/。

使用Gateway和Nacos实现服务路由

在Nacos服务列表中注册了两个服务，分别为service1和service2。通过Nacos的Web界面，可以动态修改服务的注册信息，实现服务路由的动态更新。

测试路由转发功能

测试路由转发功能，可以通过浏览器或Postman工具发送请求到网关，查看请求是否正确转发到后端服务。例如，发送一个GET请求到http://localhost:8080/service1/hello，查看请求是否正确转发到service1服务。

总结与后续步骤

本次实战学习总结

本次实战学习主要介绍了如何使用Spring Cloud Gateway和Nacos构建一个简单的API网关，实现了服务的动态路由和配置管理。通过Spring Cloud Gateway的路由规则，可以灵活配置请求转发规则，而通过Nacos的动态配置功能，能够实现路由规则的动态更新。这种结合增强了系统的灵活性和可维护性，使得服务治理更加简单高效。

Gateway与Nacos配置常见问题解答

Q: 如何解决Spring Cloud Gateway与Nacos集成的问题？

A: 在pom.xml文件中添加Spring Cloud Gateway和Nacos的依赖，并在bootstrap.yml和application.yml文件中配置相关参数。确保服务发现和配置中心的地址配置正确，同时在启动类中启用服务发现功能。

Q: 如何动态更新路由规则？

A: 通过Nacos的Web界面，可以动态修改服务注册的相关参数，实现路由规则的动态更新。确保在application.yml文件中配置了服务发现功能，并启用动态更新。

推荐的进一步学习资源

这些资源可以帮助进一步深入学习Spring Cloud Gateway和Nacos的相关知识，更好地理解和应用它们。

点击查看更多内容
发表于 2024.11.08 14:41， 共 111 人浏览

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

举报
为 TA 点赞

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

评论

作者其他优质文章

正在加载中

阿波罗的战车

手记
篇
粉丝
19
获赞与收藏
86

关注作者，订阅最新文章

阅读免费教程

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

100积分直接送

付费专栏免费学

大额优惠券免费领

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

举报

0/150
提交
取消