使用Nacos作为配置中心

目录

  • 一、服务配置中心介绍
  • 二、Nacos Config入门
  • 三、Nacos Config深入
    • 1、配置动态刷新
      • ①硬编码方式
      • ②注解方式(推荐)
    • 2、配置共享
    • 3、同一个微服务的不同环境之间共享配置
  • 四、nacos的几个概念
    • 1、创建命名空间(Namespace)
    • 2、命名空间&组
  • 五、bootstrap&总结
    • 1、bootstrap
    • 2、总结

一、服务配置中心介绍

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

  1. 配置文件相对分散。在一个微服务架构下,配置文件会随着微服务的增多变的越来越多,而且分散
    在各个微服务中,不好统一配置和管理。
  2. 配置文件无法区分环境。微服务项目可能会有多个环境,例如:测试环境、预发布环境、生产环
    境。每一个环境所使用的配置理论上都是不同的,一旦需要修改,就需要我们去各个微服务下手动
    维护,这比较困难。
  3. 配置文件无法实时更新。我们修改了配置文件之后,必须重新启动微服务才能使配置生效,这对一
    个正在运行的项目来说是非常不友好的。
    基于上面这些问题,我们就需要配置中心的加入来解决这些问题。
    配置中心的思路是:
  • 首先把项目中各种配置全部都放到一个集中的地方进行统一管理,并提供一套标准的接口。
  • 当各个服务需要获取配置的时候,就来配置中心的接口拉取自己的配置。
  • 当配置中心中的各种参数有更新的时候,也能通知到各个服务实时的过来同步最新的信息,使之动
    态更新。

当加入了服务配置中心之后,我们的系统架构图会变成下面这样:
使用Nacos作为配置中心_第1张图片
在业界常见的服务配置中心,有下面这些:

  • Apollo
    Apollo是由携程开源的分布式配置中心。特点有很多,比如:配置更新之后可以实时生效,支持灰
    度发布功能,并且能对所有的配置进行版本管理、操作审计等功能,提供开放平台API。并且资料
    也写的很详细。
  • Disconf
    Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效
    的。
  • SpringCloud Config
    这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成,使用起来非常方便,并且它的配
    置存储支持Git。不过它没有可视化的操作界面,配置的生效也不是实时的,需要重启或去刷新。
  • Nacos
    这是SpingCloud alibaba技术栈中的一个组件,前面我们已经使用它做过服务注册中心。其实它也
    集成了服务配置的功能,我们可以直接使用它作为服务配置中心。

二、Nacos Config入门

使用nacos作为配置中心,其实就是将nacos当做一个服务端,将各个微服务看成是客户端,我们
将各个微服务的配置文件统一存放在nacos上,然后各个微服务从nacos上拉取配置即可。
接下来我们以商品微服务为例,学习nacos config的使用。
1 搭建nacos环境【使用现有的nacos环境即可】
2 在微服务公共模块中引入nacos的依赖
注:由于配置中心的依赖在多个微服务中都需要引入,所以此处建议将其加入到common公共模块中。

<dependency>
	<groupId>com.alibaba.cloudgroupId>
	<artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
dependency>

3 在微服务service-product中添加nacos config的配置
注:
1)不能使用原来的application.yml作为配置文件,而是新建一个bootstrap.yml作为配置文件;
2)在bootstrap和application数据项相同时,bootstrap中的配置不会被覆盖;

配置文件优先级(由高到低):
bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml

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

1)Data ID不能随便写,要跟配置文件中的对应,对应关系如图所示
2)配置文件格式要跟配置文件的格式对应,且目前仅仅支持YAML和Properties
3)配置内容按照上面选定的格式书写

application.yml:

server:
    port: 8080
spring:
    application:
        name: shop-product
    cloud:
        nacos:
            discovery:
                server-addr: localhost:8848
        main:
            #        允许定义相同的bean对象 去覆盖原有的
            allow-bean-definition-overriding: true

使用Nacos作为配置中心_第2张图片
图中Data ID应与application.yml文件中对应
使用Nacos作为配置中心_第3张图片
5 启动程序进行测试
如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现

三、Nacos Config深入

1、配置动态刷新

在入门案例中,我们实现了配置的远程存放,但是此时如果修改了配置,我们的程序是无法读取到
的,因此,我们需要开启配置的动态刷新功能。

①硬编码方式

@RestController
@RequestMapping("/nacos-config")
@RefreshScope
public class NacosConfigController {
	@Autowired
	private ConfigurableApplicationContext applicationContext;
	//1 硬编码方式
	@GetMapping("/test1")
	public String nacosConfingTest1() {
		return applicationContext.getEnvironment().getProperty("config.appName");
	}

使用Nacos作为配置中心_第4张图片

②注解方式(推荐)

@Value("${config.appName}")
	private String appName;
	//2 注解方式
	@GetMapping("/test2")
	public String nacosConfingTest2() {
		return appName;
	}

使用Nacos作为配置中心_第5张图片

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

2、配置共享

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

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

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

添加测试方法

//3 读取shop-product所有环境共享配置
	@Value("${config.os}")
	private String os;
	@RequestMapping("/test3")
	public String nacosConfingTest3() {
		return os;
	}

访问测试
使用Nacos作为配置中心_第6张图片

四、nacos的几个概念

  • 命名空间(Namespace)
    命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间
  • 配置分组(Group)
    配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组
  • 配置集(Data ID)
    在系统中,一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集
    使用Nacos作为配置中心_第7张图片

1、创建命名空间(Namespace)

使用Nacos作为配置中心_第8张图片

2、命名空间&组

spring:
  application:
    name: shop-product
  cloud:
    nacos:
      config:
        server-addr: localhost:8848 # nacos的服务端地址
        file-extension: yml # 配置文件格式
#        shared-dataids: all-service.yaml # 配置要引入的配置
#        refreshable-dataids: all-service.yaml # 配置要实现动态配置刷新的配置
        extension-configs[0]:
          data-id: all-service.yml
          group: DEFAULT_GROUP
          refresh: true

        shared-configs[0]:
          data-id: all-service.yml
          group: DEFAULT_GROUP
          refresh: true
        namespace: 50aff5d2-7ba6-42a3-8e7c-092d64c619b7
        group: YILIAO_GROUP
  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 生产环境数据库配置信息

五、bootstrap&总结

1、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里面

2、总结

  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

你可能感兴趣的:(java,git,微服务)