【Nacos专题】Nacos 快速入门

Posted

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了【Nacos专题】Nacos 快速入门相关的知识，希望对你有一定的参考价值。

参考技术A

Nacos 英文全称 Dynamic Naming and Configuration Service，它是 Spring Cloud Alibaba 的核心组件之一，致力于微服务架构中的服务注册与发现、配置管理。

Nacos 将注册中心和配置中心整合在一起，提供了两个核心功能，即服务注册与发现和动态配置服务。

Nacos 支持基于 DNS 和 基于 RPC 的服务发现，服务提供者向 Nacos 服务端注册服务后，服务消费者可以从 Nacos 服务端获取注册列表。

提供了一个简洁易用的 UI，方便用户管理所有环境的应用配置和服务配置，消除了配置变更时服务需重新部署的过程。还提供了包括 配置版本跟踪 、 金丝雀发布 、 一键回滚配置 以及 客户端配置更新状态跟踪 在内的一系列开箱即用的配置管理特性，大大降低配置变更带来的风险。

Nacos 分为服务端和客户端，服务端用来提供服务发现与注册等功能，客户端就是不同的应用和服务。

在 Nacos 的 Release Notes 可以看到每个版本的相关介绍。当前最新的稳定版本是 1.4.0。

Nacos 服务需要 Java 运行环境，因此，在启动服务之前需要确保你的服务器已经有了 Java 运行环境，并且配置好了 JAVA_HOME 。

参数说明：

-m：指定运行模式，standalone 表示单机模式

在 Nacos 配置文件中配置服务器ip，默认的端口号为8848，默认的用户名和密码均为nacos，访问 http://ip:8848/nacos/index.html 便能够成功登Nacos管理后台。

(1) 引入依赖

在 SpringBoot 项目中引入 Nacos 客户端依赖，pom.xml 添加如下内容：

(2) 修改配置

在 application.properties 配置文件中添加 Nacos 的基本配置 (也可以是 application.yml )

1）application.properties

2）application.yml

(3) @EnableDiscoveryClient 注解

在 SpringBoot 的启动类上添加 @EnableDiscoveryClient 注解来开启服务注册。

Nacos Discovery 默认集成了 Netflix Ribbon，服务消费者可以使用 RestTemplate 或 OpenFeign 进行服务的调用。

(1) Nacos 启动时报如下错误

问题原因：通过yum命令安装的普通的openJDK没有javac等工具，而且安装完以后连环境变量都不需要配置，就能使用 java -version 验证。

解决方案：重新安装devel开发版openJDK，开发版的openJDK有javac工具，然后配置java环境变量即可。

(2) Nacos Provider 启动报错

问题原因：没有配置 Nacos 服务端的地址，因此，当 Nacos Provider 启动的时候，无法与注册中心通信

解决方案：在配置文件中配置 Nacos 服务端地址，如下所示：

Nacos与Spring快速入门

本文主要面向 Spring 的使用者，通过两个示例来介绍如何使用 Nacos 来实现分布式环境下的配置管理和服务发现。

  • 通过 Nacos server 和 Nacos Spring 配置管理模块，实现配置的动态变更；

  • 通过 Nacos server 和 Nacos Spring 服务发现模块，实现服务的注册与发现。

前提条件

您需要先下载 Nacos 并启动 Nacos server。操作步骤参见 。

启动配置管理

启动了 Nacos server 后，您就可以参考以下示例代码，为您的 Spring 应用启动 Nacos 配置管理服务了。完整示例代码请参考：nacos-spring-config-example

  • 添加依赖。

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.  <groupId>com.alibaba.nacos</groupId>
    3. 
  
    
    
  
  3.  <artifactId>nacos-spring-context</artifactId>
    4. 
  
    
    
  
  4.  <version>${latest.version}</version>
    5. 
  
    
    
  
  5. </dependency>
    6.

  • 添加 @EnableNacosConfig 注解启用 Nacos Spring 的配置管理服务。以下示例中，我们使用 @NacosPropertySource 加载了 dataId 为 example 的配置源，并开启自动更新：

 
   
   
 
    
  
    
    
  
  1. @Configuration
    2. 
  
    
    
  
  2. @EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    3. 
  
    
    
  
  3. @NacosPropertySource(dataId = "example", autoRefreshed = true)
    4. 
  
    
    
  
  4. public class NacosConfiguration {
    5. 
  
    
    
  
    6. 
  
    
    
  
  6. }
    7.

  • 通过 Spring 的 @Value 注解设置属性值。
    注意：需要同时有 Setter方法才能在配置变更的时候自动更新。

 
   
   
 
    
  
    
    
  
  1. @Controller
    2. 
  
    
    
  
  2. @RequestMapping("config")
    3. 
  
    
    
  
  3. public class ConfigController {
    4. 
  
    
    
  
    5. 
  
    
    
  
  5.  @Value("${useLocalCache:false}")
    6. 
  
    
    
  
  6.  private boolean useLocalCache;
    7. 
  
    
    
  
    8. 
  
    
    
  
  8.  public void setUseLocalCache(boolean useLocalCache) {
    9. 
  
    
    
  
  9.  this.useLocalCache = useLocalCache;
    10. 
  
    
    
  
  10.  }
    11. 
  
    
    
  
    12. 
  
    
    
  
  12.  @RequestMapping(value = "/get", method = GET)
    13. 
  
    
    
  
  13.  @ResponseBody
    14. 
  
    
    
  
  14.  public boolean get() {
    15. 
  
    
    
  
  15.  return useLocalCache;
    16. 
  
    
    
  
  16.  }
    17. 
  
    
    
  
  17. }
    18.

  • 启动 Tomcat，调用 curl http://localhost:8080/config/get尝试获取配置信息。由于此时还未发布过配置，所以返回内容是 false。

  • 通过调用 Nacos Open API 向 Nacos Server 发布配置：dataId 为example，内容为useLocalCache=true

 
   
   
 
    
  
    
    
  
  1. curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example&group=DEFAULT_GROUP&content=useLocalCache=true"
    2.

  • 再次访问 http://localhost:8080/config/get，此时返回内容为true，说明程序中的useLocalCache值已经被动态更新了。

