目录

Nacos配置中心简介

配置中心的思路是:

Nacos Config入门

Nacos配置实时更新及同一个微服务不同环境的差异化配置

1 搭建nacos环境【使用现有的nacos环境即可】(上篇文章有Nacos环境搭建)

2 在微服务公共模块中引入nacos的依赖

3 在微服务service-product中添加nacos config的配置

4 在nacos中添加配置

5 注释本地的application.yaml中的内容, 启动程序进行测试 如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现

Nacos Config深入

Nacos同一个微服务不同环境的共享配置

两种方式获取配置信息:

方式一: 硬编码方式

方式二: 注解方式(推荐)

配置共享

同一个微服务的不同环境之间共享配置

Nacos不同微服务的共享配置

nacos的几个概念

创建命名空间(Namespace)

命名空间

Nacos多环境切换

如何解决不同环境配置不同

不同微服务相同配置共享

bootstrap

什么配置在application配置?什么配置在bootstrap里面配置?

总结


Nacos配置中心简介

首先我们来看一下,微服务架构下关于配置文件的一些问题:

  1. 配置文件相对分散。在一个微服务架构下,配置文件会随着微服务的增多变的越来越多,而且分散 在各个微服务中,不好统一配置和管理。

  2. 配置文件无法区分环境。微服务项目可能会有多个环境,例如:测试环境、预发布环境、生产环 境。每一个环境所使用的配置理论上都是不同的,一旦需要修改,就需要我们去各个微服务下手动 维护,这比较困难。

  3. 配置文件无法实时更新。我们修改了配置文件之后,必须重新启动微服务才能使配置生效,这对一 个正在运行的项目来说是非常不友好的。 基于上面这些问题,我们就需要配置中心的加入来解决这些问题。

配置中心的思路是:

  • 首先把项目中各种配置全部都放到一个集中的地方进行统一管理,并提供一套标准的接口。

  • 当各个服务需要获取配置的时候,就来配置中心的接口拉取自己的配置。

  • 当配置中心中的各种参数有更新的时候,也能通知到各个服务实时的过来同步最新的信息,使之动 态更新。

当加入了服务配置中心之后,我们的系统架构图会变成下面这样: 在业界常见的服务配置中心,有下面这些:

  • Apollo Apollo是由携程开源的分布式配置中心。特点有很多,比如:配置更新之后可以实时生效,支持灰 度发布功能,并且能对所有的配置进行版本管理、操作审计等功能,提供开放平台API。并且资料 也写的很详细。

  • Disconf Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效 的。

  • SpringCloud Config 这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成,使用起来非常方便,并且它的配 置存储支持Git。不过它没有可视化的操作界面,配置的生效也不是实时的,需要重启或去刷新。

  • Nacos 这是SpingCloud alibaba技术栈中的一个组件,前面我们已经使用它做过服务注册中心。其实它也 集成了服务配置的功能,我们可以直接使用它作为服务配置中心。

Nacos Config入门

Nacos配置实时更新及同一个微服务不同环境的差异化配置

使用nacos作为配置中心,其实就是将nacos当做一个服务端,将各个微服务看成是客户端,我们 将各个微服务的配置文件统一存放在nacos上,然后各个微服务从nacos上拉取配置即可。

接下来我们以商品微服务为例,学习nacos config的使用。

1 搭建nacos环境【使用现有的nacos环境即可】(上篇文章有Nacos环境搭建)

2 在微服务公共模块中引入nacos的依赖

注:由于配置中心的依赖在多个微服务中都需要引入,所以此处建议将其加入到common公共模块中。

com.alibaba.cloudspring-cloud-starter-alibaba-nacos-config

3 在微服务service-product中添加nacos config的配置

注: 1)不能使用原来的application.yml作为配置文件,而是新建一个bootstrap.yml作为配置文件; 2)在bootstrap和application数据项相同时,bootstrap中的配置不会被覆盖;

配置文件优先级(由高到低):

bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml
spring:application:name: shop-productcloud:nacos:config:server-addr: localhost:8848 # nacos的服务端地址file-extension: yml # 配置文件格式profiles:active: dev # 环境标识 意思是:spring.application.name+spring.profiles.active+spring.cloud.nacos.config.file-extension# shop-product-dev.yml 开发环境数据库配置信息# shop-product-test.yml 测试环境数据库配置信息# shop-product-prod.yml 生产环境数据库配置信息

