Nacos学习笔记

Nacos简介

Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。Nacos 帮助更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。

Nacos提供两个主要的能力：

•       服务注册中心

　　　　Nacos 支持基于 DNS 和基于 RPC 的服务发现。

　　　　服务提供者使用原生SDK、OpenApi注册 Service 后，服务消费者可以使用DNS TODO或HTTP&API查找和发现服务。

　　　　Nacos提供对服务的健康监测，阻止向不健康的服务或者实例发送请求。

•      动态配置中心

　　　　动态配置服务可以让您以中心化、外部化和动态化的方式管理所有环境的应用配置和服务配置。

　　　　动态配置消除了配置变更时重新部署应用和服务的需要，让配置管理变得更加高效和敏捷。

　　　　配置中心化管理让实现无状态服务变得更简单，让服务按需弹性扩展变得更容易。

 

中文官网 ： https://nacos.io/zh-cn/

GitHub    ： https://github.com/alibaba/nacos

 

部署方式

Nacos支持三种部署方式

单机模式：用户测试和单机使用。

集群模式：生产环境使用，保证服务的高可用。

多集群模式： 用于多数据中心场景。

 

本地测试使用单机模式部署

Linux/Unix/Mac： 运行命令 startup.sh -m standalone

Windows： 双击 startup.cmd 文件

 

另外单机模式还支持mysql（默认使用内嵌数据库），具体的操作步骤：

· 1.安装数据库，版本要求：5.6.5+

· 2.初始化mysql数据库，数据库初始化文件：nacos-mysql.sql

· 3.修改conf/application.properties文件，增加支持mysql数据源配置（目前只支持mysql），添加mysql数据源的url、用户名和密码。

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://11.162.196.16:3306/nacos_devtest?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=nacos_devtest
db.password=youdontknow

单机模式启动nacos，nacos所有写嵌入式数据库的数据都写到了mysql。

 

SpringCloud使用Nacos实现服务的注册与发现

服务注册

1. 首先进行Maven配置，在pom文件中引入SpringCloud-Nacos的依赖。

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <packaging>jar</packaging>
  <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>2.1.13.RELEASE</version>
     <relativePath/>
  </parent>
  <groupId>com.example</groupId>
  <artifactId>service-provider</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>service-provider</name>
  <description>Demo project for Service Provider</description>
  <properties>
     <java.version>1.8</java.version>
     <nacos.version>2.1.2.RELEASE</nacos.version>
  </properties>
  
  <dependencies>
     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
     <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        <version>${nacos.version}</version>
     </dependency>
  </dependencies>
  
  <build>
   <plugins>
      <plugin>
          <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
   </plugins>
</build>
</project>

 2. 配置Nacos连接信息，新建application.yaml配置文件。

server: 
  port: 7001 
spring: 
  application:
    name: service-provider 
    cloud: 
      nacos:
        discovery: 
          server-addr: 127.0.0.1:8848 
          namespace: d95b5b39-cc31-422b-895d-6b56aed294c8
          group: tydd

 3. 配置启动类，添加SpringCloud的服务注册发现标签（@EnableDiscoveryClient）。

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceProviderApplication {
   public static void main(String[] args) {
      SpringApplication.run(ServiceProviderApplication.class, args);
   }
}

启动项目时在日志中可以看到服务注册信息日志  （NacosServiceRegistry    : nacos registry, tydd service-provider 199.168.24.239:7001 register finished）。服务启动成功在Nacos控制台中查看到服务的注册信息。服务的注册信息详情中可以查看到实例的IP、端口、健康状态、自定义元数据等信息。（控制台访问地址：http://127.0.0.1:8848/nacos/index.html#/login）

 

 

 图：服务注册信息

 

 

 图：服务实例信息

通常微服务架构中，一个服务一般会部署多个实例来确保服务的高可用和提升服务的性能。下面演示服务注册多个实例的场景。

创建配置文件 application-A.yaml 和 application-B.yaml ，配置项不变，只修改端口号避免端口重复（因为在是一台机器上演示，所以端口号要区分）。

然后执行Maven打包命令生成Jar包，通过命令启动两个项目实例 java -jar service-provider-0.0.1-SNAPSHOT.jar --spring.profiles.active=A /  java -jar service-provider-0.0.1-SNAPSHOT.jar --spring.profiles.active=B ，项目启动成功在控制台中可以看到 service-provide 服务有两个实例注册成功，如下图所示。

 

 

 

 服务发现

通过一个简单的例子演示如何在Spring Cloud项目中启用Nacos的服务发现功能。

1. 首先创建新的应用 service-consumer，应用的Maven依赖和application.yaml配置如下。

<?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">
    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.13.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.example</groupId>
    <artifactId>service-consumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service-consumer</name>
    <description>Demo project for service-consumer</description>
    <properties>
        <java.version>1.8</java.version>
        <nacos.version>2.1.2.RELEASE</nacos.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>${nacos.version}</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

 

