springboot/springCloud微服务注册中心使用Nacos替换Eureka方案

一、概述

此文用于指导从Eureka切换成Eureka方案推荐
Nacos介绍与作为注册中心与Eureka对比链接：https://www.jianshu.com/p/afd7776a64c6

二、Nacos安装部署

推荐使用集群部署

2.1集群部署架构图

因此开源的时候推荐用户把所有服务列表放到一个vip下面，然后挂到一个域名下面

http://ip1:port/openAPI 直连ip模式，机器挂则需要修改ip才可以使用。

http://VIP:port/openAPI 挂载VIP模式，直连vip即可，下面挂server真实ip，可读性不好。

http://nacos.com:port/openAPI 域名 + VIP模式，可读性好，而且换ip方便，推荐模式

deployDnsVipMode.jpg

2.2 安装Nacos

可以通过源码和发行包两种方式来获取 Nacos。

从 Github 上下载源码方式

git clone https://github.com/alibaba/nacos.git
cd nacos/
mvn -Prelease-nacos clean install -U  
ls -al distribution/target/

// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin

下载编译后压缩包方式

您可以从 最新稳定版本 下载 nacos-server-$version.zip 包。

unzip nacos-server-$version.zip 或者 tar -xvf nacos-server-$version.tar.gz
  cd nacos/bin

2.3. 配置集群配置文件

在nacos的解压目录nacos/的conf目录下，有配置文件cluster.conf，请每行配置成ip:port。(请配置3个或3个以上节点)

# ip:port
200.8.9.16:8848
200.8.9.17:8848
200.8.9.18:8848

2.4. 配置 MySQL 数据库

生产使用建议至少主备模式，或者采用高可用数据库。

初始化 MySQL 数据库

sql语句源文件

application.properties 配置

application.properties配置文件

2.5. 启动服务器

Linux/Unix/Mac

启动命令(在没有参数模式，是集群模式):

sh startup.sh

三、改造内容

以SpringCloud项目为例

3.1 maven依赖改造

首先去除Eureka相关依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>0.2.1.RELEASE</version>
<!-- 这里排除springcloudnacos自带的nacos clinet-->
    <exclusions>
        <exclusion>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>0.2.1.RELEASE</version>
    <exclusions>
        <exclusion>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- 使用最新版本的的nacos clinet-->
<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-client</artifactId>
    <version>最新版本</version>
</dependency>

先把eureka相关依赖删除，再把spring-cloud-starter-alibaba-nacos里面的nacos-clinet相关的依赖排除，使用client对应版本的nacos。

3.2 配置文件改造

由于配置中心优先级问题，配置中心配置参数需要写在bootstrap.properties里面在bootstrap里增加如下：

spring.cloud.nacos.config.server-addr=127.0.0.1:18847
spring.cloud.nacos.config.namespace=9f288251-7c62-4041-b816-63e1a4b54112
spring.cloud.nacos.config.group=XXXXX

其中server-addr为nacos的地址，namespace为nacos控制台配置的相应环境对应的编码(dev/test/gray/produce)，涉及到springboot启动初始化组件的顺序，配置中心相关初始化数据必须放在bootstrap.properties更改application-XXX.properties

spring.cloud.nacos.discovery.server-addr=127.0.0.1:18847
spring.cloud.nacos.discovery.namespace=9f288251-7c62-4041-b816-63e1a4b54112

其中server-addr为nacos的地址，namespace为nacos控制台配置的相应环境对应的编码(dev/test/gray/produce)

3.3 更改项目主类注解

更改springboot主类的@EnableEurekaClient注解，更改为SpringCould原生注解@EnableDiscoveryClient

3.4 日志文件改造

由于目前Nacos心跳日志等日志较多，建议把nacos包的日志单独打印或者打印warn级别以上的，info级别的参考配置如下，指定com.alibaba.nacos日志输出到目录${LOG_DIR}/${INFO_DIR}/${app_id}-nacos-info.log，也可以配置成warn级别

<!--nacos-->
<appender name="RollingFile-INFO-Nacos-Appender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <OnMatch>ACCEPT</OnMatch>
        <OnMismatch>DENY</OnMismatch>
    </filter>
    <file>${LOG_DIR}/${INFO_DIR}/${app_id}-nacos-info.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${LOG_DIR}/${INFO_DIR}/${app_id}-nacos-info.%d{yyyy-MM-dd}.gz</fileNamePattern>
    </rollingPolicy>
    <encoder>
        <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}]\t${ip}\t${app_id}\t%le\t[%t]\t%lo\t%M\t%L\t[%m]%n</pattern>
        <charset>utf8</charset>
    </encoder>