说明:之所以需要配置spring.application.name,是因为它是构成 Nacos 配置管理dataId字段的一部分。在 Nacos Spring Cloud 中,dataId的完整格式如下:

${prefix}-${spring.profiles.active}.${file-extension} 
  • prefix:默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置

  • spring.profiles.active:即为当前环境对应的 profile。 注意:当 spring.profiles.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变

  • file-exetension:为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 propertiesyaml 类型。

配置完成之后,请启动微服务shop-product并查看控制台日志信息:

这个时候可以很明显发现启动项目之后,已经开始从nacos配置中心拉去相应配置信息了,只是现在还没有到nacos配置中心去配置而已。

4 在nacos中添加配置

点击配置列表,点击右边+号,新建配置。在新建配置过程中,要注意下面的细节:

1)Data ID不能随便写,要跟配置文件中的对应,对应关系如图所示

2)配置文件格式要跟配置文件的格式对应,且目前仅仅支持YAML和Properties

3)配置内容按照上面选定的格式书写

注意:配置内容的格式不要出错了,正确的是上图的颜色,如果是其他的颜色则是错误的。

这就是错误的配置,如果提交,会出错。

好了,我们将配置改好,点击提交

5 注释本地的application.yaml中的内容, 启动程序进行测试 如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现

Nacos Config深入

Nacos同一个微服务不同环境的共享配置

在入门案例中,我们实现了配置的远程存放,但是此时如果修改了配置,我们的程序是无法读取到 的,因此,我们需要开启配置的动态刷新功能。 在nacos中的service-product-dev.yaml配置项中添加下面配置

两种方式获取配置信息:

方式一: 硬编码方式

