springCloud alibaba：Nacos Config-服务配置

小鱼儿 2023-10-11 17:31 4阅读 0赞

#### 文章目录 ####

*  1.为什么要引入配置中心
 *  2.Nacos Config入门
 *   *  2.1 搭建nacos环境
     *  2.2 添加依赖
     *  2.3 新建bootstrap.yml，后面的配置都要写在这个文件里
     *  2.4 在naco服务里添加配置
 *  3.Nacos Config深入
 *   *  3.1 配置动态刷新
     *  3.2 配置共享
     *   *  同一个微服务的不同环境之间共享配置
         *  不同微服务之间的配置共享
 *  4.Nacos的几个概念

## 1.为什么要引入配置中心 ##

1.  配置文件相对分散。在一个微服务架构下，配置文件会随着微服务的增多变的越来越多，而且分散在各个微服务中，不好统一配置和管理。
2.  配置文件无法区分环境。微服务项目可能会有多个环境，例如：测试环境、预发布环境、生产环境。每一个环境所使用的配置理论上都是不同的，一旦需要修改，就需要我们去各个微服务下手动维护，这比较困难。
3.  配置文件无法实时更新。我们修改了配置文件之后，必须重新启动微服务才能使配置生效，这对一个正在运行的项目来说是非常不友好的。

基于上面这些问题，我们就需要配置中心的加入来解决这些问题。

配置中心的思路是：  
首先把项目中各种配置全部都放到一个集中的地方进行统一管理，并提供一套标准的接口。

当各个服务需要获取配置的时候，就来配置中心的接口拉取自己的配置。  
当配置中心中的各种参数有更新的时候，也能通知到各个服务实时的过来同步最新的信息，使之动  
态更新。

当加入了服务配置中心之后，我们的系统架构图会变成下面这样：  
![在这里插入图片描述][07848dd99834409cbc100ef479bc99df.png_pic_center]

当然也有很多优秀的开源配置中心：

*  SpringCloud Config（最常用）  
    这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成，使用起来非常方便，并且它的配置存储支持Git。不过它没有可视化的操作界面，配置的生效也不是实时的，需要重启或去刷新。
 *  Disconf  
    Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效的。

## 2.Nacos Config入门 ##

首先要确保你已经有nacos服务注册中心。

Nacos作为配置中心的本质其实就是将nacos当做一个服务端，将各个微服务看成是客户端，我们将各个微服务的配置文件统一存放在nacos上，然后各个微服务从nacos上拉取配置即可。

### 2.1 搭建nacos环境 ###

*  [docker部署nacos][docker_nacos]
 *  [windows集成nacos][windows_nacos]

### 2.2 添加依赖 ###

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
                <version>2021.1</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bootstrap</artifactId>
            </dependency>

我的SpringBoot版本：2.6.2  
![在这里插入图片描述][15d1515fd73e4bee9f9bf5d753ff3cd2.png_pic_center]

### 2.3 新建bootstrap.yml，后面的配置都要写在这个文件里 ###

spring:
      application:
        name: service-product
      cloud:
        nacos:
          config:
            server-addr: 192.168.1.2:8848 #nacos中心地址
            file-extension: yaml #配置文件格式
      profiles:
        active: dev #环境标识

### 2.4 在naco服务里添加配置 ###

> 点击配置列表，点击右边+号，新建配置。在新建配置过程中，要注意下面的细节：  
> 1）Data ID不能随便写，要跟配置文件中的对应，对应关系如图所示  
> 2）配置文件格式要跟配置文件的格式对应，且目前仅仅支持YAML和Properties  
> 3）配置内容按照上面选定的格式书写

![在这里插入图片描述][08ae8921c88f4d93867877f3922a672f.png_pic_center]

![在这里插入图片描述][617bd65b60074463a3b3b5e473efd5ef.png_pic_center]

自己可以先尝试试一下新增一个修改端口号的配置，启动项目  
![在这里插入图片描述][a091504af8ea47e286bd8309a53deb06.png_pic_center]

可以看到我们的配置已经生效

## 3.Nacos Config深入 ##

### 3.1 配置动态刷新 ###

在上面的案例中，我们实现了配置的远程存放，但是此时如果修改了配置，我们的程序是无法读取到的，因此，我们需要开启配置的动态刷新功能。

