SpringCloudAlibabaNacos配置管理应用于分布式系统-永久免费的源码丞旭猿

从单体架构到微服务

单体架构：

Web应用程序发展的早期，大部分web工程师将所有的功能模块打包到一起并放在一个web容器中运行，所有功能 模块使用同一个数据库，同时，它还提供API或者UI访问的web模块等。

尽管也是模块化逻辑，但是最终它还是会打包并部署为单体式应用，这种将所有功能都部署在一个web容器中运行的系统就叫做单体架构（也叫：巨石型应用）。

单体架构有很多好处：

开发效率高：模块之间交互采用本地方法调用，并节省微服务之间的交互讨论时间与开发成本。容易测试：IDE都是为开发单个应用设计的、容易测试——在本地就可以启动完整的系统。容易部署：运维成本小，直接打包为一个完整的包，拷贝到web容器的某个目录下即可运行。但是，上述的好处是有条件的，它适用于小型简单应用，对于大规模的复杂应用，就会展现出来以下的不足：复杂性逐渐变高，可维护性逐渐变差 ：所有业务模块部署在一起，复杂度越来越高，修改时牵一发动全身。版本迭代速度逐渐变慢：修改一个地方就要将整个应用全部编译、部署、启动时间过长、回归测试周期过长。阻碍技术创新：若更新技术框架，除非你愿意将系统全部重写，无法实现部分技术更新。无法按需伸缩：通过冗余部署完整应用的方式来实现水平扩展，无法针对某业务按需伸缩。微服务：

许多大型公司，通过采用微服务架构解决了上述问题。其思路不是开发一个巨大的单体式的应用，而是将应用分解为小的、互相连接的微服务。

一个微服务一般完成某个特定的功能，比如订单服务、用户服务等等。每一个微服务都是完整应用，都有自己的业务逻辑和数据库。一些微服务还会发布API给其它微服务和应用客户端使用。

比如，根据前面描述系统可能的分解如下：

每一个业务模块都使用独立的服务完成，这种微服务架构模式也影响了应用和数据库之间的关系，不像传统多个业务模块共享一个数据库，微服务架构每个服务都有自己的数据库。

微服务架构的好处：

分而治之，职责单一；易于开发、理解和维护、方便团队的拆分和管理可伸缩；能够单独的对指定的服务进行伸缩局部容易修改，容易替换，容易部署，有利于持续集成和快速迭代不会受限于任何技术栈分布式应用配置管理

下图展示了如何通过Nacos集中管理多个服务的配置：

用户通过Nacos Server的控制台集中对多个服务的配置进行管理。

各服务统一从Nacos Server中获取各自的配置，并监听配置的变化。

1.发布配置

首先在nacos发布配置，我们规划了两个服务service1、service2，并且想对这两个服务的配置进行集中维护。 浏览器访问官网 ，打开nacos控制台，并点击菜单配置管理->配置列表： 在Nacos添加如下的配置：

service1

Namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境

Data ID: service1.yaml

Group : TEST_GROUP

配置格式: YAML

配置内容： common:

name: service1 config

service2

Namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境

Data ID: service2.yaml

Group : TEST_GROUP

配置格式: YAML

配置内容： common:

name: service2 config

2.创建父工程

为了规范依赖的版本，这里创建父工程，指定依赖的版本。

父工程pom.xml如下：

xmlns:xsi=”w3.org/2001/XMLSchemainstance”xsi:schemaLocation=”maven.apache.org/POM/4.0.0maven.apache.org/xsd/maven4.0.0.xsd”>4.0.0com.itheima.nacosnacosconfig1.0SNAPSHOTpomUTF8UTF81.8com.alibaba.cloudspringcloudalibabadependencies2.1.0.RELEASEpomimportorg.springframework.cloudspringclouddependenciesGreenwich.RELEASEpomimportorg.springframework.bootspringbootdependencies2.1.3.RELEASEpomimportorg.springframework.bootspringbootmavenplugin

微服务service1配置

本小节，我们将演示如何使用 Spring Cloud Alibaba Nacos Confifig在Spring Cloud应用中集成Nacos，通过Spring cloud原生方式快捷的获取配置内容。

Spring Cloud是什么：

