配置Gateway+Nacos教程

本文详细介绍了如何配置Gateway+Nacos教程，包括准备工作、安装Gateway和Nacos的步骤，以及如何使Gateway使用Nacos进行服务发现和配置管理。通过本教程，你可以轻松实现微服务的动态路由和配置更新。

简介Gateway和Nacos

Gateway是Spring Cloud提供的一个API Gateway，用于作为微服务的统一入口，实现路由管理、负载均衡、限流等功能。它可以根据不同的路由规则转发请求到不同的后端服务。Gateway的核心是路由(Routes)，每个路由由一组断言(Predicates)和过滤器(Filter)组成。断言定义了路由触发的条件，而过滤器则对请求进行相应处理。

Nacos是一个动态服务发现、配置管理和服务管理平台，由阿里巴巴开源。Nacos提供了服务发现、配置管理和服务管理三大功能。服务发现功能帮助服务快速获取其他服务实例的信息；配置管理功能实时推送配置更新到应用；服务管理功能提供服务健康检测等功能。

准备工作

在安装和配置Gateway和Nacos之前，需要确保系统已安装并配置好以下环境：

• Java：确保已安装Java环境且版本不低于Java 8。可以通过以下命令检查Java版本：

  java -version

• Maven：确保已安装Maven，并且可以通过以下命令验证：

  mvn -v

• Nacos Server：需要预先安装Nacos服务端。可以从Nacos的GitHub仓库下载相应版本的Nacos Server。

安装Gateway

1. 创建SpringBoot项目

首先，创建一个Spring Boot项目，并添加Spring Cloud Gateway依赖。可以使用Spring Initializr或者手动创建Maven项目。

在项目中添加以下依赖：

<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>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2. 启用Spring Cloud Gateway

在主启动类中启用Spring Cloud Gateway：

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

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

3. 配置路由

在application.yml文件中配置路由规则：

spring:
  cloud:
    gateway:
      routes:
        - id: example_route
          uri: http://localhost:8080
          predicates:
            - Path=/api/**
          filters:
            - RewritePath=/api/(?<segment>.*), /$\{segment}

安装Nacos

1. 下载Nacos

从Nacos的GitHub仓库或其他官方渠道下载Nacos Server的最新版本。这里以Nacos Server的Linux版本为例：

wget https://github.com/alibaba/Nacos/releases/download/2.0.3/nacos-server-2.0.3.tar.gz

2. 解压Nacos文件

将下载的文件解压至指定目录：

tar -zxvf nacos-server-2.0.3.tar.gz
cd nacos

3. 启动Nacos

使用默认配置启动Nacos服务：

sh bin/startup.sh -m standalone

此时Nacos将会在8848端口启动，默认登录地址为http://localhost:8848/nacos。

配置Gateway使用Nacos

1. 添加Nacos注册中心依赖

在Spring Boot项目中，添加Nacos注册中心的依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2. 启用Nacos注册中心

在主启动类中启用Nacos注册中心：

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

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

3. 配置Nacos注册中心

在application.yml文件中添加Nacos注册中心的相关配置：

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

4. 添加Nacos配置中心依赖

为了从Nacos中动态获取配置，还需要添加Nacos配置中心的依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

5. 启用Nacos配置中心

在主启动类中启用Nacos配置中心：

import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.context.config.annotation.RefreshScope;

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

6. 配置Nacos配置中心

在bootstrap.yml文件中添加Nacos配置中心的相关配置：

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848
        file-extension: yaml

测试配置是否成功

1. 启动服务

启动Gateway服务：

mvn spring-boot:run

启动一个示例服务，可以通过Spring Boot项目创建一个简单的REST服务。例如，在src/main/java/com/example/demo/service/ExampleService.java中创建以下控制器：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExampleController {
    @GetMapping("/api/hello")
    public String hello() {
        return "Hello from example service!";
    }
}

在src/main/resources/application.yml中配置示例服务：

server:
  port: 8080

构建并启动示例服务：

mvn spring-boot:run -Dspring-boot.run.mainClass=com.example.demo.service.ExampleService

在application.yml中配置Gateway路由：

spring:
  cloud:
    gateway:
      routes:
        - id: example_route
          uri: lb://example-service
          predicates:
            - Path=/api/**
          filters:
            - RewritePath=/api/(?<segment>.*), /$\{segment}

2. 验证服务

访问以下URL验证服务是否正常：

curl http://localhost:8080/api/hello

如果一切正常，将会返回字符串"Hello from example service!"。

3. 配置动态刷新

在Nacos控制台中，可以新建一个配置，例如：

1. 登录Nacos控制台：http://localhost:8848/nacos
2. 创建一个配置文件，例如gateway-service.yaml，配置如下：

spring:
  cloud:
    gateway:
      routes:
        - id: dynamic_route
          uri: lb://example-service
          predicates:
            - Path=/dynamic/**

将配置保存后，Gateway服务会实时收到配置更新并生效，无需重启服务。

总结

通过上述步骤，成功地配置了Spring Cloud Gateway与Nacos的集成。Gateway作为API Gateway，负责路由服务，而Nacos提供服务发现和配置管理功能。通过Nacos动态刷新配置，可以灵活地管理和调整Gateway的路由策略，提高系统的可维护性和扩展性。

进一步学习

为了更深入地学习Spring Cloud Gateway和Nacos，可以参考以下资源：

• Spring Cloud Gateway官方文档
• Nacos官方文档
• Spring Cloud Alibaba官方文档