Spring-Cloud-Zuul与Spring-Cloud-Alibaba-Nacos整合

nacos.png

什么是 Nacos？

Nacos 是阿里巴巴推出来的开源项目Spring-Cloud-Alibaba中的一个子项目，这是一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。

Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。

官网：https://nacos.io

源码：https://github.com/alibaba/nacos

下载Nacos服务端压缩包：https://github.com/alibaba/nacos/releases

全景图：

image.png

架构及概念：

image.png

服务 (Service)
服务是指一个或一组软件功能（例如特定信息的检索或一组操作的执行），其目的是不同的客户端可以为不同的目的重用（例如通过跨进程的网络调用）。Nacos 支持主流的服务生态，如 Kubernetes Service、gRPC|Dubbo RPC Service 或者 Spring Cloud RESTful Service.

服务注册中心 (Service Registry)
服务注册中心，它是服务，其实例及元数据的数据库。服务实例在启动时注册到服务注册表，并在关闭时注销。服务和路由器的客户端查询服务注册表以查找服务的可用实例。服务注册中心可能会调用服务实例的健康检查 API 来验证它是否能够处理请求。

服务元数据 (Service Metadata)
服务元数据是指包括服务端点(endpoints)、服务标签、服务版本号、服务实例权重、路由规则、安全策略等描述服务的数据

服务提供方 (Service Provider)
是指提供可复用和可调用服务的应用方

服务消费方 (Service Consumer)
是指会发起对某个服务调用的应用方

配置 (Configuration)
在系统开发过程中通常会将一些需要变更的参数、变量等从代码中分离出来独立管理，以独立的配置文件的形式存在。目的是让静态的系统工件或者交付物（如 WAR，JAR 包等）更好地和实际的物理运行环境进行适配。配置管理一般包含在系统部署的过程中，由系统管理员或者运维人员完成这个步骤。配置变更是调整系统运行时的行为的有效手段之一。

配置管理 (Configuration Management)
在数据中心中，系统中所有配置的编辑、存储、分发、变更管理、历史版本管理、变更审计等所有与配置相关的活动统称为配置管理。

名字服务 (Naming Service)
提供分布式系统中所有对象(Object)、实体(Entity)的“名字”到关联的元数据之间的映射管理服务，例如 ServiceName -> Endpoints Info, Distributed Lock Name -> Lock Owner/Status Info, DNS Domain Name -> IP List, 服务发现和 DNS 就是名字服务的2大场景。

配置服务 (Configuration Service)
在服务或者应用运行过程中，提供动态配置或者元数据以及配置管理的服务提供者。

Nacos VS Spring Cloud Eureka
相对于 Spring Cloud Eureka 来说，Nacos 更强大。

Nacos = Spring Cloud Eureka + Spring Cloud Config

Nacos 可以与 Spring, Spring Boot, Spring Cloud 集成，并能代替 Spring Cloud Eureka, Spring Cloud Config。

通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-config 实现配置的动态变更。
通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-discovery 实现服务的注册与发现。

安装Nacos

下载地址：https://github.com/alibaba/nacos/releases
安装参考：https://nacos.io/zh-cn/docs/what-is-nacos.html

配置数据持久化

目前Nacos仅支持Mysql数据库，且版本要求：5.6.5+

Nacos的数据库脚本文件在我们下载Nacos-server时的压缩包中就有

进入nacos-server-1.1.3\nacos\conf目录，初始化文件：nacos-mysql.sql

此处我创建一个名为 mynacos 的数据库，然后执行初始化脚本，成功后会生成 11 张表

image.png

这里是需要修改Nacos-server的配置文件

Nacos-server其实就是一个Java工程或者说是一个Springboot项目，他的配置文件在nacos-server-1.1.3\nacos\conf目录下，名为 application.properties，在文件底部添加数据源配置：

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/mynacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=123456

启动与关闭服务

#linux平台
[root@nacos-71 nacos]# /usr/local/nacos/bin/startup.sh -m standalone

[root@nacos-71 nacos]# /usr/local/nacos/bin/shutdown.sh

# windows平台
startup.cmd -m standalone

shutdown.cmd

网关微服务接入Nacos注册中心

引入maven依赖：

<modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yibo</groupId>
    <artifactId>server-gateway</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <!--SpringCloudOAuth2相关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-oauth2</artifactId>
        </dependency>

        <!--Spring Cloud Zuul 网关相关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>

        <!--Nacos服务发现与注册相关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>28.1-jre</version>
        </dependency>

        <!--spring-cloud-zuul-ratelimit限流-->
        <dependency>
            <groupId>com.marcosbarbero.cloud</groupId>
            <artifactId>spring-cloud-zuul-ratelimit</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!-- 高版本redis的lettuce需要commons-pool2 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <!--整合Spring Cloud-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <!--整合Spring Cloud Alibaba-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>0.9.0.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

添加配置信息

server:
  port: 9070
zuul:
  host:
    connect-timeout-millis: 3000
    socket-timeout-millis: 3000
  routes:
    #这里没有使用服务发现组件，所以将服务服务地址写死
    token:
      url: http://localhost:9090
    orderServer:
      path: /orders/**
      serviceId: orderServer
#      url: http://localhost:9060
    priceServer:
      path: /prices/**
      serviceId: priceServer
    #这里配置user服务只是需要用此在MFfilter上处理，不是向下转发
#    user:
#      url: http://localhost:9060
  #zuul.sensitiveHeaders设置为空，代表不过滤任何Header信息，Header会向下转发
  sensitive-headers:
  ratelimit:
    enabled: true
    repository: redis  #对应存储类型（用来存储统计信息）
    behind-proxy: true  #代理之后
    default-policy-list: #可选 - 针对所有的路由配置的策略，除非特别配置了policies
    - limit: 100 #可选 - 每个刷新时间窗口对应的请求数量限制
      quota: 1000 #可选-  每个刷新时间窗口对应的请求时间限制（秒）
      refresh-interval: 60 # 刷新时间窗口的时间，默认值 (秒)
      type: #可选 限流方式
        - url
        - httpmethod
        - origin
    policy-list: #可选 - 针对所有的路由配置的策略，除非特别配置了policies
      token: #特定的路由
      - limit: 100 #可选 - 每个刷新时间窗口对应的请求数量限制
        quota: 100 #可选-  每个刷新时间窗口对应的请求时间限制（秒）
        refresh-interval: 3 # 刷新时间窗口的时间，默认值 (秒)
        type: #可选 限流方式
          - url
          - httpmethod
          - origin
spring:
  redis:
    database: 0
    host: 127.0.0.1
    jedis:
      pool:
        #最大连接数据库连接数,设 0 为没有限制
        max-active: 8
        #最大等待连接中的数量,设 0 为没有限制
        max-idle: 8
        #最大建立连接等待时间。如果超过此时间将接到异常。设为-1表示无限制。
        max-wait: -1ms
        #最小等待连接中的数量,设 0 为没有限制
        min-idle: 0
    lettuce:
      pool:
        max-active: 8
        max-idle: 8
        max-wait: -1ms
        min-idle: 0
      shutdown-timeout: 100ms
    password:
    port: 6379
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
        # 指定namespace 这个可以做到开发环境，预发环境，线上环境的隔离，同环境才可以调用
        namespace: cede430e-9610-42ba-9a1e-11bd98ab747e
        # 同城集群名称，需要改造Ribbon优先调用同城集群，同城集群不可用时可以跨城调用，用于异地灾备
        cluster-name: shanghai
        metadata:
          # 自己这个实例的版本
          version: V1
          # 允许调用的提供者版本
          target-version: V1
security:
  oauth2:
    client:
      #这里的数据和数据库表中记录对应
      client-id: gateway
      client-secret: 123456
    resource:
      jwt:
        key-uri: http://auth.yibo.com:9090/oauth/token_key

启动网关微服务，在Nacos的服务列表页面查看服务列表，可以看到服务名为gateway的网关微服务已经注册到了Nacos，点击详情按钮，可以看到当前服务的集群状态、端口信息以及健康状态等：

image.png

注意：

此篇文档因为结合了SpringCloudOAuth2，网关作为OAuth2中的资源服务器，需要OAuth2的认证服务器搭配才能启动，如想启动需要去掉OAuth2依赖，或搭建认证服务器

参考：

Spring Cloud与Alibaba Nacos整合
 https://www.cnblogs.com/larscheng/p/11422909.html