Spring Cloud Alibaba Nacos Config 配置中心

https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

首先我们来看一下,微服务架构下关于配置文件的一些问题：

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

配置中心的思路是：

首先把项目中各种配置全部都放到一个集中的地方进行统一管理，并提供一套标准的接口。
当各个服务需要获取配置的时候，就来配置中心的接口拉取自己的配置。
当配置中心中的各种参数有更新的时候，也能通知到各个服务实时的过来同步最新的信息，使之动态更新。

在业界常见的服务配置中心，有下面这些：

Apollo

Apollo是由携程开源的分布式配置中心。特点有很多，比如：配置更新之后可以实时生效，支持灰度发布功能，并且能对所有的配置进行版本管理、操作审计等功能，提供开放平台API。并且资料也写的很详细。

Disconf

Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效的。

SpringCloud Config

这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成，使用起来非常方便，并且它的配置存储支持Git。不过它没有可视化的操作界面，配置的生效也不是实时的，需要重启或去刷新。

Nacos

这是SpingCloud alibaba技术栈中的一个组件，前面我们已经使用它做过服务注册中心。其实它也集成了服务配置的功能，我们可以直接使用它作为服务配置中心。

权限管理

启动权限：修改nacos-server-1.4.2\nacos\conf下的application.properties

### If turn on auth system:
nacos.core.auth.enabled=true

搭建nacos-config服务

1、搭建nacos环境【使用现有的nacos环境即可】

2、在微服务中引入nacos的依赖

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

3、在微服务中添加nacos config的配置

注意:不能使用原来的application.yml作为配置文件，而是新建一个bootstrap.yml作为配置文件

配置文件优先级(由高到低):

bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml

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

4 在nacos中添加配置

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

5 注释本地的application.yam中的内容，启动程序进行测试

如果依旧可以成功访问程序，说明我们nacos的配置中心功能已经实现

NACOS CONFIG深入

配置动态刷新

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

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

config: 
   appName: product

方式一: 硬编码方式

@RestController
public class NacosConfigController {
  @Autowired
  private ConfigurableApplicationContext applicationContext;
  @GetMapping("/nacos-config-test1")
  public String nacosConfingTest1() {
    return
applicationContext.getEnvironment().getProperty("config.appName");
 }
}

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

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

配置共享

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

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

如果想在同一个微服务的不同环境之间实现配置共享，其实很简单。

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

1、新建一个名为order.yaml配置存放商品微服务的公共配置

2、新建一个名为order.yaml配置存放测试环境的配置

3、新建一个名为rder-dev.yaml配置存放开发环境的配置

4、添加测试方法

@RestController
@RefreshScope
public class NacosConfigController {
  @Value("${config.env}")
  private String env;
  //3 同一微服务的不同环境下共享配置
  @GetMapping("/nacos-config-test3")
  public String nacosConfingTest3() {
    return env;
 }
}

接下来，修改bootstrap.yml中的配置，将active设置成test，再次访问，观察结果

spring:
profiles:
 active: test # 环境标识

nacos的几个概念

命名空间(Namespace)

命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间

配置分组(Group)

配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组

配置集(Data ID)

在系统中，一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloudalibaba</artifactId>
        <groupId>com.wsm.springcloud</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>config-nacos</artifactId>

    <dependencies>
        <!-- nacos config 依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>

</project>

application.yml

server:
  port: 8050

bootstrap.yml

spring:
  application:
#    name: config-nacos
    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
        namespace: public

package com.wsm.config;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class ConfigApplication {

    public static void main(String[] args) {
//        SpringApplication.run(ConfigApplication.class,args);
        ConfigurableApplicationContext applicationContext = SpringApplication.run(ConfigApplication.class, args);
        String userName = applicationContext.getEnvironment().getProperty("user.name");
        String userAge = applicationContext.getEnvironment().getProperty("user.age");
        System.err.println("user name :"+userName+"; age: "+userAge);
    }

}

bootstrap.yml

spring:
  application:
#    name: config-nacos
    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
        namespace: public
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置

bootstrap.yml

spring:
  application:
#    name: config-nacos
    #跟服务名相同的DataId的配置文件，称之为默认的配置
    #除了默认的配置文件，其他配置文件必须写上后缀
#    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
    name: config-nacos-dev.yaml
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
        namespace: public
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置
#        refresh-enabled: false  #是否感知配置文件变化

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloudalibaba</artifactId>
        <groupId>com.wsm.springcloud</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>config-nacos</artifactId>

    <dependencies>
        <!-- nacos config 依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!-- mysql驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jdbc</artifactId>
            <version>2.5.6</version>
        </dependency>
<!--        <dependency>-->
<!--            <groupId>com.baomidou</groupId>-->
<!--            <artifactId>mybatis-plus-boot-starter</artifactId>-->
<!--            <version>3.4.2</version>-->
<!--        </dependency>-->
    </dependencies>

</project>

bootstrap.yml

spring:
  application:
#    name: config-nacos
    #跟服务名相同的DataId的配置文件，称之为默认的配置
    #除了默认的配置文件，其他配置文件必须写上后缀