启动服务发现

本节演示如何在您的 Spring 项目中启动 Nacos 的服务发现功能。完整示例代码请参考：nacos-spring-discovery-example

  • 添加依赖。

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.  <groupId>com.alibaba.nacos</groupId>
    3. 
  
    
    
  
  3.  <artifactId>nacos-spring-context</artifactId>
    4. 
  
    
    
  
  4.  <version>${latest.version}</version>
    5. 
  
    
    
  
  5. </dependency>
    6.

  • 通过添加 @EnableNacosDiscovery 注解开启 Nacos Spring 的服务发现功能：

 
   
   
 
    
  
    
    
  
  1. @Configuration
    2. 
  
    
    
  
  2. @EnableNacosDiscovery(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    3. 
  
    
    
  
  3. public class NacosConfiguration {
    4. 
  
    
    
  
    5. 
  
    
    
  
  5. }
    6.

  • 使用 @NacosInjected 注入 Nacos 的 NamingService 实例：

 
   
   
 
    
  
    
    
  
  1. @Controller
    2. 
  
    
    
  
  2. @RequestMapping("discovery")
    3. 
  
    
    
  
  3. public class DiscoveryController {
    4. 
  
    
    
  
    5. 
  
    
    
  
  5.  @NacosInjected
    6. 
  
    
    
  
  6.  private NamingService namingService;
    7. 
  
    
    
  
    8. 
  
    
    
  
  8.  @RequestMapping(value = "/get", method = GET)
    9. 
  
    
    
  
  9.  @ResponseBody
    10. 
  
    
    
  
  10.  public List<Instance> get(@RequestParam String serviceName) throws NacosException {
    11. 
  
    
    
  
  11.  return namingService.getAllInstances(serviceName);
    12. 
  
    
    
  
  12.  }
    13. 
  
    
    
  
  13. }
    14.

  • 启动 Tomcat，调用 curl http://localhost:8080/discovery/get?serviceName=example，此时返回为空 JSON 数组[]。

  • 通过调用 Nacos Open API 向 Nacos server 注册一个名称为 example 服务。

 
   
   
 
    
  
    
    
  
  1. curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080'
    2.

  • 再次访问 curl http://localhost:8080/discovery/get?serviceName=example，此时返回内容为：

 复制代码
 
   
   
 
    
  
    
    
  
  1. [
    2. 
  
    
    
  
  2.  {
    3. 
  
    
    
  
  3.  "instanceId": "127.0.0.1#8080#DEFAULT#example",
    4. 
  
    
    
  
  4.  "ip": "127.0.0.1",
    5. 
  
    
    
  
  5.  "port": 8080,
    6. 
  
    
    
  
  6.  "weight": 1.0,
    7. 
  
    
    
  
  7.  "healthy": true,
    8. 
  
    
    
  
  8.  "cluster": {
    9. 
  
    
    
  
  9.  "serviceName": null,
    10. 
  
    
    
  
  10.  "name": "",
    11. 
  
    
    
  
  11.  "healthChecker": {
    12. 
  
    
    
  
  12.  "type": "TCP"
    13. 
  
    
    
  
  13.  },
    14. 
  
    
    
  
  14.  "defaultPort": 80,
    15. 
  
    
    
  
  15.  "defaultCheckPort": 80,
    16. 
  
    
    
  
  16.  "useIPPort4Check": true,
    17. 
  
    
    
  
  17.  "metadata": {}
    18. 
  
    
    
  
  18.  },
    19. 
  
    
    
  
  19.  "service": null,
    20. 
  
    
    
  
  20.  "metadata": {}
    21. 
  
    
    
  
  21.  }
    22. 
  
    
    
  
  22. ]
    23.


以上是关于【Nacos专题】Nacos 快速入门的主要内容，如果未能解决你的问题，请参考以下文章

【Nacos专题】Nacos Config

SpringCloud Nacos 注册中心 -- Nacos快速入门Nacos服务分级存储模型（集群）集群负载均衡策略 NacosRule

Nacos与Spring快速入门

测试中间件 - Nacos 快速入门

阿里开源服务发现组件 Nacos快速入门

快速入门 Nacos 作为配置中心操作