Spring Cloud是一系列框架的有序集合。它利用Spring Boot的开发便利性巧妙地简化了分布式系统基础设 施的开发，如服务发现注册、配置中心、消息总线、负载均衡、断路器、数据监控等，都可以用Spring Boot 的开发风格做到一键启动和部署。Spring Cloud并没有重复制造轮子，它只是将目前各家公司开发的比较成 熟、经得起实际考验的服务框架组合起来，集成最多的组件要属Netflflix公司，通过Spring Boot风格进行再封 装屏蔽掉了复杂的配置和实现原理，最终给开发者留出了一套简单易懂、易部署和易维护的分布式系统开发 工具包。

Spring Cloud Alibaba Nacos Config是什么：

Spring Cloud Alibaba Nacos Discovery是Spring Cloud Alibaba的子项目，而Spring Cloud Alibaba是阿 里巴巴公司提供的开源的基于Spring cloud的微服务套件合集，它致力于提供微服务开发的一站式解决方 案，可以理解为spring cloud是一套微服务开发的 标准 ，spring cloud alibaba与spring cloud Netflflix是实 现。使用 Spring Cloud Alibaba方案，开发者只需要添加一些注解和少量配置，就可以将 Spring Cloud 应用 接入阿里分布式应用解决方案，通过阿里中间件来迅速搭建分布式应用系统。

由于Nacos是阿里的中间件，因此，若开发Spring cloud微服务应用，使用Spring Cloud Alibaba Nacos Confifig来集成Nacos的配置管理功能是比较明智的选择。

（1）新建项目service1

首先新增一个名为service1工程，并添加group ID 为 com.alibaba.cloud 和 artifact ID 为 spring-cloud-starter-alibaba-nacos-config 的 starter。

nacosconfigcom.itheima.nacos1.0SNAPSHOT4.0.0service1com.alibaba.cloudspringcloudstarteralibabanacosconfigorg.springframework.bootspringbootstarterweb

（2）bootstrap.yml配置

一般来说，spring boot的配置将在application.yml(也可以是application.properties)文件中编写， 由于使用外部

配置中心，必须将原先的application.yml重命名为bootstrap.yml，bootstrap.yml如下所示：spring.cloud.nacos.confifig.server-addr 指定了Nacos Server的网络地址和端口号。

server:port: 56010 启动端口 命令行注入spring:application:name: service1cloud:nacos:config:serveraddr: 127.0.0.1:8848 配置中心地址fileextension: yamlnamespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境group: TEST_GROUP 测试组

以上配置文件说明该应用将从地址为127.0.0.1:8848配置中心获取配置，通过以下信息定位配置集：

namespace：c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境

group：TEST_GROUP 测试组

Data Id：service1.yaml

Note：spring-cloud-starter-alibaba-nacos-confifig 在加载配置的时候，加载了以 dataid 为 ${spring.application.name}.${file-extension:properties} 的基础配置。对应以上的配置，它会去 nacos server中加载data id为service1.yaml的配置集。 Note: 若没有指定spring.cloud.nacos.confifig.group配置,则默认为DEFAULT_GROUP。

（3）启动配置客户端

新增Spring Boot 启动类，并增加获取配置的web访问端点/confifigs，通过标准的spring @Value 方式

package com.itheima.nacos;@SpringBootApplication@RestControllerpublic class Service1Bootstrap {public static void main(String[] args) {SpringApplication.run(Service1Bootstrap.class, args);}@Value(“${common.name}”)private String config1;@GetMapping(value = “/configs”)public String getConfigs(){return config1;}}

微服务service2

配置 service2的创建流程与service1一致： 需要注意的是spring boot 启动端口要避免重复，spring.application.name为service2。

server:port: 56020 启动端口 命令行注入spring:application:name: service2cloud:nacos:config:serveraddr: 127.0.0.1:8848 配置中心地址fileextension: yamlnamespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境group: TEST_GROUP 测试组

分别启动service1和service2项目，并分别访问 /confifigs进行测试，不同项目能够获取各自的配置内容。

3.支持配置的动态更新

基于上面快速上手的例子，若要实现配置的动态更新，只需要进行如下改造：

// 注入配置文件上下文@Autowiredprivate ConfigurableApplicationContext applicationContext;@GetMapping(value = “/configs”)public String getConfigs(){return applicationContext.getEnvironment().getProperty(“common.name”);}

我们通过nacos控制台更新common.name的配置值，再次访问web端点/confifigs，发现应用程序能够获取到最新 的配置值，说明spring-cloud-starter-alibaba-nacos-confifig 支持配置的动态更新。 Note 可以通过配置spring.cloud.nacos.confifig.refresh.enabled=false来关闭动态刷新

4 自定义 namespace与group配置

支持自定义 namespace的配置