server:
  port: 7003
spring:
  application:
    name: service-consumer
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
        namespace: d95b5b39-cc31-422b-895d-6b56aed294c8
        group: tydd

2. 创建启动类 ServerConsumerApplication，添加Spring原生注解 @EnableDiscoveryClient ，并注入 RestTemplate 用于调用注册的服务。

@SpringBootApplication
@EnableDiscoveryClient
public class ServerConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServerConsumerApplication.class, args);
    }
    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

3. 创建测试接口，在应用service-consumer中创建测试接口，调用service-provider服务。

@RestController
@RequestMapping(value = "consumer")
public class ConsumerController {

    private static String SERVICE_NAME = "service-provider";

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping(value = "provider/info")
    public String getClientServerResult() {
        return restTemplate.getForObject("http://" + SERVICE_NAME + "/provider/info", String.class);
    }
}

启动service-consumer应用后，在Nacos控制台汇总可以看到新的服务注册成功，并且意味着可以消费其他的服务。调用测试接口，获取 service-provider服务的实例信息。接口返回信息如下所示：

Service Info, service name : service-provider, port : 7001
Service Info, service name : service-provider, port : 7002
Service Info, service name : service-provider, port : 7001
Service Info, service name : service-provider, port : 7002

每一次调用返回的实例信息都不相同，是因为集成的 spring-cloud-riboon 客户端负载均衡的默认模式是轮询模式。

 

自定义元数据

在启动类中添加如下代码，添加我们的自定义元数据，记录实例启动时间。

@Bean
@ConditionalOnMissingBean
public NacosDiscoveryProperties nacosProperties() {
   return new NacosDiscoveryProperties();
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(value = {"spring.cloud.nacos.discovery.watch.enabled"}, matchIfMissing = true)
public NacosWatch nacosWatch(NacosDiscoveryProperties nacosDiscoveryProperties) {
   Map<String, String> metadataMap = nacosDiscoveryProperties.getMetadata();
   if (metadataMap == null) {
      metadataMap = new HashMap<>();
   }
   metadataMap.put("startup.time", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
   metadataMap.put("spring.profiles.active", profile);
   nacosDiscoveryProperties.setMetadata(metadataMap);
   return new NacosWatch(nacosDiscoveryProperties);
}

重启服务后，可以在控制台中看到新添加的自定义元数据。

 

配置中心

使用Nacos的配置中心功能，通过Nacos去进行项目配置。

1. 首先新建配置文件bootstrap.yaml，注意这里不是application.yaml，原因是Nacos同SpringBoot一样，在项目初始化的时要先从配置中心拉取配置文件，Spring的加载是存在优先顺序的，bootstrap优先级高于application。

配置文件内容如下：

server:
 port: 7001 #端口
spring:
 application:
   name: service-provider  #服务名称
 profiles:
   active: dev  #环境
 cloud:
   nacos:
     config:
       file-extension: yaml # 配置后缀
       server-addr: 127.0.0.1:8848  #配置服务地址
       namespace: d95b5b39-cc31-422b-895d-6b56aed294c8  #配置文件命名空间ID
       group: tydd  #配置分组
       prefix: ${spring.application.name}
     discovery:
       server-addr: ${spring.cloud.nacos.config.server-addr}  #注册服务Nacos地址
       namespace: ${spring.cloud.nacos.config.namespace}  #注册服务命名空间ID
       group: tydd  #注册服务分组

说明：在 Nacos Spring Cloud 中，dataId 的完整格式如下：

${prefix}-${spring.profile.active}.${file-extension}

spring.application.name 它是构成Nacos配置管理dataId字段的一部分。

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

file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config。

file-extension 来配置。目前只支持 properties 和 yaml 类型。

 

2. 写好配置文件后，在pom文件中加入Naocs-config的Maven引用。

<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
   <version>${nacos.version}</version>
</dependency>

 

3. 添加Nacos配置文件，在Nacos控制台的创建命名空间dev，创建成功后会生成一个命名空间ID（将这个ID写入到bootstrap.yaml文件中的spring.cloud.nacos.config.namespace项）。然后在“配置列表”菜单中选择对应的命名空间，创建配置文件service-provider.yaml。

 

  图：创建命名空间

 

 图：创建配置文件

 

 4. 创建测试接口，读取Nacos配置。通过Spring的原生注解 @Value 注入配置项的值，并通过 @RefreshScop 实现配置自动更新。

@RefreshScope
@RestController
public class NacosConfigController {

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

    @RequestMapping(value = "config/getValue")
    public String getConfigValue() {
        return this.providerName;
   }
}

调用接口获取到Nacos的配置值，如下图所示。

 

 

 如果在Naocs控制台修改了配置值，会更新本地的配置文件，通过日志可以看出刷新了修改配置项的值。

o.s.c.e.event.RefreshEventListener       : Refresh keys changed: [provider.name]

再次请求接口可以验证配置项的值已经更新。