Nacos快速入门资料：新手指南

概述

Nacos是一款由阿里巴巴开源的动态服务发现、配置管理和服务管理平台，适用于构建云原生应用。本文将详细介绍Nacos的快速入门资料，包括环境搭建、基本功能使用以及与其他框架的集成方法。

Nacos简介 Nacos是什么

Nacos（Dynamic Naming and Configuration Service）是阿里巴巴开源的一个易于构建云原生应用的动态服务发现、配置管理和服务管理平台。Nacos设计的初衷是为了简化配置管理、服务发现和动态服务管理，并支持多种编程语言。

Nacos的作用和应用场景

Nacos 在微服务架构中扮演着重要的角色。以下是Nacos的一些主要应用场景：

• 配置管理：可以通过Nacos集中管理配置文件，支持动态更新配置，简化应用的配置管理。
• 服务发现与负载均衡：Nacos提供服务的注册与发现功能，支持基于软负载均衡。
• 服务管理：提供健康检查服务，确保服务的可用性。

Nacos环境搭建 系统环境要求

• 操作系统：支持Windows、Linux、macOS等操作系统。
• Java环境：建议使用JDK 1.8及以上版本。
• 内存：建议至少8GB内存以保证应用的稳定运行。
• 磁盘空间：建议至少5GB以上可用磁盘空间。
• 端口：Nacos服务默认端口为8848，该端口需要保持可用。

下载安装Nacos

下载

首先，访问Nacos官网下载页面下载最新版本的Nacos，这里是下载地址：https://nacos.io/zh-cn/docs/quick-start.html

解压

下载完成后，解压下载的文件包。

tar -xzf nacos-server-*.tar.gz

启动Nacos

进入解压后的nacos目录，执行启动命令。

cd nacos
sh bin/startup.sh -m standalone

• -m standalone 表示以单机模式启动Nacos，适合开发和测试环境。
• -m cluster 表示集群模式，适合生产环境。

访问Nacos控制台

启动完成后，可以访问http://localhost:8848/nacos来打开Nacos的控制台。默认的用户名和密码都是nacos。

Nacos基本功能使用 配置管理

Nacos为应用提供了集中式和动态化的配置管理功能。通过Nacos，可以将配置信息从应用代码和配置文件中分离出来，以降低环境依赖，提高配置的灵活性和可维护性。

创建配置

进入Nacos控制台后，点击“配置管理”来创建新的配置。配置创建后，可以通过Nacos提供的接口来获取配置信息。

更新配置

对配置信息进行修改后，Nacos支持实时更新配置，可以提供配置的实时生效功能。

服务发现与服务管理

Nacos提供了服务发现与服务管理功能，可以帮助实现服务注册与发现，支持软负载均衡，并且提供了健康检查功能以保证服务的高可用性。

服务注册

服务注册是服务发现的基础。当服务启动时，它会向Nacos注册自己的元数据（如IP地址、端口号、健康检查元数据等）。

服务发现

服务发现则允许服务通过Nacos查询其他服务的可用实例。服务发现支持基于软负载均衡的请求分发。

服务管理

Nacos支持服务的健康检查与故障转移，确保服务的高可用性。

Nacos配置中心功能详解 配置文件上传与获取

Nacos支持多种编程语言，这里以Java为例。

创建配置

首先，在Nacos控制台上创建一个配置文件，如application.properties。

app.name=HelloWorld
app.version=1.0.0

上传配置

上传配置文件到Nacos，可以通过Nacos控制台手动上传，也可以使用Nacos的API进行上传。

获取配置

示例代码展示如何在Java应用中从Nacos获取配置。

import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

import javax.annotation.PostConstruct;
import java.util.Properties;

@Configuration
public class NacosConfigLoader {

    @Value("${spring.cloud.nacos.config.server-addr}")
    private String serverAddr;

    @PostConstruct
    public void loadConfig() throws NacosException {
        Properties properties = new Properties();
        properties.put("serverAddr", serverAddr);
        ConfigService nacosConfigService = new ConfigService(properties);
        String dataId = "application.properties";
        String group = "DEFAULT_GROUP";
        String content = nacosConfigService.getConfig(dataId, group, 5000);
        System.out.println("Config loaded from Nacos: " + content);

        // 添加监听器，实时监听Nacos配置的变更
        nacosConfigService.addListener(dataId, group, new Listener() {
            @Override
            public void receiveConfigInfo(String configInfo) {
                System.out.println("Config updated in Nacos: " + configInfo);
            }

            @Override
            public void receiveConfigRemoved(String configInfo) {
                System.out.println("Config removed in Nacos");
            }
        });
    }
}

实时配置更新

Nacos支持配置的实时更新，服务端一旦更新配置，连接到Nacos的客户端应用可以实时获取到最新的配置信息。

示例代码展示如何监听配置的变化。

nacosConfigService.addListener(dataId, group, new Listener() {
    @Override
    public void receiveConfigInfo(String configInfo) {
        System.out.println("Config updated in Nacos: " + configInfo);
    }

    @Override
    public void receiveConfigRemoved(String configInfo) {
        System.out.println("Config removed in Nacos");
    }
});

配置变更步骤和高级用法

• 在控制台上，可以通过编辑配置文件来手动更新配置。
• 在代码中，可以通过监听器实时监控配置的变化，并在配置更新时执行相应的操作。
• 高级用法包括支持多种数据类型（如JSON）的配置文件，以及根据不同的环境或标签进行配置分区。

Nacos服务发现机制 服务注册与发现流程

