首先我们来看一下,微服务架构下关于配置文件的一些问题:
1. 配置文件相对分散。在一个微服务架构下,配置文件会随着微服务的增多变的越来越多,而且分散在各个微服务中,不好统一配置和管理。
2. 配置文件无法区分环境--开发环境 测试环境 线上环境。微服务项目可能会有多个环境,例如:测试环境、预发布环境、生产环
境。每一个环境所使用的配置理论上都是不同的,一旦需要修改,就需要我们去各个微服务下手动
维护,这比较困难。
3. 配置文件无法实时更新。我们修改了配置文件之后,必须重新启动微服务才能使配置生效,这对一个正在运行的项目来说是非常不友好的。
基于上面这些问题,我们就需要配置中心的加入来解决这些问题。
配置中心的思路是:
当加入了服务配置中心之后,我们的系统架构图会变成下面这样:
在业界常见的服务配置中心,有下面这些:
Apollo是由携程开源的分布式配置中心。特点有很多,比如:配置更新之后可以实时生效,支持灰度发布功能,并且能对所有的配置进行版本管理、操作审计等功能,提供开放平台API。并且资料 也写的很详细。
Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效的。
这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成,使用起来非常方便,并且它的配置存储支持Git
这是SpingCloud alibaba技术栈中的一个组件,前面我们已经使用它做过服务注册中心。其实它也集成了服务配置的功能,我们可以直接使用它作为服务配置中心。
使用nacos作为配置中心,其实就是将nacos当做一个服务端,将各个微服务看成是客户端,我们将各个微服务的配置文件统一存放在nacos上,然后各个微服务从nacos上拉取配置即可。
接下来我们以商品,订单微服务为例,学习nacos config的使用。
1 搭建nacos环境【使用现有的nacos环境即可】
2 在商品,订单微服务中分别引入nacos的依赖
- <dependency>
- <groupId>com.alibaba.cloudgroupId>
- <artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
- dependency>
3 在微服务中添加nacos config的配置
注意:不能使用原来的application.yml作为配置文件,而是新建一个bootstrap.yml作为配置文件
bootstrap和application都是SpringBoot项目中的配置文件,他们的区别主要有以下的几个方面
(1)加载顺序区别
bootstrap配置文件是比application配置文件优先加载的,因为bootstrap是由spring父上下文加载,而application是由子上下文加载
(2)优先级区别
bootstrap加载的配置信息是不能被application的相同配置覆盖的,如果两个配置文件同时存在,也是以bootstrap为主
(3)应用场景区别
bootstrap常见应用场景
1.配置一些固定的,不能被覆盖的属性.用于一些系统级别的参数配置
本地的配置文件是默认不能覆盖远程的配置的
2.一些需要加密/解密的场景
3.当你使用了Spring Cloud Config配置中心时,这时需要在boostrap配置文件中添加连接到配置中心的配置属性来加载外部配置中心的配置信息,专业翻译如下
application常见应用场景
1.常用于SpringBoot项目的自动化配置
2.用于一些应用级别的参数配置
在大部分情况下不用区分这两种情况,只需要使用application即可,效果基本是一致的
配置文件优先级(由高到低):
bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml
- #这个文件的优先级要高于application.properties---引用配置中心的内容
- #如果application和bootstrap中有相同的内容,则以bootstrap为主
-
- #指定微服务名称 也就是哪个微服务的配置文件
- spring.application.name=springcloud-product
-
- #如果新建配置Data ID跟微服务名称一致,可以不写
- spring.cloud.nacos.config.name=springcloud-product
- #指定nacos配置中心的地址 #如果是集群,就写nginx地址
- spring.cloud.nacos.config.server-addr=localhost:8848
- #指定nacos中心文件的后缀--默认为properties
- spring.cloud.nacos.config.file-extension=properties
4 在nacos中添加配置
点击配置列表,点击右边+号,新建配置。在新建配置过程中,要注意下面的细节:
1)Data ID不能随便写,要跟配置文件中的对应,对应关系如图所示
2)配置文件格式要跟配置文件的格式对应,且目前仅仅支持YAML和Properties
3)配置内容按照上面选定的格式书写
关于添加配置需要注意的一些地方:
1.配置文件名称尽量要和微服务名称相同,且保证唯一性
2.Group在不修改的情况下默认为DEFAULT_GROUP
3.配置格式不要选错
4.可以添加命名空间来实现不同的场景下的不同配置.例如我们企业中一般都会有 开发环境(dev),测试环境(test)和线上环境(online). 命名空间可以理解为不同的环境
5 测试是否能获取配置内容
重启服务,访问localhost:8081/product/getName
6 把配置文件的内容复制到服务配置中心对应的微服务名称中的配置内容中,注释或删除本地的application.yml或application.properties中的内容, 启动程序进行测试
- student.name=zhangsan
-
- # 为了后期扩展方便商品微服务的端口设置为8080~8089之间
- server.port=8081
-
- #数据源
- spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
- spring.datasource.url=jdbc:mysql://localhost:3306/springcloud?serverTimezone=Asia/Shanghai
- spring.datasource.username=root
- spring.datasource.password=123456
-
- #sql日志
- mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
- #配置eureka注册中心的地址
- #eureka.client.service-url.defaultZone=http://localhost:7000/eureka
- #配置nacos注册中心的地址
- spring.cloud.nacos.discovery.server-addr=localhost:81
- #指定是否把该服务注册到注册中心
- #spring.cloud.nacos.discovery.register-enabled=false
- #指定微服务的名称 务必不能用_分隔
- spring.application.name=springcloud-wzh-product
如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现
order微服务进行相同操作
在入门案例中,我们实现了配置的远程存放,但是此时如果修改了配置,我们的程序是无法读取到的,因此,我们需要开启配置的动态刷新功能。
1 在nacos中的springcloud-wzh-product配置项中添加下面配置
2 调用的controller层加注解@RefreshScope
注意这里只能刷新自定义配置内容,比如student.name,像数据源,注册中心等都是不行的
3 测试 不需要重启服务器,只需要在配置中心修改即可
当配置越来越多的时候,我们就发现有很多配置是重复的,这时候就考虑可不可以将公共配置文件提取出来,然后实现共享呢?当然是可以的。接下来我们就来探讨如何实现这一功能。
同一个微服务的不同环境之间共享配置
如果想在同一个微服务的不同环境之间实现配置共享,其实很简单。
只需要提取一个以 spring.application.name 命名的配置文件,然后将其所有环境的公共配置放在里面即可。
上面我们的配置文件中,数据源DataSourse,和nacos注册中心等
1 nacos config配置中心-->命名空间--->新建命名空间
2 新建一个名为dataSourse.properties(注意这里必须加后缀)配置存放商品,订单微服务的公共配置,并删除product和order中的数据源配置
新建一个名为nacos.properties(注意这里必须加后缀)配置存放商品,订单微服务的公共nacos注册中心配置,并删除product和order中的nacos注册中心配置
3 配置列表克隆所需要的配置文件到对应的命名空间(不同环境)中
4 分别修改bootstrap.properties配置文件
- #这个文件的优先级要高于application.properties---引用配置中心的内容
- #如果application和bootstrap中有相同的内容,则以bootstrap为主
-
- #指定微服务名称 也就是哪个微服务的配置文件
- spring.application.name=springcloud-wzh-product
-
- #如果新建配置Data ID跟微服务名称一致,可以不写
- #spring.cloud.nacos.config.name=springcloud-wzh-product
- #指定nacos配置中心的地址 #如果是集群,就写nginx地址
- spring.cloud.nacos.config.server-addr=localhost:81
- #指定nacos中心文件的后缀--默认为properties
- spring.cloud.nacos.config.file-extension=properties
-
-
- #指定配置文件所在的命名空间--默认为public
- spring.cloud.nacos.config.namespace=230e585d-88c7-4c2f-9d40-31a831d2ca15
-
- # 引用扩展的配置文件
- # 扩展文件的id
- spring.cloud.nacos.config.extension-configs[0].data-id=dataSourse.properties
- # 扩展文件所在的组 默认为DEFAULT_GROUP
- spring.cloud.nacos.config.extension-configs[0].group=DEFAULT_GROUP
- # 是否实时刷新
- spring.cloud.nacos.config.extension-configs[0].refresh=true
-
- # 扩展文件的id
- spring.cloud.nacos.config.extension-configs[1].data-id=nacos.properties
- # 扩展文件所在的组 默认为DEFAULT_GROUP
- spring.cloud.nacos.config.extension-configs[1].group=DEFAULT_GROUP
- # 是否实时刷新
- spring.cloud.nacos.config.extension-configs[1].refresh=true
5 测试是否成功
需要注意的地方:
1.如果在nacos配置了命名空间,那么一定要在引用的时候配置好配置文件所在命名空间的ID
2.如果配置文件的文件名和注册中心中服务的名称相同,那么引入时配置文件的名称可以省略不写,只写服务的名称
3.GROUP如果没有修改,那么可以不用配置,引入时默认就是DEFAULT_GROUP,如果修改了就一定要配置上修改后的名称
4.前面第二步里第5点也提到,公共配置文件的名称一定要加上后缀名,在引用时得以体现其作用.
5.file-extension用来选择引入的配置文件的文件格式,默认为properties,如果时yml类型需要修改其类型为yaml
6.extension-configs负责引入公共配置文件,该属性需要的值为list结构
命名空间(Namespace) (dev开发环境 test测试环境 online线上环境)
命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间
配置分组(Group) (区分的项目)
配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组
配置集(Data ID)
在系统中,一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集