#    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
    name: config-nacos-dev.yaml
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
#        namespace: public  #默认public,配置
        namespace: c8296d30-25bc-47f2-95a0-5698e69aa6d7  #dev环境
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置
#        group: DEFAULT_GROUP  #默认DEFAULT_GROUP
        group: dev_group
#        refresh-enabled: false  #是否感知配置文件变化

bootstrap.yml

spring:
  application:
#    name: config-nacos
    #跟服务名相同的DataId的配置文件，称之为默认的配置
    #除了默认的配置文件，其他配置文件必须写上后缀
#    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
    name: config-nacos-dev.yaml
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
#        namespace: public  #默认public,配置
        namespace: c8296d30-25bc-47f2-95a0-5698e69aa6d7  #dev环境
        #file-extension只针对默认配置文件和profile
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置
#        group: DEFAULT_GROUP  #默认DEFAULT_GROUP
        group: dev_group
#        refresh-enabled: false  #是否感知配置文件变化
        shared-configs:
#          - data-id: com.wsm.order.redis
          - data-id: config-common-dev.yaml
            refresh: true
            group: test_group #默认DEFAULT_GROUP

package com.wsm.config;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class ConfigApplication {

    public static void main(String[] args) {
//        SpringApplication.run(ConfigApplication.class,args);
        ConfigurableApplicationContext applicationContext = SpringApplication.run(ConfigApplication.class, args);
        String userName = applicationContext.getEnvironment().getProperty("user.name");
        String userAge = applicationContext.getEnvironment().getProperty("user.age");
        String config = applicationContext.getEnvironment().getProperty("user.config");
        System.err.println("user name :"+userName+"; age: "+userAge+"; config: "+config);
    }

}

bootstrap.yml

spring:
  application:
#    name: config-nacos
    #跟服务名相同的DataId的配置文件，称之为默认的配置
    #除了默认的配置文件，其他配置文件必须写上后缀
#    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
    name: config-nacos-dev.yaml
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
#        namespace: public  #默认public,配置
        namespace: c8296d30-25bc-47f2-95a0-5698e69aa6d7  #dev环境
        #file-extension只针对默认配置文件和profile
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置
#        group: DEFAULT_GROUP  #默认DEFAULT_GROUP
        group: dev_group
#        refresh-enabled: false  #是否感知配置文件变化
        shared-configs[0]:
          data-id: config-common-dev.yaml
          refresh: true
          group: test_group #默认DEFAULT_GROUP

bootstrap.yml

spring:
  application:
#    name: config-nacos
    #跟服务名相同的DataId的配置文件，称之为默认的配置
    #除了默认的配置文件，其他配置文件必须写上后缀
#    name: com.wsm.order.redis #对应nacos界面管理中的配置管理里的 DataId，会自动根据服务名摘取DataId对应的配置文件，如果DataId根服务名不一致，就需要手动指定DataId
    name: config-nacos-dev.yaml
  cloud:
    nacos:
      server-addr: 192.168.133.128:8847
      config:
        username: nacos
        password: nacos
#        namespace: public  #默认public,配置
        namespace: c8296d30-25bc-47f2-95a0-5698e69aa6d7  #dev环境
        #file-extension只针对默认配置文件和profile
        file-extension: yaml  #默认是properties的文件扩展名，一量修改成了非properties格式，则必须通过file-extension进行设置
#        group: DEFAULT_GROUP  #默认DEFAULT_GROUP
        group: dev_group
#        refresh-enabled: false  #是否感知配置文件变化
        shared-configs[0]:
          data-id: config-common-dev.yaml
          refresh: true
          group: test_group #默认DEFAULT_GROUP
        shared-configs[1]:
          data-id: config-common-dev2.yaml
          refresh: true
          group: test_group #默认DEFAULT_GROUP
        extension-configs[0]:
          data-id: config-common-dev3.yaml
          refresh: true
          group: test_group #默认DEFAULT_GROUP
#配置文件的优先级（优先级大的会覆盖优先级小的，并且会形成互补）
#profile > 默认配置文件 > extension-configs (下标越大优先级就越大）> shared-configs (下标越大优先级就越大）

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloudalibaba</artifactId>
        <groupId>com.wsm.springcloud</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>config-nacos</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <!--            <version>2.5.5</version>-->
        </dependency>
        <!-- nacos config 依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!-- mysql驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jdbc</artifactId>
            <version>2.5.6</version>
        </dependency>
<!--        <dependency>-->
<!--            <groupId>com.baomidou</groupId>-->
<!--            <artifactId>mybatis-plus-boot-starter</artifactId>-->
<!--            <version>3.4.2</version>-->
<!--        </dependency>-->
    </dependencies>

</project>

package com.wsm.config.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;

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${user.name}")
    public String username;

    @RequestMapping("/show")
    public String show(){
        return username;
    }

}

posted @ 2021-11-09 14:37 残星阅读(561) 评论(0) 编辑收藏举报

刷新页面返回顶部

纸上得来终觉浅，绝知此事要躬行

Spring Cloud Alibaba Nacos Config 配置中心

NACOS CONFIG深入

公告