</appender>
<appender name ="ASYNC-INFO-Nacos" class= "ch.qos.logback.classic.AsyncAppender">
    <!-- 不丢失日志.默认如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
    <discardingThreshold>0</discardingThreshold>
    <queueSize>10240</queueSize>
    <includeCallerData>true</includeCallerData>
    <appender-ref ref ="RollingFile-INFO-Nacos-Appender"/>
</appender>
<logger name="com.alibaba.nacos" level="INFO" additivity="false">
    <appender-ref ref="Console-Appender"/>

四、Nacos替换Eureka后的上线方案

4.1 阶段一：测试阶段

操作步骤：在测试阶段，首先搭建Nacos集群，创建若干个测试demo项目，互相调用，以确定模板。对各服务进行改造，在测试环境机器部署各服务，进行测试。验收标准：各中心互相使用feign调用成功，各中心在注册中心上线下线状态以及路由正确性。应急和回滚方案：查找问题，继续重试，有无法解决的问题暂时回滚测试环境风险分析：无风险

初始状态

4.2 阶段二：灰度阶段

操作步骤：首先把线上环境的Nginx对应解析去除与Nacos服务器上gw的映射关系。对线上服务器： 进行服务下线操作(停线程池等)并备份，在以上机器的服务部署灰度环境用的nacos注册中心的包。部署完毕后以Nacos注册的gw为入口，对服务进行简单测试。(停用线程池，测试不涉及在线业务相关)验收标准：Nacos集群各中心互相使用feign调用成功，各中心在注册中心上线下线状态以及路由符合正常逻辑。涉及微服务间调用的功能正常风险分析：Eureka集群承受全部流量，可用性降低低，建议这个阶段快速测试。应急和回滚方案：查找问题，继续重试，如果解决不了问题则下线Nacos集群服务，启动操作步骤里备份的Eureka服务

灰度阶段

4.3 阶段三：金丝雀测试

操作步骤：在Nginx入口处分出一小部分流量到Nacos集群的GW并开启线程池。观察Nacos集群中各中心的日志是否有异常情况出现。测试过程中可以逐渐增加到naocs-gw的流量。观察一个星期。验收标准：Nacos集群各中心日志正常，Nacos微服务间调用无异常情况出现，订购可以成功，文件服务功能正常。风险分析：Nacos集群可能出现不明问题，最严重的情况回影响Nacos集群服务之间的调用应急和回滚方案：如果发现有严重问题，马上联系运维切断Nginx到Nacos集群GW的流量，并关闭线程池，即如图二的集群状态。回到阶段二步骤测试、验收或者回滚。

金丝雀测试

4.4 阶段四：流量全切到Nacos集群

操作步骤：在金丝雀测试之后确定服务完全稳定了，把Nginx的流量全量切到nacos的gw，这时候全部的流量通过Naocs集群。观察若干小时后对原Eureka集群服务进行下线操作(包含停线程池等操作)，并备份(相当于冷备)。验收标准：Nacos集群各中心日志正常，Nacos微服务间调用无异常情况出现，订购可以成功，文件服务功能正常。风险分析：这个阶段Nacos集群为单机模式承受全部流量。可能会有之前未发现的问题，如有异常及时按照应急回滚方案操作。建议在流量较少的时候施工应急和回滚方案：如果发现有处理不了的故障，马上联系运维启动Eureka集群，并把nacos-gw的流量切断改为把流量代理到eureka-gw，恢复到阶段二的状态。查找问题，解决问题并重新测试，按照阶段流程来操作。

阶段四：流量全切到Nacos集群

4.5 阶段五：Nacos剩余服务实例上线

操作步骤：在原Eureka服务器上部署Nacos服务如图五所示，待服务全部起来后，nginx的流量在两台gw中负载均衡。验收标准：Nacos新增集群和原来的集群各中心日志正常，Nacos微服务间调用无异常情况出现，订购可以成功，文件服务功能正常。风险分析：暂无，待补充应急和回滚方案：如果发现有较严重问题，下线新上线的注册Nacos的服务，切断到nacos-gw的流量，回退到阶段四。

阶段五：Nacos剩余服务实例上线