目录
一,配置中心简介
Nacos Config入门
二,nacos差异化配置
三,nacos共享配置
同一个微服务的不同环境之间共享配置
不同微服务中间共享配置
四,nacos的命名空间&组
nacos的几个概念
创建命名空间(Namespace)
组
一,配置中心简介
配置中心的思路:
首先把项目中各种配置全部都放到一个集中的地方进行统一管理,并提供一套标准的接口。
当各个服务需要获取配置的时候,就来配置中心的接口拉取自己的配置。
当配置中心中的各种参数有更新的时候,也能通知到各个服务实时的过来同步最新的信息,使之动 态更新。
当加入了服务配置中心之后,我们的系统架构图会变成如下
常见的配置中心如下:
Apollo Apollo是由携程开源的分布式配置中心。特点有很多,比如:配置更新之后可以实时生效,支持灰 度发布功能,并且能对所有的配置进行版本管理、操作审计等功能,提供开放平台API。并且资料 也写的很详细。
Disconf Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效 的。
SpringCloud Config 这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成,使用起来非常方便,并且它的配 置存储支持Git。不过它没有可视化的操作界面,配置的生效也不是实时的,需要重启或去刷新。
Nacos 这是SpingCloud alibaba技术栈中的一个组件,前面我们已经使用它做过服务注册中心。其实它也 集成了服务配置的功能,我们可以直接使用它作为服务配置中心。
Nacos Config入门
1 搭建nacos环境【使用现有的nacos环境即可】
2 在微服务公共模块中引入nacos的依赖
注:由于配置中心的依赖在多个微服务中都需要引入,所以此处建议将其加入到common公共模块中。
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
3 在微服务service-product中添加nacos config的配置
提示:
1.不能使用原来的application.yml作为配置文件,而是新建一个bootstrap.yml作为配置文件;
2.在bootstrap和application数据项相同时,bootstrap中的配置不会被覆盖;
配置文件优先级(由高到低)
spring:
application:
name: service-product
cloud:
nacos:
config:
server-addr: localhost:8848 # nacos的服务端地址
file-extension: yaml # 配置文件格式
profiles:
active: dev # 环境标识
提示:之所以需要配置
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
来配置。目前只支持properties
和yaml
类型。
运行:今天主要讲解的模块为:配置管理
点击配置列表,点击右边+号,新建配置 ,如下图(Data ID命名要与yml配置文件中的name名相匹配,不能随意)
注意:配置格式一定要选对,以及配置内容必须是英文输入,包括标点符号。可以通过颜色区分,当字体是红色或是无色说明可能存在错误,一定要仔细检查
配置内容
二,nacos差异化配置
测试代码(以下有两种方式,更推荐第二种)
package com.dengxiyan.shopproduct.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.bind.annotation.*;
@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;
}
}
注释本地的application.yaml中的内容, 启动程序进行测试 如果依旧可以成功访问程序,说明我们nacos的配置中心功能已经实现
当在服务没有停掉的情况下修改配置内容,不需要重启项目同样也可以访问到获取到配置内容
三,nacos共享配置
同一个微服务的不同环境之间共享配置
如果想在同一个微服务的不同环境之间实现配置共享,其实很简单。 只需要提取一个以spring.application.name 命名的配置文件,然后将其所有环境的公共配置放在里 面即可。
1 新建一个名为service-product.yml配置存放商品微服务的公共配置
接下来,修改bootstrap.yml中的配置,将active设置成test,再次访问,观察结果。不管如何切换微服务的环境都能成功获取nacos配置中心的shop-product.yml文件配置内容,从而实现不同环境下的共享配置。
spring:
application:
name: shop-product
cloud:
nacos:
config:
server-addr: localhost:8848 # nacos的服务端地址
file-extension: yml # 配置文件格式
extension-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
shared-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
profiles:
active: dev # 环境标识
# spring.application.name+spring.cloud.nacos.config.prefix
# shop-product-dev.yml 开发环境数据库配置信息
# shop-product-test.yml 测试环境数据库配置信息
# shop-product-prod.yml 生产环境数据库配置信息
2 添加测试方法
package com.dengxiyan.shopproduct.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/nacos-config")
@RefreshScope
public class NacosConfigController {
//3 读取shop-product所有环境共享配置
@Value("${config.os}")
private String os;
@RequestMapping("/test3")
public String nacosConfingTest3() {
return os;
}
}
配置生效
不同微服务中间共享配置
不同为服务之间实现配置共享的原理类似于文件引入,就是定义一个公共配置,然后在当前配置中引 入。
1 在nacos中定义一个DataID为all-service.yaml的配置,用于所有微服务共享
namespace:
3fcc33ef-a998-49fc-b083-ecff7d1a63c7
完整代码
spring:
application:
name: shop-product
cloud:
nacos:
config:
server-addr: localhost:8848 # nacos的服务端地址
file-extension: yml # 配置文件格式
extension-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
shared-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
namespace:
3fcc33ef-a998-49fc-b083-ecff7d1a63c7
profiles:
active: dev # 环境标识
# spring.application.name+spring.cloud.nacos.config.prefix
# shop-product-dev.yml 开发环境数据库配置信息
# shop-product-test.yml 测试环境数据库配置信息
# shop-product-prod.yml 生产环境数据库配置信息
测试方法
package com.dengxiyan.shopproduct.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/nacos-config")
@RefreshScope
public class NacosConfigController {
//4 读取不同微服务的共享配置
@Value("${config.rebbitMq}")
private String ip;
@RequestMapping("/test4")
public String nacosConfingTest4() {
return ip;
}
}
获取到的与配置内容一致
四,nacos的命名空间&组
nacos的几个概念
命名空间(Namespace) 命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间
配置分组(Group) 配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组
配置集(Data ID)
在系统中,一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集
创建命名空间(Namespace)
如果没有出现空间ID(示填则自动生成),注意可能需要清空缓存
组
新建的组
添加至配置文件的代码
group:
YL_GROUP
完整代码
spring:
application:
name: shop-product
cloud:
nacos:
config:
server-addr: localhost:8848 # nacos的服务端地址
file-extension: yml # 配置文件格式
extension-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
shared-configs[0]:
data-id: all-service.yaml
group: DEFAULT_GROUP
refresh: true
namespace:
3fcc33ef-a998-49fc-b083-ecff7d1a63c7
group:
YL_GROUP
profiles:
active: dev # 环境标识
# spring.application.name+spring.cloud.nacos.config.prefix
# shop-product-dev.yml 开发环境数据库配置信息
# shop-product-test.yml 测试环境数据库配置信息
# shop-product-prod.yml 生产环境数据库配置信息
配置生效