服务注册与发现是指服务启动时向Nacos注册自己的信息，其他服务通过Nacos查询可用的服务实例的过程。

服务注册

服务注册的示例代码如下，这里使用Java和Spring Boot进行演示。

import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.registry.RegistryService;

import java.util.Properties;

public class ServiceRegistryExample {
    public static void registerService() throws NacosException {
        Properties properties = new Properties();
        properties.put("serverAddr", "localhost:8848");
        RegistryService registryService = NacosFactory.createRegistryService(properties);
        String serviceName = "example-service";
        String ip = "127.0.0.1";
        int port = 8080;
        registryService.registerInstance(serviceName, ip, port);
        System.out.println("Service registered with Nacos: " + serviceName);
    }
}

服务发现

服务发现的示例代码如下。

import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.registry.RegistryService;
import com.alibaba.nacos.api.registry.listener.Event;
import com.alibaba.nacos.api.registry.listener.IServiceListener;
import com.alibaba.nacos.api.registry.listener.NacosServiceListenerAdapter;

import java.util.Properties;
import java.util.concurrent.CountDownLatch;

public class ServiceDiscoveryExample {
    public static void discoverService() throws InterruptedException, NacosException {
        Properties properties = new Properties();
        properties.put("serverAddr", "localhost:8848");
        RegistryService registryService = NacosFactory.createRegistryService(properties);
        String serviceName = "example-service";

        CountDownLatch latch = new CountDownLatch(1);
        IServiceListener listener = new NacosServiceListenerAdapter(serviceName) {
            @Override
            public void onSuccess(Event event) {
                System.out.println("Service " + serviceName + " discovered: " + event.getData());
                latch.countDown();
            }
        };
        registryService.subscribe(serviceName, listener);

        latch.await();
        System.out.println("Service discovery completed");
    }
}

服务健康检查

Nacos提供了服务健康检查功能，通过心跳机制来判断服务实例的健康状态，并支持故障转移。

使用心跳机制

服务实例向Nacos发送心跳，Nacos根据心跳的情况来判断服务实例是否存活。

import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.registry.RegistryService;

import java.util.Properties;

public class ServiceHeartbeatExample {
    public static void sendHeartbeat() throws NacosException {
        Properties properties = new Properties();
        properties.put("serverAddr", "localhost:8848");
        RegistryService registryService = NacosFactory.createRegistryService(properties);
        String serviceName = "example-service";
        String ip = "127.0.0.1";
        int port = 8080;
        registryService.sendHeartbeat(serviceName, ip);
        System.out.println("Heartbeat sent to Nacos");
    }
}

故障转移示例

当Nacos检测到服务实例出现故障时，会自动将其从可用实例列表中移除。

import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.registry.RegistryService;

import java.util.Properties;

public class ServiceFailoverExample {
    public static void failoverService() throws NacosException {
        Properties properties = new Properties();
        properties.put("serverAddr", "localhost:8848");
        RegistryService registryService = NacosFactory.createRegistryService(properties);
        String serviceName = "example-service";
        String ip = "127.0.0.1";
        int port = 8080;

        // 模拟服务实例故障
        // 在实际应用中，Nacos会自动处理故障实例的移除和替换
        System.out.println("Simulating service failure for " + serviceName);
        registryService.unregisterInstance(serviceName, ip);
        System.out.println("Service " + serviceName + " is no longer available");
    }
}

Nacos与其他框架的集成 与Spring Boot的集成

Nacos很好地集成了Spring Boot，提供了spring-cloud-starter-alibaba-nacos-config和spring-cloud-starter-alibaba-nacos-discovery两个starter，使得Spring Boot应用能够方便地使用Nacos的各项功能。

配置文件

需要将spring-cloud-starter-alibaba-nacos-config和spring-cloud-starter-alibaba-nacos-discovery添加到项目中。

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

示例代码

以下是一个简单的Spring Boot应用集成Nacos的示例代码。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.context.config.annotation.RefreshScope;

@SpringBootApplication
@EnableDiscoveryClient
@RefreshScope
public class NacosSpringBootApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosSpringBootApplication.class, args);
    }
}

与Dubbo的集成

Nacos与Dubbo的集成提供了灵活的服务注册与发现能力，使Dubbo应用能够更好地适应微服务架构。

配置文件

需要在Dubbo应用中引入nacos-discovery依赖。

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>dubbo-dependencies-bom</artifactId>
    <version>2.7.8</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>2.7.8</version>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>dubbo-spring-boot-starter-nacos-discovery</artifactId>
    <version>2.7.8</version>
</dependency>

示例代码

以下是一个简单的Dubbo应用集成Nacos的示例代码。

import com.alibaba.dubbo.config.ApplicationConfig;
import com.alibaba.dubbo.config.RegistryConfig;
import com.alibaba.dubbo.config.spring.ServiceConfig;

public class NacosDubboApplication {
    public static void main(String[] args) {
        ApplicationConfig applicationConfig = new ApplicationConfig();
        applicationConfig.setName("example-dubbo-service");

        RegistryConfig registryConfig = new RegistryConfig();
        registryConfig.setAddress("nacos://localhost:8848");
        registryConfig.setProtocol("dubbo");

        ServiceConfig serviceConfig = new ServiceConfig();
        serviceConfig.setApplication(applicationConfig);
        serviceConfig.setRegistry(registryConfig);

        // 注册服务
        serviceConfig.export();

        System.out.println("Dubbo service registered with Nacos");
    }
}