spring cloud集成 NACOS配置中心实现动态配置

一、Nacos配置中心介绍

Nacos提供了两种服务，一种是用于服务注册、发现的Naming Service，一种是用于配置中心、动态配置的Config Service，而他们底层均由core模块来支持。外层提供OpenAPI供客户端使用，并提供了User Console、Admin Console方便用户使用 。Nacos 并不是通过推的方式将服务端最新的配置信息发送给客户端的，而是客户端维护了一个长轮询的任务，定时去拉取发生变更的配置信息，然后将最新的数据推送给 Listener 的持有者。

配置主要有以下几个特点：

配置是独立于程序的只读变量
配置对于程序是只读的，程序通过读取配置来改变自己的行为，但是程序不应该去改变配置
配置伴随应用的整个生命周期
配置贯穿于应用的整个生命周期，应用在启动时通过读取配置来初始化，在运行时根据配置调整行为。 比如：启动时需要读取服务的端口号、系统在运行过程中需要读取定时策略执行定时任务等。

配置可以有多种加载方式:

常见的有程序内部hard code，配置文件，环境变量，启动参数，基于数据库等
配置需要治理
同一份程序在不同的环境（开发，测试，生产）、不同的集群（如不同的数据中心）经常需要有不同的 配置，所以需要有完善的环境、集群配置管理

二、配置中心搭建

1.工程配置

导入nacos-config的POM包:

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.2.RELEASE</version>
</dependency>

2.yml配置NACOS系统信息

新增bootstrap.yml文件，配置信息写在该文件里，因为springboot会优先启动.
bootstrap.yml（bootstrap.properties）用来程序引导时执行，应用于更加早期配置信息读取，如可以使用来配置application.yml中使用到参数等
application.yml（application.properties) 应用程序特有配置信息，可以用来配置后续各个模块中需使用的公共参数等。
加载顺序：bootstrap.yml > application.yml > application-dev(prod).yml > …

在bootstrap.yml中新增application.name和nacos的config信息:

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.8.150:8848
        namespace: 7e6872ef-3933-499c-a88a-505bc90a4bab
      config:
        server-addr: 192.168.8.150:8848
        file-extension: yml # 此处为配置使用的后缀名
        group: DEFAULT_GROUP
        namespace: 7e6872ef-3933-499c-a88a-505bc90a4bab # namespace的内容为nacos中配置的gene命名空间的id。
        shared-dataids: miracle-config.yaml

application.yml配置:

server:
  port: 8099


spring:
  application:
    name: miracle-system
  profiles:
    active: gene

3.NACOS系统新增动态配置参数

先新增命名空间：
最好跟application.yml配置里面的spring.profiles.active 里面对应，记录一下 命名空间ID 后续需要

配置中心新增配置：


在Nacos-Server中新建配置，其中Data ID它的定义规则是：$prefix-${spring.profiles.active}.${file-extension}

prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。

spring.profiles.active 即为当前环境对应的 profile，可以通过配置项 spring.profiles.active 来配置。

file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

一定要选择自己对应的类型，你的文件yaml类型但是你选了properties 会报错的。

注意：
1.当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 prefix.{prefix}.prefix.{file-extension}

2.创建配置文件时，Data ID的后缀需要和配置格式保持一致
代码默认为 properties;代码在引用时需要和Data ID保持一致
与Spring Boot 不同点在于，这里的Data ID 必须指定对应的后缀

我的application.yml中的项目名是：miracle-system
命名空间是：gene
文件后缀是：yml
所以我的Data ID如下：

miracle-system-gene.yml

这个地方容易配置错误，一定要注意。

4.代码配置

官方给出的示例：
Java方式：

package pers.miracle.miraclecloud.system.utils;

import java.util.Properties;
import java.util.concurrent.Executor;
import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.PropertyKeyConst;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;
/**
 * @author lgn
 * @version 1.0
 * @date 2021/10/25 10:27
 */
public class NacosConfigExample {

    /**
     *
     * @param args
     * @throws NacosException
     * @throws InterruptedException
     */
    public static void main(String[] args) throws NacosException, InterruptedException {
        String serverAddr = "192.168.8.150:8848";
        String dataId = "miracle-system-gene.yml";
        String group = "DEFAULT_GROUP";
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);
        ConfigService configService = NacosFactory.createConfigService(properties);
        String content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);
        configService.addListener(dataId, group, new Listener() {
            @Override
            public void receiveConfigInfo(String configInfo) {
                System.out.println("recieve:" + configInfo);
            }

            @Override
            public Executor getExecutor() {
                return null;
            }
        });

        boolean isPublishOk = configService.publishConfig(dataId, group, "content");
        System.out.println(isPublishOk);

        Thread.sleep(3000);
        content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);

        boolean isRemoveOk = configService.removeConfig(dataId, group);
        System.out.println(isRemoveOk);
        Thread.sleep(3000);

        content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);
        Thread.sleep(300000);

    }
}

spring cloud方式：
在使用配置的controller中新增 @RefreshScope 注解，以及在注入属性上新增 @Value("${Key名称}") 注解。@refreshscope关键字，保证可以实时刷新配置。在controller层或者要刷新的值所在的类上进行注释就行。

package pers.miracle.miraclecloud.system.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author lgn
 * @version 1.0
 * @date 2021/10/25 10:51
 */
@RestController
@RequestMapping("/nacos/nacosHelper")
@RefreshScope
public class NacosController {

    @Value("${common.name}")
    private String name;

    @Value("${common.info}")
    private String info;

    @RequestMapping("/getNacosInfo")
    public String get() {
        return "输出一下："+name+info;
    }
}

1.如果使用yaml格式的配置文件, 一定要注意Nocos中配置的书写格式, 注意空格, 如果不输入空格,
使用@Value(“common.name”)会找不到对应的配置参数, 启动服务的时候会报错
在尝试中意外发现可以使用@Value(“common:name”)来获取配置参数, 获取到的是name:zhans 这段字符串.
错误例子:

common:
   name:金角大王

正确例子:

common:
   name: 金角大王
   info: 在平顶山！

访问一下：

修改一下nacos中的参数，看看是否又变化：

可以看到已经变化了