首页手记 Nacos初识项目实战：新手入门教程

Nacos初识项目实战：新手入门教程

标签：

Java Spring Cloud 中间件

概述

本文将带你深入了解Nacos初识项目实战，从Nacos的基础概念和功能开始，逐步介绍如何安装和配置Nacos，并通过实际项目演示Nacos在配置管理和服务治理中的应用。

Nacos简介与安装

Nacos是什么

Nacos是阿里巴巴开源的一款动态服务发现、配置管理以及服务管理的工具。它提供了动态配置管理、服务发现和健康检测等功能。Nacos主要用于微服务架构中，帮助开发者更好地管理配置信息、服务发现和负载均衡等任务。

Nacos的功能介绍

Nacos主要提供了以下功能：

动态配置管理：Nacos可以集中管理应用程序的配置文件，支持动态更新配置信息，并实时推送到各个客户端。
服务发现与负载均衡：Nacos支持服务的自动注册与发现，同时提供简单的负载均衡策略。
健康检查与服务剔除：Nacos可以对注册的服务进行健康检查，并在服务出现问题时将其从服务列表中剔除。
元数据管理：除了配置信息和服务信息，Nacos还可以管理各种元数据。
权限管理：Nacos提供针对不同用户和不同资源的权限管理功能。
多数据中心支持：Nacos支持分布式部署，可以在多个数据中心之间同步配置和状态信息。

环境准备与安装步骤

环境准备

安装Java：确保系统中安装了Java环境，最低要求为Java 8。
下载Nacos：访问Nacos官方网站或GitHub仓库下载最新版本的Nacos。
解压下载的压缩包：将下载的压缩包解压到指定的目录下。

安装步骤

进入解压后的目录，找到startup.cmd或startup.sh脚本。
根据你的操作系统选择相应的脚本进行启动：
- Windows系统下运行startup.cmd脚本。
- Linux、Mac系统下运行startup.sh脚本。
启动Nacos后，默认会在http://localhost:8848/nacos提供Web UI，并且可以通过http://localhost:8848/nacos/naming和http://localhost:8848/nacos/console来访问相关的管理页面。

示例代码

启动Nacos服务器的命令如下：

# Linux/Mac OS
cd nacos/bin
./startup.sh -m standalone

# Windows OS
cd nacos\bin
startup.cmd -m standalone

Nacos配置中心基础操作

配置文件管理

Nacos允许用户将配置文件托管在Nacos中，通过Nacos的Web UI界面或者API进行配置文件的查看、修改等操作。配置文件的格式可以是任何类型，例如JSON、YAML等。

示例代码

创建一个名为application.properties的配置文件并上传到Nacos。假设配置文件内容如下：

# application.properties
server.port=8080
spring.application.name=MyApp

上传文件到Nacos的配置中心后，可以通过Nacos的Web UI界面查看和修改这些配置。

配置文件的发布与订阅

用户可以订阅配置文件的变更，当配置文件发生变化时，Nacos会自动将最新的配置推送给所有订阅者。这使得配置文件的更新可以实时生效。

示例代码

在Java项目中，可以通过Spring Boot集成Nacos来实现配置文件的发布与订阅。首先在application.properties文件中添加Nacos的配置信息：

# application.properties
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=public
spring.cloud.nacos.config.group=DEFAULT_GROUP

然后在代码中订阅配置：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/config")
    @RefreshScope
    public String getConfig() {
        return "The server port is " + serverPort;
    }
}

动态刷新配置机制

通过Spring Cloud Nacos配置中心，可以实现配置文件的动态刷新。当配置文件发生变化时，Nacos会自动将最新的配置推送给所有的订阅者。这使得在不重启应用的情况下，可以动态更新配置。

示例代码

假设修改了Nacos中的配置文件application.properties，添加了新的属性：

# application.properties
server.port=8080
spring.cloud.nacos.config.namespace=public
spring.cloud.nacos.config.group=DEFAULT_GROUP
new.property=hello

在Java代码中，可以通过@RefreshScope注解的方法来查看并使用这个新的属性：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigController {

    @Value("${server.port}")
    private String serverPort;

    @Value("${new.property}")
    private String newProperty;

    @GetMapping("/config")
    @RefreshScope
    public String getConfig() {
        return "The server port is " + serverPort + " and new property is " + newProperty;
    }
}

Nacos服务发现与注册

服务注册原理

Nacos中的服务注册是指将应用注册到Nacos服务器上，以便其他应用可以通过这些注册信息找到并连接到服务。服务注册通常会包含服务的名称、服务的IP地址、端口号等信息。

示例代码

在Spring Boot项目中，可以通过NacosDiscoveryAutoConfiguration自动配置类来注册服务。首先在application.properties文件中配置Nacos的服务地址：

# application.properties
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
spring.application.name=MyService

然后在代码中使用@EnableDiscoveryClient注解来启用服务发现功能：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceApplication {

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

服务发现的实现

服务发现是指客户端通过Nacos服务器获取服务实例的列表，并从中选择一个服务实例进行连接。客户端可以通过服务名称从Nacos获取服务实例列表，并根据负载均衡策略选择一个实例进行连接。

示例代码

在客户端项目中，通过@EnableDiscoveryClient注解启用服务发现，并通过DiscoveryClient来获取服务实例列表：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class ConsumerController {

    @Autowired
    private DiscoveryClient discoveryClient;

    @GetMapping("/services")
    public List<ServiceInstance> getServices() {
        return discoveryClient.getInstances("MyService");
    }
}

健康检查与服务剔除

Nacos会定期检查注册的服务实例的健康状况。如果服务实例出现异常，Nacos会将其从服务列表中剔除，确保客户端不会连接到有问题的服务实例。

示例代码

Nacos默认使用HTTP健康检查，可以通过配置文件来设置健康检查的URL和检查周期。例如，在Nacos的Web UI中设置健康检查URL为/health，检查周期为5秒。
在服务端项目中，可以通过Spring Boot的HealthIndicator接口来实现健康检查：

import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class MyHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        // 实现健康检查逻辑
        if (/* 服务正常 */) {
            return Health.up().build();
        } else {
            return Health.down().build();
        }
    }
}

Nacos实战项目搭建

创建一个简单的Spring Boot项目

首先创建一个新的Spring Boot项目，可以使用Spring Initializr或者IDE中的插件来快速搭建项目。添加必要的依赖，如spring-boot-starter-web和spring-cloud-starter-nacos-config。

示例代码

创建一个新的Spring Boot项目，并添加以下依赖到pom.xml文件中：

<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-config</artifactId>
    </dependency>
</dependencies>

集成Nacos配置中心

在Spring Boot项目中集成Nacos配置中心，需要在application.properties文件中配置Nacos的地址、命名空间和组名，然后在代码中使用@Value注解来注入配置。

示例代码

在application.properties文件中添加Nacos的配置信息：

# application.properties
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=public
spring.cloud.nacos.config.group=DEFAULT_GROUP

在代码中注入配置：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/config")
    public String getConfig() {
        return "The server port is " + serverPort;
    }
}

Nacos服务注册与发现实战

在服务端项目中，使用@EnableDiscoveryClient注解来启用服务注册与发现功能，并在客户端项目中通过DiscoveryClient来获取服务实例列表。

示例代码

服务端项目中启用服务注册与发现：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceApplication {

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

客户端项目中通过DiscoveryClient获取服务实例列表：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class ConsumerController {

    @Autowired
    private DiscoveryClient discoveryClient;

    @GetMapping("/services")
    public List<ServiceInstance> getServices() {
        return discoveryClient.getInstances("MyService");
    }
}

Nacos项目部署与运维

Nacos集群部署

Nacos支持集群部署，可以提供高可用的服务。集群部署需要至少3个节点，每个节点之间通过Raft协议进行数据同步和选举。

示例代码

集群部署的配置示例如下：

server:
  mode: cluster
# 多个节点的配置，每个节点用逗号分隔
cluster:
  nodes:
    - 127.0.0.1:8848
    - 127.0.0.1:8849
    - 127.0.0.1:8850

Nacos常用运维命令

Nacos提供了多种命令行工具来帮助运维人员进行操作，例如nacos-mq-pub用于发布消息到消息队列，nacos-mq-sub用于订阅消息队列中的消息。

示例代码

运行Nacos的命令行工具：

# 发布消息到消息队列
./bin/nacos-mq-pub -h 127.0.0.1:8848 -t test -m "Hello, Nacos!"

# 订阅消息队列中的消息
./bin/nacos-mq-sub -h 127.0.0.1:8848 -t test

日志查看与问题排查

Nacos的日志文件通常位于logs目录下，可以通过查看日志来排查问题。Nacos的日志包括系统日志和操作日志，可以帮助用户了解系统的运行情况和操作记录。

示例代码

查看Nacos的日志文件：

# 进入日志目录
cd nacos/logs

# 查看日志文件
tail -f nacos.log

Nacos应用场景与案例分享

微服务中的配置管理

在微服务架构中，配置管理是一个重要的环节。Nacos提供了集中化的配置管理功能，能够满足微服务中对配置的动态更新和实时推送的需求。

示例代码

在微服务项目中，通过Nacos管理配置文件：

# application.properties
server.port=8080
spring.application.name=MyMicroservice

在服务代码中注入并使用配置：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MicroserviceController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/config")
    public String getConfig() {
        return "The server port is " + serverPort;
    }
}

服务治理的实现

Nacos不仅提供了配置管理的功能，还提供了服务治理的功能。通过服务注册与发现、健康检查等机制，Nacos可以帮助微服务更好地治理服务之间的关系。

示例代码

服务治理示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class ServiceController {

    @Autowired
    private DiscoveryClient discoveryClient;

    @GetMapping("/services")
    public List<ServiceInstance> getServices() {
        return discoveryClient.getInstances("MyService");
    }
}

实际项目中Nacos的应用

在实际项目中，Nacos被广泛应用于微服务架构中，帮助企业更好地管理服务配置、服务发现和负载均衡等问题，提高系统的可维护性和可扩展性。

示例代码

一个简单的实际项目应用示例：

# application.properties
server.port=8080
spring.application.name=MyActualProject

在服务代码中使用Nacos：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ActualProjectController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/config")
    @RefreshScope
    public String getConfig() {
        return "The server port is " + serverPort;
    }
}

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

HUH函数

手记
篇

粉丝

67

获赞与收藏

315

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19367 315

Java 并发原理入门教程

26个小节 39106 568

Java 入门教程

50个小节 342495 3164

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

Nacos初识项目实战：新手入门教程

环境准备

安装步骤

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

示例代码

阅读免费教程