Spring Cloud Alibaba Nacos 服務(wù)注冊與發(fā)現(xiàn)功能實現(xiàn)!

作者 | 磊哥
來源 | Java中文社群(ID:javacn666)
轉(zhuǎn)載請聯(lián)系授權(quán)(微信ID:GG_Stone)
Nacos 是 Spring Cloud Alibaba 中一個重要的組成部分,它提供了兩個重要的功能:服務(wù)注冊與發(fā)現(xiàn)和統(tǒng)一的配置中心功能。
服務(wù)注冊與發(fā)現(xiàn)功能解決了微服務(wù)集群中,調(diào)用者和服務(wù)提供者連接管理和請求轉(zhuǎn)發(fā)的功能,讓程序的開發(fā)者無需過多的關(guān)注服務(wù)提供者的穩(wěn)定性和健康程度以及調(diào)用地址,因為這些都可以依靠 Nacos 進行監(jiān)測、管理和自動轉(zhuǎn)發(fā)。
試想一下,當一個系統(tǒng)被部署多個之后,如何確定要調(diào)用哪一個(服務(wù))實例?當某個被調(diào)用的實例出現(xiàn)問題時,又如何將請求轉(zhuǎn)發(fā)到其他實例上?這些問題都是微服務(wù)架構(gòu)中現(xiàn)實存在的問題,然而使用 Nacos 就可以輕松的解決這些問題。并且 Nacos 也提供了統(tǒng)一的配置中心,解決了之前項目配置文件存放在本地或 github 上的安全性問題,并且支持動態(tài)修改和統(tǒng)一維護配置文件的功能。
1.Nacos 簡介
Nacos 是 Dynamic Naming and Configuration Service 的首字母簡稱;它是?個更易于構(gòu)建云原生應(yīng)用的動態(tài)服務(wù)發(fā)現(xiàn)、配置管理和服務(wù)管理的平臺。
官網(wǎng):https://nacos.io/
倉庫源碼:https://github.com/alibaba/nacos
2.Nacos 生態(tài)
Nacos 幾乎支持所有主流語言,其中 Java/Golang/Python 已經(jīng)支持 Nacos 2.0 長鏈接協(xié)議,能最大限度發(fā)揮 Nacos 性能。阿里微服務(wù) DNS(Dubbo+Nacos+Spring-cloud-alibaba/Seata/Sentinel)最佳實踐,是 Java 微服務(wù)生態(tài)最佳解決方案。
3.Nacos 快速部署
Nacos 支持 3 種部署模式:
單機部署 集群部署 多集群部署
Nacos 安裝方式有以下 2 種:
使用源碼安裝。 使用已編譯好的安裝包進行安裝。
本文我們將使用第一種方式加 Docker,來快速部署 Nacos 服務(wù)器端。
因為 Docker 方式安裝和卸載都比較方便,所以本文就采用此方式來演示 Nacos 的安裝,其他安裝方式,詳見官網(wǎng):https://nacos.io/zh-cn/docs/quick-start.html
3.1 預(yù)備環(huán)境準備
Nacos 依賴 Java 環(huán)境來運行,如果您是從代碼開始構(gòu)建并運行 Nacos,還需要為此配置 Maven 環(huán)境,請確保是在以下版本環(huán)境中安裝使用:
64 bit OS,支持 Linux/Unix/Mac/Windows,推薦選用 Linux/Unix/Mac。 64 bit JDK 1.8+。 Maven 3.2.x+。
因為本文使用的是 Nacos + Docker 的方式進行部署的,所以沒有安裝 Docker 的同學,自行搜索安裝哦。
安裝 Open JDK 8
yum -y install java-1.8.0-openjdk-devel.x86_64
安裝完之后,使用 java -version 檢查是否安裝成功,如下圖所示:
若顯示具體的 Java 版本則表示安裝成功。
3.2 下載 Nacos
本文使用 git 的方式來下載 Nacos 源碼包,所以需要使用以下命令來先安裝 git:
yum -y install git
下載 Nacos 源碼:
git clone https://github.com/nacos-group/nacos-docker.git
下載完成如下圖所示:
進入 Nacos 目錄:
cd nacos-docker
3.3 啟動 Nacos 服務(wù)
Nacos 的運行是需要數(shù)據(jù)庫的,它支持兩種數(shù)據(jù)庫:本地數(shù)據(jù)庫 Derby、和 MySQL 數(shù)據(jù)庫。所以對應(yīng)的啟動命令有以下幾種:
Derby 數(shù)據(jù)庫運行單機模式:docker-compose -f example/standalone-derby.yaml up MySQL 5.7 數(shù)據(jù)庫運行單機模式:docker-compose -f example/standalone-mysql-5.7.yaml up MySQL 8 數(shù)據(jù)庫運行單機模式:docker-compose -f example/standalone-mysql-8.yaml up
集群模式啟動:docker-compose -f example/cluster-hostname.yaml up
啟動成功如下圖所示:
3.3 訪問Nacos
啟動成功之后,就可以使用 http://127.0.0.1:8848/nacos/#/login 來訪問 Nacos 的管理控制臺了,如下圖所示:
用戶名和密碼都輸入 nacos 就可以進入系統(tǒng)了,如下圖所示:
3.4 常見報錯問題
3.4.1 docker-compose 命令未找到
docker-compose 是用于定義和運行多容器 Docker 應(yīng)用程序的編排工具。使用 docker-compose 后不再需要逐一創(chuàng)建和啟動容器。您可以使用 YML 文件來配置應(yīng)用程序需要的所有服務(wù),然后使用一個命令,就可以從 YML 文件配置中創(chuàng)建并啟動所有服務(wù)。但是 docker-compose 需要單獨安裝,否則會出現(xiàn)以下錯誤:
解決方案:
cd?/usr/local/bin
wget?https://github.com/docker/compose/releases/download/1.14.0-rc2/docker-compose-Linux-x86_64
rename?docker-compose-Linux-x86_64?docker-compose?docker-compose-Linux-x86_64
chmod?+x?/usr/local/bin/docker-compose
docker-compose?version
安裝成功如下圖所示:
3.4.2 image:invalid reference format
使用 docker-compose 可能會提示“ERROR: no such image: nacos/nacos-server:: invalid reference format”,無效的參數(shù)格式,如下圖所示:
解決方案:修改 Nacos 源碼中 example/standalone-mysql-5.7.yaml 的配置項,將“image: nacos/nacos-server:{{NACOS_VERSION}}”,修改為:“image: nacos/nacos-server:latest”。
4.Spring Cloud Alibaba 服務(wù)注冊
服務(wù)注冊者也就是生產(chǎn)者,是微服務(wù)中的服務(wù)提供者。它是以 Spring Boot 項目為基礎(chǔ)創(chuàng)建的,具體操作步驟如下:
創(chuàng)建項目使用阿里云的地址 http://start.aliyun.com 來創(chuàng)建 Spring Cloud Alibaba Nacos 項目,點擊下一步 Next,如下圖所示:
增加 Nacos Service Discovery 框架支持,如下圖所示:
再添加 Spring Web(Spring MVC)框架的支持,最后點擊 Finish 完成項目創(chuàng)建。
4.1 項目依賴
Spring Cloud Alibaba Nacos 項目主要有兩個依賴項,如下內(nèi)容所示:
<dependency>
??<groupId>org.springframework.bootgroupId>
??<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
??<groupId>com.alibaba.cloudgroupId>
??<artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
4.2 修改配置文件
在配置文件 application.properties 中要填寫 Nacos 的相關(guān)信息,具體內(nèi)容如下:
#?應(yīng)用名稱(也是?Nacos?中的服務(wù)名)
spring.application.name=spring-cloud-nacos-producer
#?應(yīng)用服務(wù)?WEB?訪問端口
server.port=8082
#?Nacos認證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
#?Nacos?服務(wù)發(fā)現(xiàn)與注冊配置,其中子屬性?server-addr?指定?Nacos?服務(wù)器主機和端口
spring.cloud.nacos.discovery.server-addr=mse-6d50f4f0-p.nacos-ans.mse.aliyuncs.com:8848
#?注冊到?nacos?的指定?namespace,默認為?public
spring.cloud.nacos.discovery.namespace=public
4.3 添加代碼
接下來添加一個 Restful API 的接口,給后面的服務(wù)調(diào)用者使用,具體實現(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
@EnableDiscoveryClient
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;
????}
}
編寫完代碼之后,運行項目,觀察 Nacos 中的服務(wù)列表就可以看到此項目,如下圖所示:
經(jīng)過以上操作,我們創(chuàng)建的 Spring Cloud Alibaba 的項目就被注冊到 Nacos 中了,其他程序也可以通過 Nacos 對它進行調(diào)用了。
5.Spring Cloud Alibaba 服務(wù)發(fā)現(xiàn)
與上面創(chuàng)建方式類似,接下來我們再創(chuàng)建一個服務(wù)調(diào)用者,也叫做消費者來調(diào)用上面框架中的 sayhi 方法,具體操作步驟如下。
5.1 創(chuàng)建項目