在nacos中的service-product-dev.yaml配置项中添加下面配置:

config:
      appName: product

![在这里插入图片描述][ecfc8d62b762446380ba8592f2141408.png_pic_center]

方式一: 硬编码方式

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.ConfigurableApplicationContext;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class NacosConfigController {
        
        @Autowired
        private ConfigurableApplicationContext applicationContext;
    
        @GetMapping("/nacos-config-test1")
        public String nacosConfingTest1() {
        
            return applicationContext.getEnvironment().getProperty("config.appName");
        }
    }

方式二: 注解方式(推荐)

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RefreshScope//只需要在需要动态读取配置的类上添加此注解就可以
    public class NacosConfigController2 {
        
        @Value("${config.appName}")
        private String appName;
    
        //2 注解方式
        @GetMapping("/nacos-config-test2")
        public String nacosConfingTest2() {
        
            return appName;
        }
    }

![在这里插入图片描述][56fe0a92a22d46b486f3fbcb361402ad.png_pic_center]

### 3.2 配置共享 ###

当配置越来越多的时候，我们就发现有很多配置是重复的，这时候就考虑可不可以将公共配置文件提取出来，然后实现共享呢？当然是可以的。

#### 同一个微服务的不同环境之间共享配置 ####

这个是什么意思呢，我们还是以刚刚创建的微服务service-product为例，假如我们线上需要的环境是service-produt-prod，然后我们开发时使用的环境是：service-produt-dev，比如prod和dev之间数据库配置不同，日志配置不同等等，但是两个环境配置之间也有相同的配置，如：服务名，端口号等其他信息，那么我们怎么把这些相同的抽取出来呢？

很简单，只需要提取一个以 spring.application.name 命名的配置文件，然后将其所有环境的公共配置放在里面即可。

步骤如下：

1.  新建一个名为service-product.yaml配置存放商品微服务的公共配置  
    当然自己操作的时候可以先简单的把server.port提取出来。  
    ![在这里插入图片描述][259cba33288e4903a10830bcd19b4f1a.png_pic_center]

2.新建一个名为service-product-test.yaml配置存放测试环境的配置，我们只需简单的进行测试即可。  
![在这里插入图片描述][a1e9a42712524b60a1d67a57f85ede86.png_pic_center]

![在这里插入图片描述][69e3f045d4354e3aa041b0ab7050cf32.png_pic_center]

下面我们测试一下：

*  先测试一下dev环境  
    ![在这里插入图片描述][053d2dd0251e4ea0b374df02287180a2.png_pic_center]

我们虽然是dev环境，但是端口的配置仍然生效：  
![在这里插入图片描述][3b3ededf000342a89f4e1b5620f2917e.png_pic_center]

访问一下：http://localhost:8081/nacos-config-test2  
![在这里插入图片描述][8ce1500ec48b4914bbde91e9261a882a.png_pic_center]

*  在测试一下test环境  
    ![在这里插入图片描述][4799bc12824f480289dbc69bb0cff70f.png_pic_center]

仍然还是访问:http://localhost:8081/nacos-config-test2  
![在这里插入图片描述][4ae7dc6597d9491c8f9b2413bd855993.png_pic_center]

#### 不同微服务之间的配置共享 ####

不同为服务之间实现配置共享的原理类似于文件引入，就是定义一个公共配置，然后在当前配置中引入。

举个最简单的应用场景，可以很多个微服务都是注册到一个nacos里面，那么我们就可以把注册到nacos的配置写到公共服务里面，下面我们去实现 这个很简单的场景。

当然在实现之前，我们需要集成一些依赖和修改一些配置

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
                <version>2021.1</version>
            </dependency>

在启动类添加注解

@EnableDiscoveryClient

![在这里插入图片描述][7509b25e9ba94ba79533894c9acc7e16.png_pic_center]

在Nacos配置里面，新增一个公共配置：all-service.yaml，用于所有微服务的共享

spring:
      cloud:
        nacos:
          discovery:
            server-addr: 127.0.0.1:8848
            username: nacos
            password: nacos

![在这里插入图片描述][5650d14e74594fd5997952da6509bc31.png_pic_center]

