SpringCloud Alibaba Nacos学习笔记

nacos简介

Nacos 支持几乎所有主流类型的“服务”的发现、配置和管理：

• Spring Cloud
• Dubbo
• Spring Boot
• …

Nacos 的关键特性包括:

• 服务发现和服务健康监测
• 动态配置服务
• 动态 DNS 服务
• 服务及其元数据管理

详细介绍请到nacos官网 https://nacos.io/zh-cn/docs/what-is-nacos.html

Nacos使用

这里仅通过SpringCloud来介绍Nacos的使用

Nacos Server安装

下载地址 https://github.com/alibaba/nacos/releases，我这里使用的是1.2.1版本

unzip nacos-server-$version.zip 或者 tar -xvf nacos-server-$version.tar.gz
cd nacos/bin

Nacos启动

sh startup.sh -m standalone

Nacos关闭

sh shutdown.sh

单机模式支持mysql

1. 初始化mysql数据库，数据库初始化文件：nacos-mysql.sql(/usr/local/nacos/conf)
2. 修改conf/application.properties文件，增加支持mysql数据源配置（目前只支持mysql），添加mysql数据源的url、用户名和密码
3. 再以单机模式启动nacos，nacos所有的数据都写到了mysql

集群部署

参考官网 https://nacos.io/zh-cn/docs/cluster-mode-quick-start.html

配置管理

客户端使用方式

完成上面步骤后开始使用nacos完成配置管理

1. 添加pom依赖

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

2. 在bootstrap.properties或bootstrap.yml中配置 Nacos server 的地址和应用名

spring:
  application:
    name: mall-web-order
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8884
        file-extension: yaml

之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 dataId字段的一部分。

```yml
${prefix}-${spring.profiles.active}.${file-extension}
```
- prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
- spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 

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

3. 在Nacos管理中心添加配置
   

通过上面配置，就可以替换本地配置文件

动态刷新

1. 读取输出配置

//动态刷新
@RefreshScope
@RestController
@RequestMapping("/config")
public class ConfigController {
	//读取配置
    @Value("${config.msg}")
    private String msg;

    @GetMapping("get")
    public String get(){

        return msg;
    }
}

2. 在配置中心中添加配置
   

3. 修改配置
   

命名空间与分组

命名空间

用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的 Group 或 Data ID 的配置 Namespace 的常用场景之一是不同环境的配置
的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。 在没有明确指定 ${spring.cloud.nacos.config.namespace} 
配置的情况下， 默认使用的是 Nacos 上 Public 这个namespace

生成命名空间id：47384e27-b550-4e8d-b957-eefff432a52c 通过配置指定命名空间

spring:
  cloud:
    nacos:
      config:
        server-addr: 49.233.166.26:8848
        file-extension: yaml
        namespace: 47384e27-b550-4e8d-b957-eefff432a52c

分组

在新建配置中指定分组

通过group指定分组

spring:
  cloud:
    nacos:
      config:
        server-addr: 49.233.166.26:8848
        file-extension: yaml
        group: DEFAULT_GROUP

自定义扩展的 Data Id 配置

1. 通过spring.cloud.nacos.config.ext-config配置。

# config external configuration
# 1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新
spring.cloud.nacos.config.ext-config[0].data-id=ext-config-common01.properties
 
# 2、Data Id 不在默认的组，不支持动态刷新
spring.cloud.nacos.config.ext-config[1].data-id=ext-config-common02.properties
spring.cloud.nacos.config.ext-config[1].group=GLOBALE_GROUP
 
# 3、Data Id 既不在默认的组，也支持动态刷新
spring.cloud.nacos.config.ext-config[2].data-id=ext-config-common03.properties
spring.cloud.nacos.config.ext-config[2].group=REFRESH_GROUP
spring.cloud.nacos.config.ext-config[2].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 在配置变更时，是否支持应用中可动态刷新， 感知到最新的配置值。默认是不支持的。
多个 Data Id 同时配置时，他的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id 其中 n 的值越大，优先级越高。
spring.cloud.nacos.config.ext-config[n].data-id 的值必须带文件扩展名，文件扩展名既可支持 properties，又可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩展配置的 Data Id 文件扩展名没有影响

2. 通过spring.cloud.nacos.config.shared-dataids配置

spring.cloud.nacos.config.shared-dataids=bootstrap-common.properties,all-common.properties
spring.cloud.nacos.config.refreshable-dataids=bootstrap-common.properties

通过 spring.cloud.nacos.config.shared-dataids 来支持多个共享 Data Id 的配置，多个之间用逗号隔开。
通过 spring.cloud.nacos.config.refreshable-dataids 来支持哪些共享配置的 Data Id 在配置变化时，应用中是否可动态刷新， 感知到最新的配置值，多个 Data Id 之间用逗号隔开。如果没有明确配置，默认情况下所有共享配置的 Data Id 都不支持动态刷新。
通过 spring.cloud.nacos.config.shared-dataids 来支持多个共享配置的 Data Id 时， 多个共享配置间的一个优先级的关系我们约定：按照配置出现的先后顺序，即后面的优先级要高于前面
通过 spring.cloud.nacos.config.shared-dataids 来配置时，Data Id 必须带文件扩展名，文件扩展名既可支持 properties，也可以支持 yaml/yml。 此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩展配置的 Data Id 文件扩展名没有影响。
spring.cloud.nacos.config.refreshable-dataids 给出哪些需要支持动态刷新时，Data Id 的值也必须明确给出文件扩展名。

服务注册发现

1. 引入pom依赖

  <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
       <version>${nacos.version}</version>
   </dependency>

2. 在application.yml添加配置

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 49.233.166.26:8848
        metadata:
          management:
            context-path: ${server.servlet.context-path}/actuator

3. 通过springcloud注解@EnableDiscoveryClient 开始服务注册发现

4. 注册成功之后就可以通过服务名调用指定的服务，见官网例子

  @RestController
  public class TestController {

       private final RestTemplate restTemplate;
		
		@LoadBalanced
	    @Bean
	    public RestTemplate restTemplate() {
	        return new RestTemplate();
	    }
	    
       @Autowired
       public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

       @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
       public String echo(@PathVariable String str) {
           return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
       }
   }