Nacos使用图文教程
快速掌握Nacos!
目录
1、是什么?
Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理 平台。他是使用 java 编写。需要依赖 java 环境
2、干什么?
一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。作为我们的注册中心和配置中心。
3、怎么用
3.1 下载nacos-server
下载地址:Releases · alibaba/nacos · GitHub
3.2 启动nacos-server
双击 bin 中的 startup.cmd 文件
访问 http://localhost:8848/nacos/
使用默认的账号密码 nacos/nacos 进行登录
3.3 使用Nacos开发一个小Demo
demo总体架构
1、在父工程加入依赖
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.11</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.byd</groupId>
<artifactId>nacos-demo</artifactId>
<packaging>pom</packaging>
<version>0.0.1-SNAPSHOT</version>
<modules>
<module>provider</module>
<module>consumer</module>
</modules>
<name>nacos-demo</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>2021.0.4</spring-cloud.version>
<spring-cloud-alibaba.version>2021.0.4.0</spring-cloud-alibaba.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${spring-cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
<plugins>
<!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
<!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.0.0</version>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
3.3.1 新建provider模块
1、在provider模块加入依赖
<?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">
<parent>
<artifactId>nacos-demo</artifactId>
<groupId>com.byd</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.byd</groupId>
<artifactId>provider</artifactId>
<version>1.0-SNAPSHOT</version>
<name>provider</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring-boot.version>2.3.7.RELEASE</spring-boot.version>
</properties>
<dependencies>
<!-- 引入阿里的nacos作为服务注册中心 -->
<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>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.5.3</version>
</dependency>
</dependencies>
2、在application.properties文件中配置Nacos Server 地址
spring.application.name=provider
spring.cloud.nacos.config.serveraddr=localhost:8848
server.port= 8000
3、使用@EnableDiscoveryClient 开启服务注册发现功能
@SpringBootApplication
@EnableDiscoveryClient
public class ShoppingCouponApplication {
public static void main(String[] args) {
SpringApplication.run(ShoppingCouponApplication.class, args);
}
}
4、创建 ProviderController,并添加如下代码
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ProviderController {
private String name;
@GetMapping("send")
public String send(){
name="远程调用provider";
return name;
}
}
5、启动应用,观察 nacos 服务列表是否已经注册上服务
3.3.1 新建consumer模块
1、导入依赖
<?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">
<parent>
<artifactId>nacos-demo</artifactId>
<groupId>com.byd</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.byd</groupId>
<artifactId>consumer</artifactId>
<version>1.0-SNAPSHOT</version>
<name>consumer</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.byd</groupId>
<artifactId>provider</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>2.2.3.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
</dependencies>
编写Consumer 服务配置上去,测试使用 feign 远程调用
2、application.yml 配置
spring.application.name=consumer
spring.cloud.nacos.config.serveraddr=localhost:8848
server.port= 8001
启动项目,可以看到Provider,Consumer 两个服务注册到 Nacos 中了
3、整合Feign实现远程调用
(1) 开启@EnableFeignClients 功能
(2) 创建roviderFeign接口,进行远程调用(方法名必须和provider模块中方法名相同)
package com.test.consumer.feign;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
@FeignClient("provider")
public interface ProviderFeign {
@RequestMapping("send")
String send();
}
(3) 创建 ConsumerController 类,编写如下代码
import com.test.consumer.feign.ProviderFeign;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ConsumerController {
@Autowired
private ProviderFeign providerFeign;
@GetMapping("consumer")
public String send(){
String send = providerFeign.send();
return "Consumer ===== >" + send;
}
}
(4) 进行测试,运行结果如下
3.4 Nacos 作为配置中心
1、引入依赖
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
2、在bootstrap.properties 配 置文件中配置 Nacos Config 元数据
spring:
application:
name: problemCollection
profiles:
active: ${SPRING_PROFILES_ACTIVE:dev}
cloud:
nacos:
username: ${NACOS_USERNAME:nacos}
password: ${NACOS_PASSWORD:nacos}
config:
server-addr: ${NACOS_ADDR:127.0.0.1:8848}
namespace: ${NACOS_NAMESPACE:pro_col}
file-extension: yml
shared-configs:
- data-id: common.yml
group: DEFAULT_GROUP
refresh: true
group: DEFAULT_GROUP
enable-remote-sync-config: true
discovery:
server-addr: ${NACOS_ADDR:127.0.0.1:8848}
namespace: ${NACOS_NAMESPACE:pro_col}
3、在 nacos 中添加配置
在 nacos 中创建一个 应用名.properties配置文件并编写配置
Nacos Config 数据结构 Nacos Config 主要通过 dataId 和 group 来唯一确定一条配置。 Nacos Client 从 Nacos Server 端获取数据时,调用的是此接口 ConfigSerrvice.getConfig(String dataId, String group, long timeoutMs).
Spring Cloud 应用获取数据
dataID:
在 Nacos Config Starter 中,dataId 的拼接格式如下
${prefix} - ${spring.profiles.active} . ${file-extension} prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。
spring.profiles.active 即为当前环境对应的 profile 注意,当 activeprofile 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 p r e f i x . {prefix}. prefix.{file-extension}
file-extension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。 目前只支持 properties 类型。
Group:
Group 默认为 DEFAULT_GROUP,可以通过 spring.cloud.nacos.config.group 配置
spring.application.name=shopping-coupon
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=97306cd5-bce0-4d84-8a1c-1309b5495fc4
#spring.cloud.nacos.config.group=dev
spring.cloud.nacos.config.ext-config[0].data-id=datasource.yml
spring.cloud.nacos.config.ext-config[0].group=dev
spring.cloud.nacos.config.ext-config[0].refresh=true
spring.cloud.nacos.config.ext-config[1].data-id=mybatis.yml
spring.cloud.nacos.config.ext-config[1].group=dev
spring.cloud.nacos.config.ext-config[1].refresh=true
spring.cloud.nacos.config.ext-config[2].data-id=other.yml
spring.cloud.nacos.config.ext-config[2].group=dev
spring.cloud.nacos.config.ext-config[2].refresh=true
4、在应用中使用@Value 和@RefreshScope
完成上述两步后,应用会从 Nacos Config 中获取相应的配置,并添加在 Spring Environment 的 PropertySources 中 。 这 里 我 们 使 用 @Value 注 解 来 将 对 应 的 配 置 注 入 到 SampleController 的 userName 和 age 字段,并添加 @RefreshScope 打开动态刷新功能
@RefreshScope
@RestController
@RequestMapping("coupon/coupon")
public class CouponController {
@Autowired
private CouponService couponService;
@Value("${coupon.user.name}")
private String name;
@Value("${coupon.user.age}")
private Integer age;
5、核心概念
命名空间: 用于进行租户粒度的配置隔离。不同的命名空间下,可以存在相同的 Group 或 Data ID 的 配置。Namespace 的常用场景之一是不同环境的配置的区分隔离,例如开发测试环境和生 产环境的资源(如配置、服务)隔离等。
**配置集:**一组相关或者不相关的配置项的集合称为配置集。在系统中,一个配置文件通常就是一个配 置集,包含了系统各个方面的配置。例如,一个配置集可能包含了数据源、线程池、日志级 别等配置项。
配置集 ID: Nacos 中的某个配置集的 ID。配置集 ID 是组织划分配置的维度之一。Data ID 通常用于组 织划分系统的配置集。一个系统或者应用可以包含多个配置集,每个配置集都可以被一个有 意义的名称标识。Data ID 通常采用类 Java 包(如 com.taobao.tc.refund.log.level)的命名 规则保证全局唯一性。此命名规则非强制。
配置分组: Nacos 中的一组配置集,是组织配置的维度之一。通过一个有意义的字符串(如 Buy 或 Trade )对配置集进行分组,从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个 配置时,如果未填写配置分组的名称,则配置分组的名称默认采用 DEFAULT_GROUP 。配置 分组的常见场景:不同的应用或组件使用了相同的配置类型,如 database_url 配置和 MQ_topic 配置
自动注入: NacosConfigStarter 实现了 org.springframework.cloud.bootstrap.config.PropertySourceLocator 接口,并将优先级设置成了最高。 在 Spring Cloud 应用启动阶段,会主动从 Nacos Server 端获取对应的数据,并将获取到的 数据转换成 PropertySource 且注入到 Environment 的 PropertySources 属性中,所以使用 @Value 注解也能直接获取 Nacos Server
动态刷新: Nacos Config Starter 默认为所有获取数据成功的 Nacos 的配置项添加了监听功能,在监听 到服务端配置发生变化时会实时触发 org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法 。 如果需要对 Bean 进行动态刷新,请参照 Spring 和 Spring Cloud 规范。推荐给类添加 @RefreshScope 或 @ConfigurationProperties 注
Nacos参数配置
nacos配置参数说明
配置中心配置
配置类:NacosConfigProperties
前缀:spring.cloud.nacos.config
参数 描述
参数 | 描述 |
---|---|
server-addr | nacos服务地址,优先级比endpoint高 |
server-addr nacos服务地址,优先级比endpoint高。 | |
username | 用户名 |
password | 密码 |
encode | 配置内容编码方式 |
group | nacos 配置组,组是配置数据元信息。默认值:DEFAULT_GROUP |
prefix | nacos 配置 dataId 前缀。 |
file-extension | nacos config dataId 的后缀,也是配置内容的文件扩展名。 |
timeout | 配置超时时间。默认值:3000 |
max-retry | 长轮询的最大重试次数。 |
config-long-poll-timeout | 长轮询的超时时间,单位为毫秒 |
config-retry-time | 长轮询任务重试时间,单位为毫秒 |
enable-remote-sync-config | 启用远程同步配置,监听器首次添加时拉取远端配置,默认值:false |
endpoint | nacos服务的域名 |
namespace | 命名空间ID。Nacos通过不同的命名空间来区分不同的环境,进行数据隔离 |
access-key | access key |
secret-key | secret key |
context-path | 服务器的上下文路径。 |
cluster-name | 集群名称 |
name | dataId 名称 |
shared-configs | 一组共享配置,例如:spring.cloud.nacos.config.shared-configs[0]=xxx . |
extension-configs | 一组扩展配置。例如:spring.cloud.nacos.config.extension-configs[0]=xxx . |
refresh-enabled | 刷新配置的主开关,默认:true(打开) |
注册中心配置
配置类:NacosDiscoveryProperties
前缀:spring.cloud.nacos.discovery
参数 | 描述 |
---|---|
server-addr | nacos服务地址,优先级比endpoint高。注:多个IP可以通过“,”号隔离,例如192.168.80.1:8848,192.168.80.1:8848 填写域名时前缀不要加上http:// |
username | 用户名 |
password | 密码 |
endpoint | nacos服务的域名 |
namespace | 命名空间ID。Nacos通过不同的命名空间来区分不同的环境,进行数据隔离,服务消费时只能消费到对应命名空间下的服务。 |
watch-delay | 默认为30s。默认为true,客户端在启动时会创建一个线程池,该线程定期去查询服务端的信息列表,该请求不会立刻返回,默认等待30s,若在30s内,服务端信息列表发生变化,则该请求立刻返回,通知客户端拉取服务端的服务信息列表,若30s内,没有变化,则30s时该请求返回响应,客户端服务列表不变,再次发生该请求。注:推荐该值为30s即可,无需修改 |
log-name | nacos客户端会在启动时打印一部分发送注册请求信息和异常日志,可以通过日志查看注册的nacos集群地址、服务名、nameSpace、IP、元数据等内容,文件名默认为naming.log。注:推荐将该日志的位置设置为和其他日志在一个文件夹下 |
service | 项目向注册中心注册服务时的服务名。默认为spring.application.name 变量。注:该服务名必须使用小写,因为nacos服务名区分大小写,如果服务名不完全匹配,那么无法调用服务 |
weight | nacos支持服务端基于权重的负载均衡,该值默认为1。注:建议该值保持默认即可,因为代码可能会部署到不同的服务器上,无法确保某台服务器的配置一定较好,如果有需要修改该值的需求,可以上控制台修改,这样可以保证对应IP服务器的权重值较高 |
cluster-name | 集群名称,默认值:DEFAULT |
group | 分组名称,默认值:DEFAULT_GROUP |
naming-load-cache-at-start | 客户端在启动时是否读取本地配置项(一个文件)来获取服务列表。默认为false。注:推荐该值为false,若改成true。则客户端会在本地的一个文件中保存服务信息,当下次宕机启动时,会优先读取本地的配置对外提供服务。 |
metadata | 给服务添加一些标签,例如属于什么业务线,该元数据会持久化存储在服务端,但是客户端消费时不会获取到此值,默认为空。注:推荐为空,我们可以通过已经注册的服务名来找到具体的业务线,无需添加metadata |
register-enabled | 该项目是否向注册中心注册服务,默认为true。注:如果服务从注册中心只消费服务,没有对外提供服务,那么该值可设置为false,可减少客户端线程池的创建,无需向服务端发送心跳请求,提高性能。 |
ip | 服务实例要注册的ip地址,不用设置 |
network-interface | 想要注册哪个网络接口的ip |
port | 向nacos注册服务时,服务对应的端口号。注:无需修改,默认为应用对外提供服务的端口号,server.port |
secure | 是否是 https 服务,默认:false |
access-key | access key |
secret-key | secret key |
heart-beat-interval | nacos客户端向服务端发送心跳的时间间隔,默认5s。注:客户端向服务端每隔5s向服务端发送心跳请求,进行服务续租,告诉服务端该实例IP健康。若在3次心跳的间隔时间(默认15s)内服务端没有接受到该实例的心跳请求,则认为该实例不健康,该实例将无法被消费。如果再次经历3次心跳的间隔时间,服务端接受到该实例的请求,那么会立刻将其设置外健康,并可以被消费,若未接受到,则删除该实例的注册信息。推荐配置为5s,如果有的业务线希望服务下线或者出故障时希望尽快被发现,可以适当减少该值。 |
heart-beat-timeout | 服务端没有接受到客户端心跳请求就将其设为不健康的时间间隔,默认为15s。注:推荐值该值为15s即可,如果有的业务线希望服务下线或者出故障时希望尽快被发现,可以适当减少该值。 |
ip-delete-timeout | ip删除超时。 时间单位:毫秒。 |
instance-enabled | 是否启用实例以接受请求。 默认值是true。 |
ephemeral | 实例是否是短暂的。默认值为true |
其他参数配置
参数 | 描述 |
---|---|
com.alibaba.nacos.naming.log.level | Naming客户端的日志级别,改属性通过客户端启动时通过命令行加参数指定。注:默认为info |
com.alibaba.nacos.naming.cache.dir | 客户端缓存目录,默认值:{user.home}/nacos/naming |
com.alibaba.nacos.client.naming.tls.enable | 是否打开HTTPS,默认值:false |
namingLoadCacheAtStart | 启动时是否优先读取本地缓存,默认值:false |
namingCacheRegistryDir | 指定缓存子目录,位置为 …/nacos/{SUB_DIR}/naming |
namingClientBeatThreadCount | 客户端心跳的线程池大小 |
namingPollingThreadCount | 客户端定时轮询数据更新的线程池大小 |
开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!
更多推荐
所有评论(0)