重启我们的项目，可以看到  
![在这里插入图片描述][ee6b8e9082fa4429bd12981e4a5517a1.png_pic_center]

我们的服务已经注入到nacos里面来了。

## 4.Nacos的几个概念 ##

*  命名空间(Namespace)  
    命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间
 *  配置分组(Group)  
    配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组
 *  配置集(Data ID)  
    在系统中，一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集

![在这里插入图片描述][c5a2243afde2493bac8be662c883b908.png_pic_center]

[07848dd99834409cbc100ef479bc99df.png_pic_center]: https://img-blog.csdnimg.cn/07848dd99834409cbc100ef479bc99df.png#pic_center
[docker_nacos]: https://blog.csdn.net/zhiyikeji/article/details/122453947
[windows_nacos]: https://blog.csdn.net/zhiyikeji/article/details/124386298
[15d1515fd73e4bee9f9bf5d753ff3cd2.png_pic_center]: https://img-blog.csdnimg.cn/15d1515fd73e4bee9f9bf5d753ff3cd2.png#pic_center
[08ae8921c88f4d93867877f3922a672f.png_pic_center]: https://img-blog.csdnimg.cn/08ae8921c88f4d93867877f3922a672f.png#pic_center
[617bd65b60074463a3b3b5e473efd5ef.png_pic_center]: https://img-blog.csdnimg.cn/617bd65b60074463a3b3b5e473efd5ef.png#pic_center
[a091504af8ea47e286bd8309a53deb06.png_pic_center]: https://img-blog.csdnimg.cn/a091504af8ea47e286bd8309a53deb06.png#pic_center
[ecfc8d62b762446380ba8592f2141408.png_pic_center]: https://img-blog.csdnimg.cn/ecfc8d62b762446380ba8592f2141408.png#pic_center
[56fe0a92a22d46b486f3fbcb361402ad.png_pic_center]: https://img-blog.csdnimg.cn/56fe0a92a22d46b486f3fbcb361402ad.png#pic_center
[259cba33288e4903a10830bcd19b4f1a.png_pic_center]: https://img-blog.csdnimg.cn/259cba33288e4903a10830bcd19b4f1a.png#pic_center
[a1e9a42712524b60a1d67a57f85ede86.png_pic_center]: https://img-blog.csdnimg.cn/a1e9a42712524b60a1d67a57f85ede86.png#pic_center
[69e3f045d4354e3aa041b0ab7050cf32.png_pic_center]: https://img-blog.csdnimg.cn/69e3f045d4354e3aa041b0ab7050cf32.png#pic_center
[053d2dd0251e4ea0b374df02287180a2.png_pic_center]: https://img-blog.csdnimg.cn/053d2dd0251e4ea0b374df02287180a2.png#pic_center
[3b3ededf000342a89f4e1b5620f2917e.png_pic_center]: https://img-blog.csdnimg.cn/3b3ededf000342a89f4e1b5620f2917e.png#pic_center
[8ce1500ec48b4914bbde91e9261a882a.png_pic_center]: https://img-blog.csdnimg.cn/8ce1500ec48b4914bbde91e9261a882a.png#pic_center
[4799bc12824f480289dbc69bb0cff70f.png_pic_center]: https://img-blog.csdnimg.cn/4799bc12824f480289dbc69bb0cff70f.png#pic_center
[4ae7dc6597d9491c8f9b2413bd855993.png_pic_center]: https://img-blog.csdnimg.cn/4ae7dc6597d9491c8f9b2413bd855993.png#pic_center
[7509b25e9ba94ba79533894c9acc7e16.png_pic_center]: https://img-blog.csdnimg.cn/7509b25e9ba94ba79533894c9acc7e16.png#pic_center
[5650d14e74594fd5997952da6509bc31.png_pic_center]: https://img-blog.csdnimg.cn/5650d14e74594fd5997952da6509bc31.png#pic_center
[ee6b8e9082fa4429bd12981e4a5517a1.png_pic_center]: https://img-blog.csdnimg.cn/ee6b8e9082fa4429bd12981e4a5517a1.png#pic_center
[c5a2243afde2493bac8be662c883b908.png_pic_center]: https://img-blog.csdnimg.cn/c5a2243afde2493bac8be662c883b908.png#pic_center