在没有明确指定 ${spring.cloud.nacos.config.namespace} 配置的情况下， 默认使用的是 Nacos 上 Public 这个namespace。如果需要使用自定义的命名空间，可以通过以下配置来实现：

spring:cloud:nacos:config:namespace: b3404bc0d7dc4855b519570ed34b62d7

Note：该配置必须放在 bootstrap.yml文件中。此外 spring.cloud.nacos.config.namespace 的值是 namespace对应的 id，id 值可以在 Nacos 的控制台获取。并且在添加配置时注意不要选择其他的 namespae，否则将会导致读取不到正确的配置。

支持自定义 Group 的配置

在没有明确指定 ${spring.cloud.nacos.config.group} 配置的情况下， 默认使用的是 DEFAULT_GROUP 。如果需要自定义自己的 Group，可以通过以下配置来实现：

spring:loud:nacos:config:group: DEVELOP_GROUP

Note：该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值一定要和spring.cloud.nacos.config.group 的配置值一致。

5 自定义扩展的 Data Id 配置

Spring Cloud Alibaba Nacos Confifig可支持自定义 Data Id 的配置。 一个完整的配置案例如下所示：下边我们在service2微服务下配置扩展。

spring:application:name: service2cloud:nacos:config:serveraddr: 127.0.0.1:8848config external configuration1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新extconfig[0]:dataid: extconfigcommon01.properties2、Data Id 不在默认的组，不支持动态刷新extconfig[1]:dataid: extconfigcommon02.propertiesgroup: GLOBALE_GROUP3、Data Id 既不在默认的组，也支持动态刷新extconfig[2]:dataid: extconfigcommon03.propertiesgroup: REFRESH_GROUPrefresh: true

可以看到:

通过 spring.cloud.nacos.config.ext-config[n].data-id 的配置方式来支持多个 Data Id 的配置。通过 spring.cloud.nacos.config.ext-config[n].group 的配置方式自定义 Data Id 所在的组，不明确配置的话，默认是 DEFAULT_GROUP。通过 spring.cloud.nacos.config.ext-config[n].refresh 的配置方式来控制该 Data Id 在配置变更时，是否支持应用中可动态刷新， 感知到最新的配置值。默认是不支持的。Note ： spring.cloud.nacos.config.ext-config[n].data-id 的值必须带文件扩展名，文件扩展名既可支持 properties，又可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩 展配置的 Data Id 文件扩展名没有影响。 通过自定义扩展的 Data Id 配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。 测试： 配置ext-confifig-common01.properties：

配置ext-confifig-common02.properties

配置ext-confifig-common03.properties

编写测试代码：

@GetMapping(value = “/configs2”)public String getConfigs2(){String name = applicationContext.getEnvironment().getProperty(“common.name”);String age = applicationContext.getEnvironment().getProperty(“common.age”);String address = applicationContext.getEnvironment().getProperty(“common.address”);String birthday= applicationContext.getEnvironment().getProperty(“common.birthday”);String fullname = applicationContext.getEnvironment().getProperty(“common.fullname”);return name+”+”+ age+”+”+address+”+”+ birthday+”+”+ fullname;}

重启应用，观察配置是否成功获取。 输出：

service2 config+12+beijing+199011+zhangsansanff

6 自定义共享 Data Id 配置

为了更加清晰的在多个应用间配置共享的 Data Id ，你可以通过以下的方式来配置：

spring:cloud:nacos:config:shareddataids: extconfigcommon01.properties,extconfigcommon02.properties refreshabledataids: extconfigcommon01.properties

可以看到：

通过 spring.cloud.nacos.config.shared-dataids 来支持多个共享 Data Id 的配置，多个之间用逗号隔开。通过 spring.cloud.nacos.config.refreshable-dataids 来支持哪些共享配置的 Data Id 在配置变化时，应 用中是否可动态刷新， 感知到最新的配置值，多个 Data Id 之间用逗号隔开。如果没有明确配置，默认情况 下所有共享配置的 Data Id 都不支持动态刷新。Note：通过 spring.cloud.nacos.config.shared-dataids 来支持多个共享配置的 Data Id 时， 多个共享配 置间的一个优先级的关系我们约定：按照配置出现的先后顺序，即后面的优先级要高于前面。Note：通过 spring.cloud.nacos.config.shared-dataids 来配置时，Data Id 必须带文件扩展名，文件扩 展名既可支持 properties，也可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的 配置对自定义扩展配置的 Data Id 文件扩展名没有影响。Note： spring.cloud.nacos.config.refreshable-dataids 给出哪些需要支持动态刷新时，Data Id 的值也 必须明确给出文件扩展名。

