首先我们来看一下,微服务架构下关于配置文件的一些问题:
当加入了服务配置中心之后,我们的系统架构图会变成下面这样:
在业界常见的服务配置中心,有下面这些:
使用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
图中Data ID应与application.yml文件中对应
5 启动程序进行测试
如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现
在入门案例中,我们实现了配置的远程存放,但是此时如果修改了配置,我们的程序是无法读取到
的,因此,我们需要开启配置的动态刷新功能。
@RestController
@RequestMapping("/nacos-config")
@RefreshScope
public class NacosConfigController {
@Autowired
private ConfigurableApplicationContext applicationContext;
//1 硬编码方式
@GetMapping("/test1")
public String nacosConfingTest1() {
return applicationContext.getEnvironment().getProperty("config.appName");
}
@Value("${config.appName}")
private String appName;
//2 注解方式
@GetMapping("/test2")
public String nacosConfingTest2() {
return appName;
}
注入配置文件属性:@Value @ConfigurationProperties应的bean的后置处理器为
ConfigurationPropertiesBindingPostProcessor,它是实现了BeanPostProcessor接口,在bean被实例化后,会调用后置处理,递归的查找属性,通过反射注入值,属性需提供其setter和getter方法。
当配置越来越多的时候,我们就发现有很多配置是重复的,这时候就考虑可不可以将公共配置文件
提取出来,然后实现共享呢?当然是可以的。接下来我们就来探讨如何实现这一功能。
如果想在同一个微服务的不同环境之间实现配置共享,其实很简单。
只需要提取一个以spring.application.name 命名的配置文件,然后将其所有环境的公共配置放在里
面即可。
添加测试方法
//3 读取shop-product所有环境共享配置
@Value("${config.os}")
private String os;
@RequestMapping("/test3")
public String nacosConfingTest3() {
return os;
}
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 生产环境数据库配置信息
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里面
- 如果多个share-configs中存在多个相同配置,以谁为准? 以数组中最后一个为准
- 如果share-configs与extension-configs中有多个相同配置,以谁为准?
- 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