package com.oyang.shopproduct.controller;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.ConfigurableApplicationContext;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestController@RequestMapping("/nacos-config")public class NacosConfigController {@Autowiredprivate ConfigurableApplicationContext applicationContext;//1 硬编码方式@GetMapping("/test1")public String nacosConfingTest1() {return applicationContext.getEnvironment().getProperty("config.appName");}}

运行一下,可以看到,读到了

更改一下配置信息,看能否实时生效

点击刷新,就获取到了

方式二: 注解方式(推荐)

@RestController@RefreshScope//只需要在需要动态读取配置的类上添加此注解就可以public class NacosConfigController {@Value("${config.appName}")private String appName;//2 注解方式@GetMapping("/nacos-config-test2")public String nacosConfingTest2() {return appName;}}

注入配置文件属性:@Value @ConfigurationProperties应的bean的后置处理器为 ConfigurationPropertiesBindingPostProcessor,它是实现了BeanPostProcessor接口,在bean被实例化后,会调用后置处理,递归的查找属性,通过反射注入值,属性需提供其setter和getter方法。

结果:

配置共享

当配置越来越多的时候,我们就发现有很多配置是重复的,这时候就考虑可不可以将公共配置文件 提取出来,然后实现共享呢?当然是可以的。接下来我们就来探讨如何实现这一功能。

如同:开发环境、测试环境、生产环境数据库配置信息不一致,但是Redis数据库连接配置是一致的?如:商品微服务—开发环境的数据库连接是localhost,测试环境是192.168.3xx.xx,生产环境是127.001.1010,而三个环境Redis是同一个,这种情况该如何实现呢” />同一个微服务的不同环境之间共享配置

如果想在同一个微服务的不同环境之间实现配置共享,其实很简单。 只需要提取一个以spring.application.name 命名的配置文件,然后将其所有环境的公共配置放在里 面即可。

我们再建一个测试环境,方便之后的共享配置测试

如果想要将开发环境改成测试环境的话,只需要将bootstrap.yml 文件中环境标识更改就行了

我们将后台重启,这时就能发现 ,项目在读测试环境的配置

1.新建一个名为service-product.yml配置存放商品微服务的公共配置

注:公共配置的名字必须是 spring.application.name 的值 :shop-product

2 添加测试方法

@RestController@RefreshScope//动态刷新的注解public class NacosConfigController {//3 读取shop-product所有环境共享配置@Value("${config.os}")private String os;@RequestMapping("/nacos-config-test3")public String nacosConfingTest3() {return os;}}

3.访问测试

测试环境:

可以看见,在测试环境中读取到了公共配置

4.接下来,修改bootstrap.yml中的配置,将active设置成dev,再次访问,观察结果。不管如何切换微服务的环境都能成功获取nacos配置中心的shop-product.yml文件配置内容,从而实现不同环境下的共享配置。

spring:profiles:active: test # 环境标识

开发环境:

在开发环境中读取到了公共配置

开发环境或哪个环境要针对公共配置我要覆盖该怎么办?那就直接覆盖呗,直接编辑一手

再在前台刷新一下

就直接覆盖了。

Nacos不同微服务的共享配置

不同为服务之间实现配置共享的原理类似于文件引入,就是定义一个公共配置,然后在当前配置中引入。

如:用户微服务,商品微服务,订单微服务存在某一项组件或框架配置是一样的

1 在nacos中定义一个DataID为all-service.yml的配置,用于所有微服务共享

2 配置要引入的配置以及配置要实现动态配置刷新的配置

spring:application:name: service-productcloud:nacos:config:server-addr: localhost:8848 # nacos的服务端地址file-extension: yml # 配置文件格式shared-dataids: all-service.yml # 配置要引入的配置refreshable-dataids: all-service.yml # 配置要实现动态配置刷新的配置profiles:active: test # 环境标识

加了之后,就能看见这个是过时的可以用以下替代

extension-configs[0]:data-id: all-service.yml #Data Id指定的:all-service.ymlgroup: DEFAULT_GROUP#默认分组refresh: true #是否实时刷新shared-configs[0]:data-id: all-service.ymlgroup: DEFAULT_GROUPrefresh: true

extension-configs的优先级高于shared-configs

3.测试代码

//4 读取不同微服务的共享配置@Value("${config.rabbitMQ}")private String ip;@RequestMapping("test4")public String nacosConfingTest4 () {return ip;}

4.启动商品微服务进行测试

nacos的几个概念

  • 命名空间(Namespace) 命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间

  • 配置分组(Group) 配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组

  • 配置集(Data ID) 在系统中,一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集

创建命名空间(Namespace)

如果没有出现空间ID(示填则自动生成),注意可能需要清空缓存

可以看见,我们刚刚创建的配置数是0,而public的配置数是4,是因为我们在配置列表中public加了4个配置

我们将这些配置克隆到测试组里去

我们将测试环境的all-service.ym文件进行更改

待会儿希望读,能读到刚刚测试环境中刚刚修改的配置

命名空间

对应的微服务配置文件需要更改

namespace位置有关系

我们将后台重启,再去前台刷新一下

可以看见,读取到了我们测试环境的配置

我们在测试环境中shop-product-dev.yml配置进行编辑,覆盖一下公共配置

然后前端刷新一下读取的是我们刚刚覆盖的配置,我们在测试环境再增加一个shop-product-dev.yml配置

可以看见,同样的配置,不同的组

修改bootstrap.yml

将后台重启,前台刷新测试一下

获取的是刚刚分组的配置信息

注意:切换分组时一定要确保当前项目的这些配置信息是有的,否则会启动失败

Nacos多环境切换

如何解决不同环境配置不同

不同微服务相同配置共享

  1. shared-configs

  2. extension-configs

bootstrap

Spring Cloud 构建于 Spring Boot 之上,在 Spring Boot 中有两种上下文,一种是 bootstrap, 另外一种是 application, bootstrap 是应用程序的父上下文,也就是说 bootstrap 加载优先于 applicaton。bootstrap 主要用于从额外的资源来加载配置信息,还可以在本地外部配置文件中解密属性。这两个上下文共用一个环境,它是任何Spring应用程序的外部属性的来源。bootstrap 里面的属性会优先加载,它们默认也不能被本地相同配置覆盖。

什么配置在application配置?什么配置在bootstrap里面配置?

1、当使用 Spring Cloud Config Server 的时候,spring.application.name 和 spring.cloud.config.server.git.uri应该在 bootstrap.yml 里面指定

2、一些加密解密的配置也应该配置在bootstrap里面

总结

  1. 如果多个share-configs中存在多个相同配置,以谁为准?

    • 以数组中最后一个为准

  2. 如果share-configs与extension-configs中有多个相同配置,以谁为准?

  3. nacos-config.yaml与nacos-config-dev.yaml

nacos-config-dev.yml>nacos-config.yml>extension-configs>share-configs>bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml