一文快速上手 Nacos 注冊中心+配置中心
Spring Cloud Alibaba 是阿里巴巴提供的一站式微服務(wù)開發(fā)解決方案,目前已被 Spring Cloud 官方收錄。而 Nacos 作為 Spring Cloud Alibaba 的核心組件之一,提供了兩個(gè)非常重要的功能:注冊中心和配置中心,我們今天來了解和實(shí)現(xiàn)一下二者。
1.Nacos 簡介
Nacos 致力于幫助開發(fā)者發(fā)現(xiàn)、配置和管理微服務(wù)。它提供了一組簡單易用的特性集,幫助開發(fā)者快速實(shí)現(xiàn)動態(tài)服務(wù)發(fā)現(xiàn)、服務(wù)配置、服務(wù)元數(shù)據(jù)及流量管理。
Nacos 特性介紹
Nacos 具有以下特性:
- 服務(wù)發(fā)現(xiàn)和服務(wù)健康監(jiān)測:支持基于DNS和基于RPC的服務(wù)發(fā)現(xiàn),支持對服務(wù)的實(shí)時(shí)的健康檢查,阻止向不健康的主機(jī)或服務(wù)實(shí)例發(fā)送請求。
- 動態(tài)配置服務(wù):動態(tài)配置服務(wù)可以讓您以中心化、外部化和動態(tài)化的方式管理所有環(huán)境的應(yīng)用配置和服務(wù)配置。
- 動態(tài) DNS 服務(wù):動態(tài) DNS 服務(wù)支持權(quán)重路由,讓您更容易地實(shí)現(xiàn)中間層負(fù)載均衡、更靈活的路由策略、流量控制以及數(shù)據(jù)中心內(nèi)網(wǎng)的簡單 DNS 解析服務(wù)。
- 服務(wù)及其元數(shù)據(jù)管理:支持從微服務(wù)平臺建設(shè)的視角管理數(shù)據(jù)中心的所有服務(wù)及元數(shù)據(jù)。
2.注冊中心實(shí)現(xiàn)
注冊中心有兩個(gè)重要的功能:服務(wù)注冊和服務(wù)發(fā)現(xiàn),它解決了微服務(wù)集群中,調(diào)用者和服務(wù)提供者連接管理和請求轉(zhuǎn)發(fā)的功能,讓程序的開發(fā)者無需過多的關(guān)注服務(wù)提供者的穩(wěn)定性和健康程度以及調(diào)用地址,因?yàn)檫@些都可以依靠 Nacos 進(jìn)行監(jiān)測、管理和自動轉(zhuǎn)發(fā)。
注冊中心中有兩個(gè)角色:一個(gè)是服務(wù)提供者 Provider,另一個(gè)是服務(wù)調(diào)用者 Consumer,接下來我們分別來創(chuàng)建二者。
2.1 創(chuàng)建服務(wù)提供者
2.1.1 新建項(xiàng)目并添加依賴
新建一個(gè) Spring Boot 項(xiàng)目,使用阿里云地址 http://start.aliyun.com 來創(chuàng)建 Spring Cloud Alibaba Nacos 項(xiàng)目,如下圖所示:
點(diǎn)擊 Next 下一步,如下圖所示:
增加 Nacos Service Discovery 框架支持,如下圖所示:
對應(yīng)的依賴框架如下:
<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>
PS:添加 Spring Web(Spring MVC)框架主要是為了方便后面測試。
2.1.2 配置 Nacos 連接信息
在配置文件 application.properties 中要填寫 Nacos 的相關(guān)連接信息,具體信息如下:
# 應(yīng)用名稱(也是 Nacos 中的服務(wù)名)
spring.application.name=spring-cloud-nacos-producer
# 應(yīng)用服務(wù) WEB 訪問端口
server.port=8082
# Nacos認(rèn)證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服務(wù)發(fā)現(xiàn)與注冊配置,其中子屬性 server-addr 指定 Nacos 服務(wù)器主機(jī)和端口
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
# 注冊到 nacos 的指定 namespace,默認(rèn)為 public
spring.cloud.nacos.discovery.namespace=public
2.1.3 添加服務(wù)提供方法
新建一個(gè)控制器 Controller,添加一個(gè) sayhi 方法,此方法可以使用 HTTP 協(xié)議進(jìn)行訪問,它是為后面的服務(wù)消費(fèi)者提供的調(diào)用方法,具體實(shí)現(xiàn)如下:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class SpringCloudNacosProducerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringCloudNacosProducerApplication.class, args);
}
@RequestMapping("/sayhi/{name}")
public String sayHi(@PathVariable String name) {
return "Hi Nacos Discovery " + name;
}
}
編寫完代碼之后,運(yùn)行項(xiàng)目就可以在 Nacos 的服務(wù)列表中看到它了,如下圖所示:
經(jīng)過以上步驟,我們的服務(wù)提供者就創(chuàng)建好了,接下來我們創(chuàng)建一個(gè)服務(wù)消費(fèi)者 Consumer。
2.2 創(chuàng)建服務(wù)消費(fèi)者
2.2.1 新建項(xiàng)目并添加依賴
此步驟和上面的服務(wù)提供者類似,也是添加 nacos discovery 和 web 依賴,具體實(shí)現(xiàn)如下:
2.2.2 配置 Nacos 連接信息
# 應(yīng)用名稱
spring.application.name=springcloud-nacos-consumer
# 應(yīng)用服務(wù) WEB 訪問端口
server.port=8082
# Nacos認(rèn)證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服務(wù)發(fā)現(xiàn)與注冊配置,其中子屬性 server-addr 指定 Nacos 服務(wù)器主機(jī)和端口
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
# 注冊到 nacos 的指定 namespace,默認(rèn)為 public
spring.cloud.nacos.discovery.namespace=public
2.2.3 添加服務(wù)調(diào)用代碼
服務(wù)消費(fèi)者的實(shí)現(xiàn)有兩個(gè)關(guān)鍵點(diǎn),第一,先 new 一個(gè) RestTemplate 對象,此對象是 Spring 框架提供用于進(jìn)行 HTTP 請求的類,實(shí)現(xiàn)代碼如下:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringBootApplication
@EnableDiscoveryClient
public class SpringcloudNacosConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringcloudNacosConsumerApplication.class, args);
}
@LoadBalanced
@Bean
public RestTemplate restTemplate() {
// 用于進(jìn)行 HTTP 請求的對象
return new RestTemplate();
}
}
第二,新建一個(gè)控制器,注入 RestTemplate 對象,并調(diào)用 Nacos 中的服務(wù)提供者接口,實(shí)現(xiàn)代碼如下:
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
@RestController
public class TestController {
@Autowired
private RestTemplate restTemplate;
@RequestMapping("/hi")
public String hi(String name) {
// 調(diào)用生產(chǎn)者 sayhi 方法,并返回結(jié)果
return restTemplate.getForObject("http://spring-cloud-nacos-producer/sayhi/" + name,
String.class);
}
}
其中spring-cloud-nacos-producer 是服務(wù)提供者的 ID,而 sayhi 是服務(wù)提供者提供的接口地址。
通過以上配置,我們的服務(wù)消費(fèi)者也創(chuàng)建好了,啟動項(xiàng)目,執(zhí)行結(jié)果如下圖所示:
從上述結(jié)果可以看出,服務(wù)消費(fèi)者通過 Nacos 已經(jīng)成功調(diào)用到服務(wù)提供者了,這就是 Nacos 中注冊中心的基本使用。
3.配置中心實(shí)現(xiàn)
配置中心的作用是將本地配置文件云端話,所謂的云端也就是 Nacos 的服務(wù)器端,這樣既能保證配置文件中的敏感數(shù)據(jù)不會暴露,同時(shí)又提供了實(shí)時(shí)的修改、查看、回滾和動態(tài)刷新配置文件的功能,非常實(shí)用。
但是需要注意的是配置中心和注冊中心的依賴包是不同的,注冊中心的依賴包是 nacos discovery,而配置中心的依賴包是 nacos config,它的具體如下。
3.1 新建項(xiàng)目并添加依賴
創(chuàng)建一個(gè) Spring Boot 項(xiàng)目,添加 nacos config 和 web 依賴包,如下圖所示:
PS:添加 web 依賴主要是為了方便后面測試。
對應(yīng)的配置依賴信息如下:
<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>
3.2 配置 Nacos Config 信息
在應(yīng)用的 /src/main/resources/ 目錄下,創(chuàng)建引導(dǎo)配置文件 bootstrap.yml(或 bootstrap.properties),添加以下 Nacos Config 配置:
spring:
application:
name: nacosconfig # 項(xiàng)目名稱和 nacos DataId 相匹配
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848 # nacos 地址和端口
file-extension: yaml # 獲取配置文件的格式:yaml
username: nacos # nacos 認(rèn)證用戶名
password: nacos # nacos 認(rèn)證密碼
server:
port: 9001 # 項(xiàng)目啟動端口
3.3 編寫代碼讀取配置文件
新建控制器,使用 @Value 注解讀取配置信息,實(shí)現(xiàn)代碼如下:
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestController {
// 從 nacos 中讀取配置項(xiàng) config.info
@Value("${config.info}")
private String configInfo;
@GetMapping("/getconfig")
public String getConfigInfo(){
return configInfo;
}
}
3.4 Nacos 控制臺添加配置信息
在 Nacos 控制臺創(chuàng)建并設(shè)置配置文件,執(zhí)行步驟如下所示。
首先,在配置列表中點(diǎn)擊“添加”按鈕,如下圖所示:
進(jìn)入配置頁面,新建 YAML 或 Properties 配置文件,如下圖所示:
以上關(guān)鍵參數(shù)的含義和規(guī)則說明如下。
3.4.1 Data ID
Data ID 的拼接格式如下:
${prefix} - ${spring.profiles.active} . ${file-extension}
其中prefix 默認(rèn)為 spring.application.name 的值,也可以通過配置項(xiàng) spring.cloud.nacos.config.prefix 來配置。
spring.profiles.active 即為當(dāng)前環(huán)境對應(yīng)的 profile,當(dāng) active profile 為空時(shí),對應(yīng)的連接符 - 也將不存在,dataId 的拼接格式變成 ${prefix}.${file-extension}
file-extension 為配置內(nèi)容的數(shù)據(jù)格式,可以通過配置項(xiàng) spring.cloud.nacos.config.file-extension 來配置。目前只支持 properties 類型。
3.4.2 Group
Group 分組選項(xiàng),主要是用來隔離不同的配置項(xiàng)目的,它的默認(rèn)值為 DEFAULT_GROUP,可以通過spring.cloud.nacos.config.group 配置。
配置好相應(yīng)的內(nèi)容之后,點(diǎn)擊底部的“發(fā)布”按鈕即可,添加成功之后會自動返回配置列表,如下圖所示:
經(jīng)過以上步驟,Nacos 配置中心的功能就實(shí)現(xiàn)完了,接下來啟動項(xiàng)目,程序的執(zhí)行結(jié)果如下圖所示:
3.5 動態(tài)刷新功能
動態(tài)刷新功能是指,在 Nacos 配置中心修改了配置文件,在不重啟項(xiàng)目的前提下,可以實(shí)時(shí)讀取到最新的配置內(nèi)置。
Nacos 默認(rèn)會為所有獲取數(shù)據(jù)成功的 Nacos 的配置項(xiàng)添加了監(jiān)聽功能,在監(jiān)聽到服務(wù)端配置發(fā)生變化時(shí)會實(shí)時(shí)觸發(fā)
org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法。
但如果需要對 Bean 進(jìn)行動態(tài)刷新,需要參照 Spring 和 Spring Cloud 規(guī)范,推薦給類添加 @RefreshScope 或 @ConfigurationProperties 注解,就可以實(shí)現(xiàn)配置中心的動態(tài)刷新功能了。
4.項(xiàng)目源碼
https://gitee.com/mydb/spring-cloud-alibaba-example
小結(jié)
Nacos 作為 Spring Cloud Alibaba 的核心組件之一,提供了兩個(gè)非常重要的功能:注冊中心和配置中心。注冊中心有兩個(gè)重要的功能:服務(wù)注冊和服務(wù)發(fā)現(xiàn),它解決了微服務(wù)集群中,調(diào)用者和服務(wù)提供者連接管理和請求轉(zhuǎn)發(fā)的功能,保證了服務(wù)調(diào)用者能夠穩(wěn)定的調(diào)用到健康的服務(wù)。而注冊中心的本質(zhì)是將項(xiàng)目中的本地配置文件云端化,解決了配置文件的安全性與統(tǒng)一性的問題,并且提供了配置文件歷史版本回滾和配置文件動態(tài)刷新的功能。
參考文檔
Nacos 官方文檔:https://nacos.io/zh-cn/docs/what-is-nacos.html