天晴小猪
2022/11/26阅读：31主题：自定义主题1
分布式服务配置之nacos
背景知识
在实际的项目中，一般都会使用到一些配置文件，如配置数据库链接、配置log级别和输出方式……，在传统的单体应用中，我们一般会把配置项与项目部署文件放到一起，配置项会随着代码的修改进行部署生效。这样也无可厚非。
但是随着技术的发展，在微服务架构中，由于微服务架构具有以下特点：
-
具有多个不同的环境，如DEV、SIT、UAT、PRD等； -
迭代周期短； -
配置项多而杂； -
……
总之，就是配置过程频繁而繁琐。此时如果还用传统单体应用管理配置项的方式来管理配置，就显得有些格格不入了。于是我们需要一种新型的管理配置的方式。此时，配置中心应运而生。
技术选型
早期，配置中心的主要功能特性是管理配置，但随着技术的发展和业务的需求，加上程序员极致热情，配置中心有多了一些权限管理、实时更新、版本管理、灰度管理、安全配置等一系列的高级特性。
目前，Java领域的配置中心大概有这么几种： Nacos、ZK、Apollo、SpringCloud-Config等。关于不同技术类型的选择方法，参见《你真的会做技术选型吗？》，这里不再赘述，本篇文章，主要介绍一下nacos相关内容。
Nacos相关概念
“微信扫码关注“天晴小猪”（ID： it-come-true），回复“springcloud”，获取本章节实战源码。
”
关于nacos服务的搭建过程，请参考：《01.服务治理之Nacos》，这里不再赘述。Nacos有几个重要的概念：
-
Data ID ：配置项的唯一标识，可以理解为一个配置文件，它的命名格式是： ${prefix}-${spring.profiles.active}.${file-extension}， 其中prefix为前缀，默认是 spring.application.name 的值，当然也可以通过 spring.cloud.nacos.config.prefix 来进行配置；spring.profiles.active为项目生效的profile的名称，这个值和前面的短横杠为空时，DataID变成${prefix}-${spring.profiles.active}.${file-extension}，这种方式也是合法的；file-exetension表示配置文件的格式，目前只支持properties和yaml类型； -
命名空间 -
NameSpace ： 命名空间，是一种隔离手段，用来隔离不同环境或不同分组的profile； -
Group： 命名分组，也是一种隔离手段，可以在命名空间级别上再次进行隔离； -
区别： 命名空间的隔离粒度较粗，命名分组的隔离粒度较细；
-
下面我们通过不同的业务场景，来看一下不同方式获取配置项的区别。
传统方式获取配置项
直接使用 @Value 注解获取即可。实现的大概过程是：
-
在配置文件中填写配置内容；
-
通过 @Value 注解获取配置信息；
这种方式有一个缺点：每次修改配置项，都需要重启应用；无法满足在项目中实时感知配置项的变化的需求。
应用接入nacos
应用程序接入第三方组件的过程大概都可以分成以下几个步骤：
-
pom文件中引入组件的相关依赖坐标； -
在配置文件中添加配置项，即配置的key-value键值对，或者使用@Component、@Configuration+JavaBean的方式进行配置； -
有些组件还需要在启动类上添加相关的注解来开启功能； -
进行使用
Nacos的接入也分成三个步骤：
-
pom中引入相关依赖
由于引入了自制的项目的starter工程来统一管理依赖的版本，因此在这个模块中只需要添加 groupId和artifactId即可，不需要添加版本。
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
-
配置nacos相关信息
Nacos作为注册中心，完全替代了原有的配置文件，因此需要使用更高级别的配置文件，即 bootstrap 的配置文件，因此nacos的配置内容需要在 bootstrap.yml 文件中完成。
-
直接使用
参见下面使用样例。
直接使用nacos获取配置项
-
在nacos的控制台添加配置项
-
通过@Value标注变量，并获取配置项
使用nacos共享配置文件方式获取配置项
在实际开发过程中，一个项目可能会有多个配置项，如需要配置redis、mysql、mq等，那么我们就可以使用nacos的共享配置文件的方式获取配置项。
-
在bootstrap.yml中添加共享配置项的配置
-
在nacos控制台添加共享配置项
-
通过@Value标注变量，并获取配置项
共享配置文件映射成JavaBean
上面的样例中，我们都是先通过@Value标注变量，但是这种方式还有不够便捷，既然是面向对象编程，那么我们就希望获取到的配置文件转成JavaBean的方式进行使用。请看下面样例：
-
在bootstrap.yml中添加共享配置项的配置
-
控制台添加配置
-
添加配置项的JavaBean进行映射
@Component
@ConfigurationProperties(prefix = "mybrother")// prefix 的值就是控制台添加的配置文件的名称
public class MyBrotherInfo {
private String name;
private String age;
private String sex;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
}
-
注入JavaBean后进行使用
我们还可以把不同项目的一些公共配置放到一个配置文件中，然后在不同的项目中设置相同的配置项，达到一处变更，处处修改的目的。
实时获取配置变更
获取变更后的配置文件，我们只需要在获取的接口上添加 @RefreshScope 注解即可。
添加日志
在实际的项目开发过程中，我们有时候可能需要对业务代码添加一些日志，便于我们后续查找问题。添加日志的过程如下：
-
在项目中导入依赖
<!--使用 @Slf4j 注解-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
-
配置文件中配置日志的级别
-
使用注解标注日志统计器
-
记录日志信息
在ide控制台的输入日志中，我们还可以查看nacos客户端读取服务端配置文件的日志信息：
Nacos方式VS传统方式
传统方式：
-
每次配置变更都需要重启服务； -
无法实时感知配置项的变化过程；
使用nacos作为配置中心：
-
配置变更后不需要重启服务； -
可以实时感知到配置的变化过程；
开发的最佳实践
“微信扫码关注“天晴小猪”（ID： it-come-true），回复“springcloud”，获取本章节实战源码。
”
通过上面的案例，我们可以了解到Nacos作为配置中心有几个重要的功能特性：
-
命名空间 -
命名分组 -
共享文件配置
实际的开发过程肯定要比上面的几种简单案例复杂，那么我们在实际的开发过程中如何使用这几种配置方式呢？
方式一
为每一个服务都创建一个namespace，然后不同的环境使用不同的Group来隔离。如不同模块的开发环境的配置文件统一放到DEV的命名空间下，在同一个命名空间下，我们可以通过不同的命名分组进行区分，如模块A的开发环境的配置文件属于DEV命名空间下的GroupA，模块B的开发环境的配置文件属于DEV命名空间下的GroupB。
这样做的好处是符合传统的以不同环境作为区分的思路，便于理解；并且还可以让不同的应用在相同环境下共享配置文件；但是这种方式也有坏处，那就是不能跨环境共享配置文件。
方式二
为每一个环境都配置一个namespace，不同的服务使用同名的配置文件；实际操作上，我们可以使用服务名作为命名空间，再通过命名分组进行区分不同的环境。这种方式是把不同环境的配置文件放到了同一个命名空间下，实现了不同环境下的共享配置文件的配置。但这种方式也有缺点，那就是可能每一个服务的命名空间中都有相同的一份配置文件，也就是不同服务无法共享一些公共的配置文件。
Nacos的高可用
相比较传统单体应用中，配置文件跟业务代码放到一起的方式，配置中心的方式相当于集中管理配置，在使配置便捷化的过程中，也引入了一个重要的问题，那就是：配置中心异常无法对外提供服务后，会导致所有的应用无法获取配置，导致项目启动不起来。
针对这个问题Nacos也提供了解决方案，那就是Nacos的高可用机制。简单来说就是部署多个Nacos实例，让Nacos形成集群，统一对外提供服务。 Nacos的集群模式这里不再赘述，详见官方文档。
此外Nacos本身是由Java语言编写，Nacos也支持持久化，有兴趣的读者可以自行研究一下持久化的部署过程。
总结
-
介绍了配置中心出现的背景； -
分别介绍了传统方式获取配置项及Nacos获取配置项的不同方式，并简单介绍了这几种方式的区别； -
介绍了Nacos在实际开发场景下的不同实践方式以及它们的优缺点； -
简单介绍了Nacos的其他高级特性；
作者介绍