5.2 修改配置文件
#?應(yīng)用名稱
spring.application.name=springcloud-nacos-consumer
#?應(yīng)用服務(wù)?WEB?訪問端口
server.port=8082
#?Nacos幫助文檔:?https://nacos.io/zh-cn/docs/concepts.html
#?Nacos認證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
#?Nacos?服務(wù)發(fā)現(xiàn)與注冊配置,其中子屬性?server-addr?指定?Nacos?服務(wù)器主機和端口
spring.cloud.nacos.discovery.server-addr=82.157.146.10:8848
#?注冊到?nacos?的指定?namespace,默認為?public
spring.cloud.nacos.discovery.namespace=public
5.3 添加代碼
消費者的實現(xiàn)代碼有兩個類,在啟動類中添加一個 RestTemplate 的 Bean 對象,用于提供 Restful API 的請求,啟動類的具體實現(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()?{
????????return?new?RestTemplate();
????}
}
消費者的具體實現(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);
????}
}
添加完代碼之后,運行程序,在 Nacos 的服務(wù)列表中可看到以下內(nèi)容:
之后訪問消費者的 hi 方法,讓其調(diào)用生產(chǎn)者的實現(xiàn)效果如下:
從上述結(jié)果可以看出,消費者通過 Nacos 已經(jīng)成功的調(diào)用到了生產(chǎn)者 spring-cloud-nacos-producer 中的 sayhi 方法了。
小結(jié)
Nacos 提供了兩個重要的功能:服務(wù)注冊與發(fā)現(xiàn)和統(tǒng)一配置中心的功能,它提供了 3 種部署方式:單機部署、集群部署和多集群部署,以及兩種安裝方式:源碼安裝和安裝包安裝。我們使用的是 Docker 加 Nacos 源碼的方式來安裝和部署 Nacos 的。Nacos 服務(wù)注冊和發(fā)現(xiàn)都需要添加 Nacos Service Discovery 框架的支持,且在配置文件中配置相應(yīng)的 Nacos 信息,才可以正確的實現(xiàn)服務(wù)的注冊和發(fā)現(xiàn)功能。
參考&鳴謝
《Nacos框架與原理》
是非審之于己,毀譽聽之于人,得失安之于數(shù)。
公眾號:Java中文社群
Java面試合集:gitee.com/mydb/interview
