1.1 什么是配置
应用程序在启动和运行的时候往往需要读取一些配置信息,配置基本上伴随着应用程序的整个生命周期,比如:数据库连接参数、启动参数等。
配置主要有以下几个特点:
配置是独立于程序的只读变量
配置伴随应用的整个生命周期
配置可以有多种加载方式
配置需要治理
1.2 什么是配置中心
微服务架构中,当系统从一个单体应用,被拆分成分布式系统上一个个服务节点后,配置文件也必须跟着迁移(分割),这样配置就分散了,不仅如此,分散中还包含着冗余,如下图:
下图显示了配置中心的功能,配置中心将配置从各应用中剥离出来,对配置进行统一管理,
配置中心的服务流程如下:
1、用户在配置中心更新配置信息。
2、服务A和服务B及时得到配置更新通知,从配置中心获取配置。
总得来说,配置中心就是一种统一管理各种应用配置的基础服务组件。
在系统架构中,配置中心是整个微服务基础架构体系中的一个组件,如下图,它的功能看上去并不起眼,无非就是配置的管理和存取,但它是整个微服务架构中不可或缺的一环。
总结一下,在传统巨型单体应用纷纷转向细粒度微服务架构的历史进程中,配置中心是微服务化不可缺少的一个系统组件,在这种背景下中心化的配置服务即配置中心应运而生,一个合格的配置中心需要满足如下特性:
配置项容易读取和修改分布式环境下应用配置的可管理性,即提供远程管理配置的能力支持对配置的修改的检视以把控风险可以查看配置修改的历史记录不同部署环境下应用配置的隔离性
目前市面上用的比较多的配置中心有:Spring Cloud Config、Apollo、Nacos和Disconf等。
由于Disconf不再维护,下面主要对比一下Spring Cloud Config、Apollo和Nacos。
对比项目 | Spring Cloud Config | Apollo | Nacos |
---|---|---|---|
配置实时推送 | 支持(Spring Cloud Bus) | 支持(HTTP长轮询1s内) | 支持(HTTP长轮询1s内) |
版本管理 | 支持(Git) | 支持 | 支持 |
配置回滚 | 支持(Git) | 支持 | 支持 |
灰度发布 | 支持 | 支持 | 不支持 |
权限管理 | 支持(依赖Git) | 支持 | 不支持 |
多集群 | 支持 | 支持 | 支持 |
多环境 | 支持 | 支持 | 支持 |
监听查询 | 支持 | 支持 | 支持 |
多语言 | 只支持Java | 主流语言,提供了Open API | 主流语言,提供了Open API |
配置格式校验 | 不支持 | 支持 | 支持 |
单机读(QPS) | 7(限流所致) | 9000 | 15000 |
单击写(QPS) | 5(限流所致) | 1100 | 1800 |
3节点读(QPS) | 21(限流所致) | 27000 | 45000 |
3节点写(QPS) | 5(限流所致) | 3300 | 5600 |
从配置中心角度来看,性能方面Nacos的读写性能最高,Apollo次之,Spring Cloud Config依赖Git场景不适合开放的大规模自动化运维API。功能方面Apollo最为完善,nacos具有Apollo大部分配置管理功能,而Spring Cloud Config不带运维管理界面,需要自行开发。Nacos的一大优势是整合了注册中心、配置中心功能,部署和操作相比Apollo都要直观简单,因此它简化了架构复杂度,并减轻运维及部署工作。
综合来看,Nacos的特点和优势还是比较明显的。
Nacos是阿里的一个开源产品,它是针对微服务架构中的服务发现、配置管理、服务治理的综合型解决方案。
官方介绍是这样的:
Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集,帮助您实现动态服务发现、服务配置管理、服务及流量管理。
Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构的服务基础设施。
官网地址:https://nacos.io
Nacos主要提供以下四大功能:
Nacos使服务更容易注册,并通过DNS或HTTP接口发现其他服务,Nacos还提供服务的实时健康检查,以防止向不健康的主机或服务实例发送请求。
动态配置服务允许您在所有环境中以集中和动态的方式管理所有服务的配置。Nacos消除了在更新配置时重新部署应用程序,这使配置的更改更加高效和灵活。
Nacos提供基于DNS 协议的服务发现能力,旨在支持异构语言的服务发现,支持将注册在Nacos上的服务以域名的方式暴露端点,让三方应用方便的查阅及发现。
Nacos 能让您从微服务平台建设的视角管理数据中心的所有服务及元数据,包括管理服务的描述、生命周期、服务的静态依赖分析、服务的健康状态、服务的流量管理、路由及安全策略。
这里动态配置管理的特性说明了Naocs的配置管理能力。
Nacos 依赖 Java 环境来运行。如果您是从代码开始构建并运行Nacos,还需要为此配置 Maven环境,请确保是在以下版本环境中安装使用:
PS:nacos的默认端口是8848,需要保证8848默认端口没有被其他进程占用。
# 下载项目
git clone https://github.com/alibaba/nacos.git
cd nacos/
# 编译
mvn ‐Prelease‐nacos clean install ‐U
ls ‐al distribution/target/
# 切换至相应版本目录
cd distribution/target/nacos‐server‐$version/nacos/bin
# Windows下运行
startup.cmd -m standalone
# Linux下运行,standalone表示为单机运行
startup.sh -m standalone
下载 nacos-server-$version.zip 包,本教程使用nacos-server-1.3.2
下载地址:https://github.com/alibaba/nacos/releases
下载后解压
# 解压
unzip nacos‐server‐$version.zip
# tar ‐xvf nacos‐server‐$version.tar.gz
# 切换目录
cd nacos/bin
# 运行
startup.sh -m standalone
# docker pull mysql:5.7
# docker run -p 3306:3306 --name qmm-mysql -v ~/mysql/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=Ab@123456 -d mysql:5.7
# sudo bash -f /opt/nacos/bin/shutdown.sh
# sudo bash -f /opt/nacos/bin/startup.sh -m standalone
# 无论如何,先把自己防火墙的端口放开
sudo firewall-cmd --zone=public --add-port=3306/tcp --permanent
# 重新加载下防火墙,让规则生效
sudo firewall-cmd --reload
# Windows下直接解压点击startup.cmd运行即可
nacos的默认端口是8848,需要保证8848默认端口没有被其他进程占用。
进入安装程序的bin目录:
Linux/Unix/Mac启动方式:
启动命令(standalone代表着单机模式运行,非集群模式):
sh startup.sh -m standalone
如果您使用的是ubuntu系统,或者运行脚本报错提示[[符号找不到,可尝试如下运行:
bash startup.sh -m standalone
Windows启动方式:
启动命令:
cmd startup.cmd
或者双击startup.cmd运行文件。
启动成功,可通过浏览器访问 http://127.0.0.1:8848/nacos ,打开如下nacos控制台登录页面:
使用默认用户名:nacos,默认密码:nacos 登录即可打开主页面。
启动nacos成功后,可通过nacos提供的http api验证nacos服务运行是否正常。
下边我们通过 curl工具来测试nacos的open api:
curl 是开发中常用的命令行工具,可以用作HTTP协议测试。
本教程下载curl的windows版本:curl-7.66.0_2-win64-mingw,下载地址:https://curl.haxx.se/windows/
下载完成进入curl-7.66.0_2-win64-mingw的bin目录,进行下边的测试,通过测试可判断nacos是否正常工作:
curl -X POST “http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test&content=HelloWorld”
点击“详情”:
向nacos发布配置成功,就可以通过客户端从nacos获取配置信息,执行下边的命令:
curl -X GET “http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test”
通过测试发现,可以从nacos获取前边发布的配置:HelloWorld
shutdown.sh
shutdown.cmd
单机模式时nacos默认使用嵌入式数据库实现数据的存储,若想使用外部mysql存储nacos数据,需要进行以下步骤:
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://localhost:3306/ry-config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=10000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user=root
db.password=root
登录nacos,点击右侧“+”号,新增一个配置
新建配置并发布
# Data ID:mynacos-demo
# Group:DEFAULT_GROUP
# 配置格式:YAML
# 配置内容:
common:
task: do something
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TriQTEMe-1647872117906)()]
新建一个Maven项目,并添加如下依赖:
<dependency>
<groupId>com.alibaba.nacosgroupId>
<artifactId>nacos-clientartifactId>
<version>1.4.0version>
dependency>
SimpleDemo.java
/**
* @author Xin.li
* @date 2021-01-06 14:40
*/
public class SimpleDemo {
public static void main(String[] args) throws NacosException {
// nacos地址
String serverAddr = "127.0.0.1:8848";
// Data Id
String dataId = "mynacos-demo";
// Group
String group = "DEFAULT_GROUP";
// 开始获取
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);
ConfigService configService = NacosFactory.createConfigService( properties );
// 获取配置
String content = configService.getConfig(dataId, group, 5000);
System.out.println(content);
}
}
获取配置信息成功
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GSGBu75K-1647872117907)(images\3213.webp.jpg)]
对于Nacos配置管理,通过Namespace、Group、DataId能够定位到一个配置集
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qB7FCrJZ-1647872117908)(images\4101.jpg)]
在系统中,一个配置文件通常就是一个**配置集**,一个配置集可以包含了系统的各种配置信息,例如,一个配置集可能包含了数据源、线程池、日志级别等配置项。每个配置集都可以定义一个有意义的名称,就是配置集的ID即Data ID。
配置集中包含的一个个配置内容就是配置项。它代表一个具体的可配置的参数与其值域,通常以 key=value 的形式存在。例如我们常配置系统的日志输出级别(logLevel=INFO|WARN|ERROR) 就是一个配置项。
配置分组是对配置集进行分组,通过一个有意义的字符串(如 Buy 或 Trade )来表示,不同的配置分组下可以有相同的配置集(Data ID)。当您在 Nacos 上创建一个配置时,如果未填写配置分组的名称,则配置分组的名称默认采用 DEFAULT_GROUP 。配置分组的常见场景:可用于区分不同的项目或应用,例如:学生管理系统的配置集可以定义一个group为:STUDENT_GROUP。
命名空间(namespace)可用于进行不同环境的配置隔离。例如可以隔离开发环境、测试环境和生产环境,因为它们的配置可能各不相同,或者是隔离不同的用户,不同的开发人员使用同一个nacos管理各自的配置,可通过namespace隔离。不同的命名空间下,可以存在相同名称的配置分组(Group) 或 配置集。
Nacos抽象定义了Namespace、Group、Data ID的概念,具体这几个概念代表什么,取决于我们把它们看成什么,这里推荐给大家一种用法:
Namespace:代表不同环境,如开发、测试、生产环境。
Group:代表某项目,如XX医疗项目、XX电商项目
DataId:每个项目下往往有若干个工程,每个配置集(DataId)是一个工程的主配置文件
获取配置集需要指定∶
代码如下∶
看懂即可不用运行。
public class demoMain {
public static void main(String[] args) throws NacosException {
//使用nacos client远程获取nacos服务上的配置信息
//nacos server地址
String serverAddr = "127.0.0.1:8848";
//namespace
String namespace = "c67e4a97-a698-4d6d-9bb1-cfac5f5b51c4";
//data id
String dataId = "nacos-simple-demo.yaml";
//group
String group = "DEFAULT_GROUP";
Properties properties =new Properties();
properties.put("serverAddr",serverAddr);
properties.put("namespace",namespace);
//获取配置
ConfigService configService = NacosFactory.createConfigService(properties);
// String dataId, String group, long timeoutMs
String config = configService.getConfig(dataId, group, 5000);
System.out.println(config);
//String dataId, String group, Listener listener
configService.addListener(dataId, group, new Listener() {
public Executor getExecutor() {
return null;
}
//当配置有变化 时候获取通知
public void receiveConfigInfo(String s) {
System.out.println(s);
}
});
while (true){
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
以上代码说明将从地址为127.0.0.1:8848的nacos配置中心获取配置,通过以下信息定位能获取。
namespace:ee247dde-d838-425c-b371-029dab26232f
注意∶ namespace需要指定id。
group:DEFAULT_GROUP
Data ld: nacos-simple-demo.yaml
Namespace的设计是nacos基于此做多环境以及多租户(多个用户共同使用nacos)数据(配置和服务)隔离的。
从单租户(用户)的角度来看,如果有多套不同的环境,那么这个时候可以根据指定的环境来创建不同的Namespace,从此来实现多环境的隔离。例如,可能有开发、测试和生产三个不同的环境,使用一套Nacos集群可以分别建立以下三个不同的Namespace。如下图所示:
PS:单个用户使用Nacos Client,可通过不同的Namespace来做不同环境下的配置/服务与数据隔离
从多租户(用户)的角度来看,每个租户(用户)可能会有自己的Namespace,每个租户(用户)的配置数据以及注册的服务数据都会归属到自己的Namespace下,以此来实现多租户间的数据隔离。例如超级管理员分配了三个租户,分别为张三、李四和王五。分配好之后,各租户用自己的帐户名称密码登录,创建各自的命名空间。如下图所示:
PS:多租户只是提出概念,实际还未实现
(1) 在刚刚新建好的dev命名空间中,新建namespace.yml配置文件,并输入如下内容:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-waaVMCOc-1647872117915)(images\4230.jpg)]
common: {
namespace: dev
}
(2) 同样,在public命名空间中,新建namespace.yml配置文件,并输入如下内容:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9bvfuU0l-1647872117916)(images\4231.jpg)]
common: {
namespace: public
}
(3) 在项目中新建,NamespaceDemo.java并输入如下内容:
public class NamespaceDemo {
public static void main(String[] args) throws NacosException {
// nacos地址
String serverAddr = "127.0.0.1:8848";
// namespace的Id,而非名称,默认为public命名空间
// String namespace = "cb47b54d-1bcf-415a-b471-57624207bc96";
// Data Id
String dataId = "namespace.yml";
// Group
String group = "DEFAULT_GROUP";
// 开始获取
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);
// 将namespace放入配置
// properties.put("namespace", namespace);
ConfigService configService = NacosFactory.createConfigService( properties );
// 获取配置
String content = configService.getConfig(dataId, group, 5000);
System.out.println(content);
}
}
运行结果如下:
common: {
namespace: public
}
(4) 修改代码,加入命名空间配置
public class NamespaceDemo {
public static void main(String[] args) throws NacosException {
// nacos地址
String serverAddr = "127.0.0.1:8848";
// namespace的Id,而非名称,默认为public命名空间
String namespace = "cb47b54d-1bcf-415a-b471-57624207bc96";
// Data Id
String dataId = "namespace.yml";
// Group
String group = "DEFAULT_GROUP";
// 开始获取
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);
// 将namespace放入配置
properties.put("namespace", namespace);
ConfigService configService = NacosFactory.createConfigService( properties );
// 获取配置
String content = configService.getConfig(dataId, group, 5000);
System.out.println(content);
}
}
运行结果如下:
common: {
namespace: dev
}
相同的配置文件名称,加入不同的命名空间配置输出不同的结果,说明命名空间已实现隔离
PS:默认不填入命名空间参数时为使用public命名空间
PS:填写命名空间参数时需写入命名空间的id,而不是名称
Nacos支持基于Namespace和Group的配置分组管理,以便用户更灵活的根据自己的需要按照环境或者应用、模块等分组管理微服务的大量配置,在配置管理中主要提供了配置历史版本、回滚、订阅者查询等核心管理能力。
点击Nacos控制台的 配置管理->配置列表
菜单,即可看到以下界面展示:
界面中展示了不同namespace下的配置集列表,可点击左上角的不同namespace进行切换。
右上角“+"号或点击某配置集后的 编辑 按钮可进入配置集编辑器。
Nacos支持 YAML、Properties、TEXT、JSON、XML、HTML 等常见配置格式在线编辑、语法高亮、格式校验,帮助用户高效编辑的同时大幅降低格式错误带来的风险。
Nacos支持配置标签的能力,帮助用户更好、更灵活的做到基于标签的配置分类及管理。同时支持用户对配置及其变更进行描述,方面多人或者跨团队协作管理配置。
Nacos支持编辑DIFF能力,帮助用户校验修改内容,降低改错带来的风险。
点击右上角的 导入配置 ,可选择导出的压缩包文件,将压缩包内的文件恢复为nacos配置集
点击左下角 克隆 按钮,将会弹出克隆对话框,此功能可用于将配置迁移到其他Namespace。
Nacos通过提供配置版本管理及其一键回滚能力,帮助用户改错配置的时候能够快速恢复,降低微服务系统在配置管理上的可用性风险。
Nacos提供配置订阅者即监听者查询能力,同时提供客户端当前配置的MD5校验值,以便帮助用户更好的检查配置变更是否推送到 Client 端。
通过以下代码可对某配置进行监听:
public class SimpleDemoMain {
public static void main(String[] args) throws NacosException {
//使用nacos client远程获取nacos服务上的配置信息
//nacos server地址
String serverAddr = "127.0.0.1:8848";
//data id
String dataId = "nacos-simple-demo.yaml";
//group
String group = "DEFAULT_GROUP";
//namespace
String namespace = "c67e4a97-a698-4d6d-9bb1-cfac5f5b51c4";
Properties properties =new Properties();
properties.put("serverAddr",serverAddr);
properties.put("namespace",namespace);
//获取配置
ConfigService configService = NacosFactory.createConfigService(properties);
// String dataId, String group, long timeoutMs
String config = configService.getConfig(dataId, group, 5000);
System.out.println(config);
//监听:String dataId, String group, Listener listener
configService.addListener(dataId, group, new Listener() {
public Executor getExecutor() {
return null;
}
//当配置有变化 时候获取通知
public void receiveConfigInfo(String s) {
System.out.println(s);
}
});
while (true){
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
Nacos当前版本支持简单的登录功能,默认用户名/密码为: nacos/nacos
。
(1) 生成加密密码
项目中加入依赖
<dependency>
<groupId>org.springframework.securitygroupId>
<artifactId>spring‐security‐coreartifactId>
<version>5.1.4.RELEASEversion>
dependency>
(2) 编写PasswordEncoderUtil类,生成加密后的密码,采用BCrypt加密方法在每次生成密码时会加随机盐,所以生成密码每次可能不一样
public class PasswordEncoderUtil {
public static void main(String[] args) {
System.out.println(new BCryptPasswordEncoder().encode("Ab@123456"));
}
}
# 复制密码
$2a$10$FjBvaraTV5ZpV0RotFJ0reO3xZg7/BzFf49Oa5ROfFqeyymf37/g2
(3) 新增用户或更新数据库密码
新增用户
INSERT INTO users (username, password, enabled) VALUES ('nacos1', '$2a$10$SmtL5C6Gp2sLjBrhrx1vj.dJAbJLa4FiJYZsBb921/wfvKAmxKWyu', TRUE); INSERT INTO roles (username, role) VALUES ('nacos1', 'ROLE_ADMIN');
由于部分公司自己开发控制台,不希望被nacos的安全fifilter拦截。因此nacos支持定制关闭登录功能找到配置文件${nacoshome}/conf/application.properties , 替换以下内容即可。
## spring security config
### turn off security
spring.security.enabled=false
management.security=false
security.basic.enabled=false
nacos.security.ignore.urls=/**
#nacos.security.ignore.urls=/,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*. ico,/console-
fe/public/**,/v1/auth/login,/v1/console/health,/v/cs/**,/v1/ns/**,/v1/cmdb/**,/actuator/**
Web应用程序发展的早期,大部分web工程师将所有的功能模块打包到一起并放在一个web容器中运行,所有功能 模块使用同一个数据库,同时,它还提供API或者UI访问的web模块等。
尽管也是模块化逻辑,但是最终它还是会打包并部署为单体式应用,这种将所有功能都部署在一个web容器中运行的系统就叫做单体架构(也叫:巨石型应用)。
单体架构有很多好处:
许多大型公司,通过采用微服务架构解决了上述问题。其思路不是开发一个巨大的单体式的应用,而是将应用分解为小的、互相连接的微服务。
一个微服务一般完成某个特定的功能,比如订单服务、用户服务等等。每一个微服务都是完整应用,都有自己的业务逻辑和数据库。一些微服务还会发布API给其它微服务和应用客户端使用。
比如,根据前面描述系统可能的分解如下:
每一个业务模块都使用独立的服务完成,这种微服务架构模式也影响了应用和数据库之间的关系,不像传统多个业务模块共享一个数据库,微服务架构每个服务都有自己的数据库。
微服务架构的好处:
下图展示了如何通过Nacos集中管理多个服务的配置:
用户通过Nacos Server的控制台集中对多个服务的配置进行管理。
各服务统一从Nacos Server中获取各自的配置,并监听配置的变化。
首先在nacos发布配置,我们规划了两个服务service1、service2,并且想对这两个服务的配置进行集中维护。 浏览器访问官网 ,打开nacos控制台,并点击菜单配置管理->配置列表
:
在Nacos添加如下的配置:
Service1
Namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 #开发环境
Data ID: service1.yaml
Group : TEST_GROUP
配置格式: YAML
配置内容: common:
name: service1 config
Service2
Namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 #开发环境
Data ID: service2.yaml
Group : TEST_GROUP
配置格式: YAML
配置内容: common:
name: service2 config
为了规范依赖的版本,这里创建父工程,指定依赖的版本。
父工程pom.xml如下:
<project xmlns="maven.apache.org/POM/4.0.0" xmlns:xsi="w3.org/2001/XMLSchemainstance" xsi:schemaLocation="maven.apache.org/POM/4.0.0maven.apache.org/xsd/maven4.0.0.xsd">
<modelVersion>4.0.0modelVersion>
<groupId>com.itheima.nacosgroupId>
<artifactId>nacosconfigartifactId>
<version>1.0SNAPSHOTversion>
<packaging>pompackaging>
<properties>
<project.build.sourceEncoding>UTF8project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF8project.reporting.outputEncoding>
<java.version>1.8java.version>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>springcloudalibabadependenciesartifactId>
<version>2.1.0.RELEASEversion>
<type>pomtype>
<scope>importscope>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>springclouddependenciesartifactId>
<version>Greenwich.RELEASEversion>
<type>pomtype>
<scope>importscope>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>springbootdependenciesartifactId>
<version>2.1.3.RELEASEversion>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>springbootmavenpluginartifactId>
plugin>
plugins>
build>
project>
本小节,我们将演示如何使用 Spring Cloud Alibaba Nacos Confifig在Spring Cloud应用中集成Nacos,通过Spring cloud原生方式快捷的获取配置内容。
Spring Cloud是什么:
Spring Cloud是一系列框架的有序集合。它利用Spring Boot的开发便利性巧妙地简化了分布式系统基础设 施的开发,如服务发现注册、配置中心、消息总线、负载均衡、断路器、数据监控等,都可以用Spring Boot 的开发风格做到一键启动和部署。Spring Cloud并没有重复制造轮子,它只是将目前各家公司开发的比较成 熟、经得起实际考验的服务框架组合起来,集成最多的组件要属Netflflix公司,通过Spring Boot风格进行再封 装屏蔽掉了复杂的配置和实现原理,最终给开发者留出了一套简单易懂、易部署和易维护的分布式系统开发 工具包。
Spring Cloud Alibaba Nacos Config是什么:
Spring Cloud Alibaba Nacos Discovery是Spring Cloud Alibaba的子项目,而Spring Cloud Alibaba是阿 里巴巴公司提供的开源的基于Spring cloud的微服务套件合集,它致力于提供微服务开发的一站式解决方 案,可以理解为spring cloud是一套微服务开发的 标准 ,spring cloud alibaba与spring cloud Netflflix是实 现。使用 Spring Cloud Alibaba方案,开发者只需要添加一些注解和少量配置,就可以将 Spring Cloud 应用 接入阿里分布式应用解决方案,通过阿里中间件来迅速搭建分布式应用系统。
由于Nacos是阿里的中间件,因此,若开发Spring cloud微服务应用,使用Spring Cloud Alibaba Nacos Confifig来集成Nacos的配置管理功能是比较明智的选择。
首先新增一个名为service1工程,并添加group ID 为 com.alibaba.cloud 和 artifact ID 为 spring-cloud-starter-alibaba-nacos-config 的 starter。
<parent>
<artifactId>nacosconfigartifactId>
<groupId>com.itheima.nacosgroupId>
<version>1.0SNAPSHOTversion>
parent>
<modelVersion>4.0.0modelVersion>
<artifactId>service1artifactId>
<dependencies>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>springcloudstarteralibabanacosconfigartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>springbootstarterwebartifactId>
dependency>
dependencies>
一般来说,spring boot的配置将在application.yml(也可以是application.properties)文件中编写, 由于使用外部配置中心,必须将原先的application.yml重命名为bootstrap.yml,bootstrap.yml如下所示:spring.cloud.nacos.confifig.server-addr 指定了Nacos Server的网络地址和端口号。
server:
port: 56010 #启动端口 命令行注入
spring:
application:
name: service1
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848 # 配置中心地址
file-extension: yaml #dataid的名称就是application的name加file-extension servicel.yaml
namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 # 开发环境
group: TEST_GROUP # 测试组
以上配置文件说明该应用将从地址为127.0.0.1:8848配置中心获取配置,通过以下信息定位配置集:
namespace:c67e4a97a6984d6d9bb1cfac5f5b51c4 # 开发环境
group:TEST_GROUP # 测试组
Data Id:service1.yaml
Note:spring-cloud-starter-alibaba-nacos-confifig 在加载配置的时候,加载了以 dataid 为 s p r i n g . a p p l i c a t i o n . n a m e . {spring.application.name}. spring.application.name.{file-extension:properties} 的基础配置。对应以上的配置,它会去 nacos server中加载data id为service1.yaml的配置集。 Note: 若没有指定spring.cloud.nacos.confifig.group配置,则默认为DEFAULT_GROUP。
新增Spring Boot 启动类,并增加获取配置的web访问端点/confifigs,通过标准的spring @Value 方式
package com.itheima.nacos;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
@SpringBootApplication
@RestControllerpublic
class Service1Bootstrap {
public static void main(String[] args) {
SpringApplication.run ( Service1Bootstrap.class, args );
}
//通过Value注解读取配置信息
@Value("${common.name}")
private String config1;
@GetMapping(value = "/configs")
public String getConfigs() {
//读取配置信息
return config1;
}
}
service2的创建流程与service1一致:
需要注意的是spring boot 启动端口要避免重复,spring.application.name为service2。
server:
port: 56020 #启动端口 命令行注入
spring:
application:
name: service2
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848 # 配置中心地址
file-extension: yaml
namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 # 开发环境
group: TEST_GROUP # 测试组
分别启动service1和service2项目,并分别访问 /confifigs进行测试,不同项目能够获取各自的配置内容。
基于上面快速上手的例子,若要实现配置的动态更新,只需要进行如下改造:
// 注入配置文件上下文
@Autowired
private ConfigurableApplicationContext applicationContext;
@GetMapping(value = "/configs")
public String getConfigs(){
return applicationContext.getEnvironment().getProperty("common.name");
}
我们通过nacos控制台更新common.name的配置值,再次访问web端点/confifigs,发现应用程序能够获取到最新 的配置值,说明spring-cloud-starter-alibaba-nacos-confifig 支持配置的动态更新。
Note 可以通过配置spring.cloud.nacos.confifig.refresh.enabled=false来关闭动态刷新
支持自定义 namespace的配置
在没有明确指定 ${spring.cloud.nacos.config.namespace}
配置的情况下, 默认使用的是 Nacos 上 Public 这个namespace。如果需要使用自定义的命名空间,可以通过以下配置来实现:
spring:
cloud:
nacos:
config:
namespace: b3404bc0d7dc4855b519570ed34b62d7
Note:该配置必须放在 bootstrap.yml文件中。此外 spring.cloud.nacos.config.namespace
的值是 namespace对应的 id,id 值可以在 Nacos 的控制台获取。并且在添加配置时注意不要选择其他的 namespae,否则将会导致读取不到正确的配置。
支持自定义 Group 的配置
在没有明确指定 ${spring.cloud.nacos.config.group} 配置的情况下, 默认使用的是 DEFAULT_GROUP 。如果需要自定义自己的 Group,可以通过以下配置来实现:
spring:
loud:
nacos:
config:
group: DEVELOP_GROUP
Note:该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值一定要和spring.cloud.nacos.config.group
的配置值一致。
Spring Cloud Alibaba Nacos Confifig可支持自定义 Data Id 的配置。 一个完整的配置案例如下所示:下边我们在service2微服务下配置扩展
spring:
application:
name: service2
cloud:nacos:
config:
server-addr: 127.0.0.1:8848
# config external configuration
# 1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新
ext-config[0]:
dataid: extconfigcommon01.properties
# 2、Data Id 不在默认的组,不支持动态刷新
ext-config[1]:
dataid: extconfigcommon02.properties
group: GLOBALE_GROUP
# 3、Data Id 既不在默认的组,也支持动态刷新
ext-config[2]:
data-id: extconfigcommon03.properties
group: REFRESH_GROUP
refresh: true # 动态刷新
可以看到:
通过 spring.cloud.nacos.config.ext-config[n].data-id
的配置方式来支持多个 Data Id 的配置。
通过 spring.cloud.nacos.config.ext-config[n].group
的配置方式自定义 Data Id 所在的组,不明确配置的话,默认是 DEFAULT_GROUP。
通过 spring.cloud.nacos.config.ext-config[n].refresh
的配置方式来控制该 Data Id 在配置变更时,是否支持应用中可动态刷新, 感知到最新的配置值。默认是不支持的。
Note : spring.cloud.nacos.config.ext-config[n].data-id 的值必须带文件扩展名,文件扩展名既可支持 properties,又可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩 展配置的 Data Id 文件扩展名没有影响。
通过自定义扩展的 Data Id 配置,既可以解决多个应用间配置共享的问题,又可以支持一个应用有多个配置文件。
测试:
配置ext-confifig-common01.properties:
配置ext-confifig-common02.properties
配置ext-confifig-common03.properties
编写测试代码:
@GetMapping(value = "/configs2")
public String getConfigs2(){
String name = applicationContext.getEnvironment().getProperty("common.name");
String age = applicationContext.getEnvironment().getProperty("common.age");
String address = applicationContext.getEnvironment().getProperty("common.address");
String birthday= applicationContext.getEnvironment().getProperty("common.birthday");
String fullname = applicationContext.getEnvironment().getProperty("common.fullname");
return name+"+"+ age+"+"+address+"+"+ birthday+"+"+ fullname;
}
重启应用,访问http://localhost:56011/configs2,观察配置是否成功获取。
输出:
service2 config+12+beijing+1990-1-1+zhangsansanff
为了更加清晰的在多个应用间配置共享的 Data Id ,你可以通过以下的方式来配置:
spring:
cloud:
nacos:
config:
shared-dataids: ext-configcommon01.properties,extconfigcommon02.properties
refreshable-dataids: extconfigcommon01.properties
可以看到:
通过 spring.cloud.nacos.config.shared-dataids
来支持多个共享 Data Id 的配置,多个之间用逗号隔开。
通过 spring.cloud.nacos.config.refreshable-dataids
来支持哪些共享配置的 Data Id 在配置变化时,应 用中是否可动态刷新, 感知到最新的配置值,多个 Data Id 之间用逗号隔开。如果没有明确配置,默认情况 下所有共享配置的 Data Id 都不支持动态刷新。
Note:通过 spring.cloud.nacos.config.shared-dataids 来支持多个共享配置的 Data Id 时, 多个共享配 置间的一个优先级的关系我们约定:按照配置出现的先后顺序,即后面的优先级要高于前面。
Note:通过 spring.cloud.nacos.config.shared-dataids 来配置时,Data Id 必须带文件扩展名,文件扩 展名既可支持 properties,也可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的 配置对自定义扩展配置的 Data Id 文件扩展名没有影响。
Note: spring.cloud.nacos.config.refreshable-dataids 给出哪些需要支持动态刷新时,Data Id 的值也 必须明确给出文件扩展名。
测试输出:
service2 config+12+beijing+null+null
为什么后边两个值为null?
共享DataId的配置使用默认的group即DEFAULT_GROUP,ext-confifig-common02.properties不属于DEFAULT_GROUP。
共享DataId的配置相比扩展的 Data Id 配置,它把group固定为DEFAULT_GROUP,建议使用扩展的 Data Id 配置,因为扩展的 Data Id 配置也可以实现共享DataId配置。
Spring Cloud Alibaba Nacos Confifig 目前提供了三种配置能力从 Nacos 拉取相关的配置。
spring.cloud.nacos.config.shared-dataids
支持多个共享 Data Id 的配置spring.cloud.nacos.config.ext-config[n].data-id
的方式支持多个扩展 Data Id 的配置,多个Data Id 同时配置时,他的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id
其中 n 的值越大,优先级越高。当三种方式共同使用时,他们的一个优先级关系是:C > B >A
测试,屏蔽共享dataId,放开ext-confifig,如下:
spring:
application:
name: service2
cloud:
nacos:
config:
#enabled: false #关闭配置
server-addr: 127.0.0.1:8848 # 配置中心地址
file-extension: yaml
namespace: c67e4a97a6984d6d9bb1cfac5f5b51c4 # 开发环境
group: TEST_GROUP
# shareddataids: extconfigcommon01.properties,extconfigcommon02.properties
# config external configuration
# 1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新
ext-config[0]:
data-id: ext-config-common01.properties
# 2、Data Id 不在默认的组,不支持动态刷新
ext-config[1]:dataid: extconfigcommon02.properties
group: GLOBALE_GROUP
# 3、Data Id 既不在默认的组,也支持动态刷新
ext-config[2]:dataid: extconfigcommon03.properties
group: REFRESH_GROUP
refresh: true
修改ext-confifig-common03.properties:
输出:
service2 config aaa+15+beijing+1990-1-1+zhangsansanff
通过测试发现多个 Data Id 同时配置时,他的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id
其中 n 的值越大,优先级越高。
输出:
service2 config aaa+25+beijing+199011+zhangsansanff
通过测试发现:B和C同时存在,C优先级高。
通过设置 spring.cloud.nacos.confifig.enabled = false
来完全关闭 Spring Cloud Nacos Confifig
3个或3个以上Nacos节点才能构成集群
我们可以复制之前已经解压好的nacos文件夹,分别命名为nacos、nacos1、nacos2
在所有nacos目录的conf目录下,有文件 cluster.conf.example ,将其命名为 cluster.conf ,并将每行配置成
ip:port。(请配置3个或3个以上节点)
# ip:port
127.0.0.1:8848
127.0.0.1:8849
127.0.0.1:8850
由于是单机演示,需要更改nacos/的conf目录下application.properties中server.port,防止端口冲突。
如果服务器有多个ip也要指定具体的ip地址,如:nacos.inetutils.ip-address=127.0.0.1
例如:
server.port=8850
nacos.inetutils.ip-address=127.0.0.1
分别执行nacos目录的bin目录下的startup:
startup m cluster
所有客户端,分别指定nacos集群中的若干节点:
spring:
application:
name: service2
cloud:
nacos:
config:
#enabled: false #关闭配置
server-addr: 127.0.0.1:8848,127.0.0.1:8849,127.0.0.1:8850 # 配置中心地址
测试,使用快速上手的例子:
(1)关掉127.0.0.1:8848 nacos Leader实例,发现Leader被成功选举至127.0.0.1:8850
(2)紧接着重新启动Provider,这时马上请求consumer的/service出现错误,发现consumer与provider通信已经出现问题。但经过短暂的时间后,通信恢复。
通过测试,我们可以看到,通过以上的集群部署已经达到了高可用的效果。
下图是官方推荐的集群方案,通过域名 + VIP模式的方式来实现。客户端配置的nacos,当Nacos集群迁移时,客户端配置无需修改
至于数据库,生产环境下建议至少主备模式。通过修改${nacoshome}/conf/application.properties文件,能够使nacos拥有多个数据源。
spring.datasource.platform=mysql
db.num=2
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&autoReconnect=true
db.url.1=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&autoReconnect=true
db.user=root
db.password=root