测试输出：

service2 config+12+beijing+null+null

为什么后边两个值为null?

共享DataId的配置使用默认的group即DEFAULT_GROUP，ext-confifig-common02.properties不属于DEFAULT_GROUP。

共享DataId的配置相比扩展的 Data Id 配置，它把group固定为DEFAULT_GROUP，建议使用扩展的 Data Id 配置，因为扩展的 Data Id 配置也可以实现共享DataId配置。

7 配置的优先级

Spring Cloud Alibaba Nacos Confifig 目前提供了三种配置能力从 Nacos 拉取相关的配置。

A: 通过 spring.cloud.nacos.config.shared-dataids 支持多个共享 Data Id 的配置B: 通过 spring.cloud.nacos.config.ext-config[n].data-id 的方式支持多个扩展 Data Id 的配置，多个Data Id 同时配置时，他的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id 其中 n 的值越大，优先级越高。C: 通过内部相关规则(应用名、扩展名 )自动生成相关的 Data Id 配置。当三种方式共同使用时，他们的一个优先级关系是:C > B >A测试，屏蔽共享dataId，放开ext-confifig，如下：

spring:application:name: service2cloud:nacos:config:serveraddr: 127.0.0.1:8848 配置中心地址fileextension: yamlnamespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 开发环境group: TEST_GROUPshareddataids: extconfigcommon01.properties,extconfigcommon02.propertiesconfig external configuration1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新extconfig[0]:dataid: extconfigcommon01.properties2、Data Id 不在默认的组，不支持动态刷新extconfig[1]:dataid: extconfigcommon02.propertiesgroup: GLOBALE_GROUP3、Data Id 既不在默认的组，也支持动态刷新extconfig[2]:dataid: extconfigcommon03.propertiesgroup: REFRESH_GROUPrefresh: true

修改ext-confifig-common03.properties：

输出：

service2 config aaa+15+beijing+199011+zhangsansanff

通过测试发现多个 Data Id 同时配置时，他的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id

其中 n 的值越大，优先级越高。

修改：service1.yaml

输出：

service2 config aaa+25+beijing+199011+zhangsansanff

通过测试发现：B和C同时存在，C优先级高。

8 完全关闭配置

通过设置 spring.cloud.nacos.confifig.enabled = false 来完全关闭 Spring Cloud Nacos Confifig

Nacos集群部署

1 集群部署

3个或3个以上Nacos节点才能构成集群

（1）安装3个以上Nacos

我们可以复制之前已经解压好的nacos文件夹，分别命名为nacos、nacos1、nacos2

（2）配置集群配置文件

在所有nacos目录的conf目录下，有文件 cluster.conf.example ，将其命名为 cluster.conf ，并将每行配置成

ip:port。（请配置3个或3个以上节点）

ip:port127.0.0.1:8848127.0.0.1:8849127.0.0.1:8850

由于是单机演示，需要更改nacos/的conf目录下application.properties中server.port，防止端口冲突。

如果服务器有多个ip也要指定具体的ip地址，如：nacos.inetutils.ip-address=127.0.0.1

例如：

server.port=8850nacos.inetutils.ipaddress=127.0.0.1

（3）集群模式启动

分别执行nacos目录的bin目录下的startup：

startup m cluster

在任意一个nacos的控制台中，可以看到如下内容：

2 客户端配置

所有客户端，分别指定nacos集群中的若干节点：

spring:application:name: xxxxcloud:nacos:config:serveraddr: 127.0.0.1:8848,127.0.0.1:8849,127.0.0.1:8850

测试，使用快速上手的例子：

（1）关掉127.0.0.1:8848 nacos Leader实例，发现Leader被成功选举至127.0.0.1:8850

（2）紧接着重新启动Provider，这时马上请求consumer的/service出现错误，发现consumer与provider通信已经出现问题。但经过短暂的时间后，通信恢复。

通过测试，我们可以看到，通过以上的集群部署已经达到了高可用的效果。

3 生产环境部署建议

下图是官方推荐的集群方案，通过域名 + VIP模式的方式来实现。客户端配置的nacos，当Nacos集群迁移时，客户端配置无需修改

至于数据库，生产环境下建议至少主备模式。通过修改${nacoshome}/conf/application.properties文件，能够使nacos拥有多个数据源。

spring.datasource.platform=mysqldb.num=2db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&autoReconnect=truedb.url.1=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&autoReconnect=truedb.user=rootdb.password=root